Créer un fichier de configuration CLI (Strings)

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

Conditions préalables

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

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

À partir de la ligne de commande, 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 à $PHRASE_ACCESS_TOKEN d'être utilisé
- Identifiant du projet Strings (par exemple abcdef1234567890abcdef1234567890)
- Format de fichier de paramètre linguistique (par exemple json, rails_yaml, ios_strings)
- Chemin local
  
  Chemin glob ou exact vers les fichiers de paramètres linguistiques dans le code du projet (par exemple config/locales/*.json)

Un fichier de base .phrase.yml 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.
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	Requis	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 de locale par défaut file format (extension API).
`phrase.locale_mapping`	objet	Non	Mappe les identifiants de locale Phrase à des noms personnalisés à utiliser 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 une locale n'est pas spécifiée dans le mappage, son nom de locale standard Phrase est utilisé par défaut.

Pousser : Sources

Clé	Type	Requis	Description
`push.sources[].file`	chemin	Oui	Chemin relatif vers le(s) fichier(s) à pousser, par exemple `./path/to/file/<locale_code>.json`. Supports `<locale_name>`, `<locale_code>`, `<tags>`.
`push.sources[].project_id`	chaîne		Remplace le `project_id` global 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.

Pousser : Paramètres

Paramètre	Type	Par défaut	Description
`file_format`	chaîne	en-tête	Remplace le format de fichier pour cette source.
`locale_id`	chaîne	—	Nom de la locale (par exemple `en-US`) ou ID de locale public.
`tags`	chaîne	—	Balises séparées 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	`true`	Passez `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`	Mettez à jour les descriptions des clés ; les descriptions vides remplacent les existantes.
`skip_upload_tags`	booléen	`false`	Les balises de téléchargement ne sont pas créées.
`skip_unverification`	booléen	`false`	Les traductions mises à jour ne sont pas non vérifiées.
`file_encoding`	chaîne	—	Encodage du fichier : `UTF-8`, `UTF-16`, `UTF-16BE`, `UTF-16LE`, ou `ISO-8859-1`.
`locale_mapping`	objet	—	(Excel/CSV uniquement) Mapper les codes de locale aux noms de colonnes, par exemple `{"en": "C", "de": "D"}` pour analyser les traductions. Ceci est distinct de la `locale_mapping` de niveau supérieur utilisée pour les chemins de fichiers.
`autotranslate`	booléen	`false`	Récupérer automatiquement les traductions pour la langue téléchargée.
`mark_reviewed`	booléen	`false`	Marquer les traductions importées comme révisées (advanced review workflow doit être activé).

Push: Format Options

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

Pull: Targets

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

Extraction : Paramètres

Paramètre	Type	Par défaut	Description
`file_format`	chaîne	—	Doit être `Strings`.
`locale_id`	chaîne	—	Nom de la locale (par exemple `en-US`) ou ID de locale public.
`tags`	chaîne	—	Tags séparés par des virgules pour filtrer 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 à forme zéro lorsqu'ils sont vides.
`include_translated_keys`	booléen	`true`	Inclure les clés qui ont déjà des traductions.
`keep_notranslate_tags`	booléen	`false`	Préserver les tags `[NOTRANSLATE]` dans la sortie.
`encodage`	chaîne	—	Encodage du fichier : `UTF-8`, `UTF-16`, `UTF-16BE`, `UTF-16LE`, ou `ISO-8859-1`.
`include_unverified_translations`	booléen	`true`	Si `false`, exclure les traductions non vérifiées.
`use_last_reviewed_version`	booléen	`false`	Si `true`, utiliser la dernière version révisée (nécessite un flux de travail 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 Sample configuration file pour des exemples.

Configurations multiples

Dans les monorepos, placez un fichier de configuration dans chaque package et exécutez le CLI depuis le sous-dossier correspondant, ou pointez les travaux 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.

phrase_configuration_overview.yml
(8 ko)