L'outil CLI
L'outil CLI de traductions générales
Aperçu
Ceci est un document de référence sur l'outil CLI de traduction générale.
Lisez plus sur gtx-cli ici.
Pour un guide étape par étape, consultez le guide Déploiement en production.
Installation
Que fait l'outil CLI ?
L'outil CLI est utilisé pour gérer votre projet et vos traductions.
Il y a deux commandes principales dont vous devriez être conscient : translate et setup.
- La commande
translateest destinée à être ajoutée au pipeline CD. Elle est utilisée pour scanner votre projet à la recherche de contenu à traduire. Le contenu est ensuite téléchargé sur un CDN ou ajouté à votre bundle d'application pour être utilisé à l'exécution. - La commande
setupest utilisée pour intégrer automatiquement la bibliothèque de traduction générale dans votre projet. Elle scannera votre projet et enveloppera tout contenu JSX avec un composant<T>.
Traduction
Pour utiliser l'outil CLI, exécutez la commande suivante depuis la racine de votre projet :
Pour une utilisation en production uniquement !
Étant donné que cet outil CLI publie le contenu traduit sur le CDN, il est destiné à être utilisé uniquement pour les builds de production et ne doit pas être utilisé en développement. Avant d'exécuter cette commande, veuillez vous assurer que vous êtes sur la branche qui sera utilisée pour la production. N'oubliez pas de spécifier également votre clé API de production et l'ID de projet dans vos variables d'environnement.
Drapeaux
| Prop | Type | Default |
|---|---|---|
--api-key? | string | - |
--project-id? | string | - |
--options? | string | gt.config.json |
--new? | string | - |
--dictionary? | string | - |
--dry-run? | boolean | false |
--ignore-errors? | boolean | false |
--inline? | boolean | true |
Lors de la première exécution de l'outil CLI, il tentera de créer un fichier gt.config.json à la racine de votre projet.
Ce fichier contient des métadonnées sur votre projet qui sont utilisées pour traduire votre contenu.
Configuration
De plus, l'outil CLI peut automatiquement scanner et configurer votre projet pour la traduction. Si vous utilisez General Translation pour la première fois, nous vous recommandons d'exécuter la configuration pour commencer.
Sauvegardez vos modifications !
Cela va modifier votre code, alors assurez-vous de soit mettre en réserve (stash) soit valider (commit) vos modifications d'abord.
L'exécution de cette commande enveloppera les composants <T> autour du niveau supérieur des éléments JSX qui contiennent du contenu traduisible.
Elle enveloppera également tout contenu non statique avec des composants <Var>.
Voici quelques exemples de ce que le scan va convertir :
Sera converti en :
Le CLI n'enveloppera que les enfants directs à l'intérieur des éléments JSX. Il enveloppera d'autres éléments JSX séparément avec leurs propres composants <T>.
Expérimental
Cette fonctionnalité est actuellement expérimentale et peut ne pas fonctionner parfaitement.
Après avoir exécuté le scan, vous devriez manuellement vérifier le résultat et vous assurer qu'il est correct.
En particulier, notez que toutes les expressions JSX non statiques {...} seront enveloppées dans des composants <Var>.
Vous pourriez avoir besoin de revoir et modifier manuellement ces cas.
Veuillez signaler tout problème que vous rencontrez ici.
Drapeaux
| Prop | Type | Default |
|---|---|---|
--src? | string | - |