Créer un fichier de configuration CLI (Strings)

Le contenu est traduit de l’anglais par Phrase Language AI.

Prérequis

Jeton d'accès API avec une portée lecture écriture
Identifiant de projet Strings affiché dans l'onglet API des paramètres du projet
Connaissances de base en YAML, y compris l'indentation
Autorisations de lecture et d'écriture Git si le référentiel doit exécuter phrase push ou phrase pull dans CI

Astuce

Pour des informations plus détaillées, consultez le Developer Hub.

Pour créer automatiquement un fichier de configuration, procédez comme suit :

Ouvrez l'invite de commande et tapez phrase init pour créer un fichier .phrase.yml.

L'assistant de configuration se lance dans l'interface CLI.
Renseignez les informations suivantes :
- Jeton d’accès
  
  Collez ou appuyez sur Entrée pour permettre l'utilisation de $PHRASE_ACCESS_TOKEN
- Identifiant de projet Strings (par ex. abcdef1234567890abcdef1234567890)
- Format de fichier de paramètre linguistique (par ex. json, rails_yaml, ios_strings)
- Chemin local
  
  Glob ou chemin exact vers les fichiers de paramètre linguistique dans la base de code du projet (par ex. config/locales/*.json)

Un fichier .phrase.yml de base est créé dans le répertoire actuel.

Astuce

Fournissez des indicateurs pour ignorer complètement l'assistant, par exemple phrase init --access_token=$PHRASE_ACCESS_TOKEN --project_id=... --file_format=ios_strings --path='ios/*.strings'.

Si vous utilisez un fichier de configuration créé manuellement ou copié, placez-le dans l'un des emplacements suivants :

Le répertoire de travail actuel (pwd) dans lequel le client CLI est appelé.
le répertoire personnel de l'utilisateur actuel ($HOME sous Unix, $HomePath sous Windows).
le chemin spécifié dans la variable d'environnement PHRASEAPP_CONFIG.
le chemin vers le fichier de configuration via le drapeau --config (par exemple /some/path/to/phrase.yml).

Aperçu des options CLI

Exemple de fichier de configuration.

Paramètres globaux

Clé	Type	Obligatoire	Description
`phrase.access_token`	chaîne	oui	Jeton d'accès personnel.
`phrase.project_id`	chaîne	oui	Identifiant de projet public affiché dans les paramètres du projet Strings.
`phrase.file_format`	chaîne	oui	format de fichier par défaut du paramètre linguistique (extension API).
`phrase.locale_mapping`	objet	non	Associe les Identifiants de paramètre linguistique Phrase à des noms Personnalisé pour une utilisation dans les chemins de fichiers avec l'espace réservé `<locale_name>`. Ceci est utile pour les plateformes avec des conventions de nommage non standard, comme Android. Si un paramètre linguistique n'est pas spécifié dans le mappage, son nom de paramètre linguistique Phrase standard est utilisé par défaut.

Push : Sources

Clé	Type	Obligatoire	Description
`push.sources[].file`	chemin	oui	Chemin relatif vers le(s) fichier(s) à envoyer, par ex. `./path/to/file/<locale_code>.json`. Supports `<locale_name>`, `<locale_code>`, `<tags>`.
`push.sources[].project_id`	chaîne		Remplacer le `Identifiant` global du projet pour cette source de fichier spécifique. Utile lors de l'envoi de fichiers vers plusieurs projets Phrase à partir du même fichier de configuration.

Push : Paramètres

Paramètre	Type	Par défaut	Description
`file_format`	chaîne	en-tête	Remplacer le format de fichier pour cette source.
`locale_id`	chaîne	—	Nom du paramètre linguistique (par ex. `en-US`) ou Identifiant public du paramètre linguistique.
`tags`	chaîne	—	Tags séparés par des virgules pour les nouvelles clés.
`update_translations`	booléen	`false`	Mettre à jour les traductions existantes avec le contenu du fichier.
`update_translation_keys`	booléen	`vrai`	Utiliser `false` ici pour empêcher la création de nouvelles clés et la mise à jour des clés existantes.
`update_descriptions`	booléen	`false`	Mettre à jour les descriptions de clé ; les descriptions vide écrasent celles existantes.
`skip_upload_tags`	booléen	`false`	Les tags de charger ne sont pas créés.
`skip_unverification`	booléen	`false`	Les traductions mises à jour ne sont pas non vérifié.
`file_encoding`	chaîne	—	Encodage de fichier : `UTF-8`, `UTF-16`, `UTF-16BE`, `UTF-16LE` ou `ISO-8859-1`.
`locale_mapping`	objet	—	(Excel/CSV uniquement) Mapper les codes de paramètre linguistique aux noms de colonne, par ex. `{\"en\": \"C\", \"de\": \"D\"}` pour l'analyse des traductions. Ceci est distinct du `locale_mapping` de haut niveau utilisé pour les chemins de fichier.
`autotranslate`	booléen	`false`	Récupérer automatiquement les traductions pour la langue chargée.
`mark_reviewed`	booléen	`false`	Marquer les traductions importées comme révisé (flux de travaux de révision avancé doit être activé).

Push : Options de format

Toutes les options de format disponibles sont prises en charge dans la configuration CLI. Voir Exemple de fichier de configuration pour des exemples.

Pull : Cibles

Clé	Type	Obligatoire	Description
`pull.targets[].file`	chemin	oui	Chemin relatif pour les fichiers de paramètre linguistique extraits, par ex. `./Radio.de/<locale_code>.lproj/Localizable.Strings`.
`pull.targets[].project_id`	chaîne		Remplacer le `Identifiant` global pour cette cible de pull spécifique. Activer l'extraction de traductions depuis plusieurs projets Phrase en utilisant le même fichier de configuration.

Pull : Paramètres

Paramètre	Type	Par défaut	Description
`file_format`	chaîne	—	Doit être `Strings`.
`locale_id`	chaîne	—	Nom du paramètre linguistique (par ex. `en-US`) ou Identifiant public du paramètre linguistique.
`tags`	chaîne	—	Étiquettes séparées par des virgules pour filtre les clés à extraire.
`include_empty_translations`	booléen	`false`	Inclure les clés sans aucune traduction.
`exclude_empty_zero_forms`	booléen	`false`	Exclure les pluriels de forme zéro lorsqu'ils sont vide.
`include_translated_keys`	booléen	`vrai`	Inclure les clés qui ont déjà des traductions.
`keep_notranslate_tags`	booléen	`false`	Préserver les balises `[NOTRANSLATE]` dans la sortie.
`encodage`	chaîne	—	Encodage de fichier : `UTF-8`, `UTF-16`, `UTF-16BE`, `UTF-16LE` ou `ISO-8859-1`.
`include_unverified_translations`	booléen	`vrai`	Si `false`, exclure les traductions non vérifié.
`use_last_reviewed_version`	booléen	`false`	Si `true`, utiliser la dernière version révisé (nécessite un flux de travaux de révision avancé).
`fallback_locale_id`	chaîne	—	Paramètre linguistique de secours à utiliser pour les traductions manquantes.

Extraction : Options de format

Toutes les options de format disponibles sont prises en charge dans la configuration CLI. Voir Exemple de fichier de configuration pour des exemples.

Configurations multiples

Dans les monorepos, placez un fichier de configuration dans chaque paquet et exécutez l'interface de ligne de commande depuis le sous-dossier correspondant, ou pointez les tâches CI vers différents fichiers de configuration avec l'option --config.

Intégration Git

GitLab :

Le fichier de configuration .phrase.yml doit être présent dans le référentiel. Le fichier définit les fichiers à importer (pull) ou exporter (push) depuis le référentiel.
Les droits de lecture et d'écriture sur le référentiel sont requis.
Des fichiers de configuration mal définis peuvent entraîner des erreurs. Assurez-vous que le fichier contient au moins une cible push et une cible pull, des formats de fichiers corrects et le bon réglage du paramètre update_translations.
Utilisez GitLab 9.5 ou plus récent pour garantir la compatibilité API.

GitHub :

Le fichier de configuration .phrase.yml doit être présent dans le référentiel. Le fichier définit les fichiers à importer (pull) ou exporter (push) depuis le référentiel.
Les droits de lecture et d'écriture sur le référentiel sont requis.
Des fichiers de configuration mal définis peuvent entraîner des erreurs. Assurez-vous que le fichier contient au moins une cible push et une cible pull, des formats de fichiers corrects et le bon réglage du paramètre update_translations.
Un jeton d’accès GitHub pour la portée du référentiel (public_repo en cas de synchronisation avec un référentiel public).
Si SSO est activé dans GitHub, il doit également l’être pour le jeton d'accès.
La branche phrase_translations ne peut pas être protégée.
Assurez-vous que les paramètres du référentiel ne nécessitent pas de validations signées.

BitBucket :

Le fichier de configuration .phrase.yml doit être présent dans le référentiel. Le fichier définit les fichiers à importer (pull) ou exporter (push) depuis le référentiel.
Les droits de lecture et d'écriture sur le référentiel sont requis.
Des fichiers de configuration mal définis peuvent entraîner des erreurs. Assurez-vous que le fichier contient au moins une cible push et une cible pull, des formats de fichiers corrects et le bon réglage du paramètre update_translations.