Fichiers JSON

Comment utiliser General Translation pour configurer la traduction automatique des fichiers JSON de votre projet

Aperçu

gtx-cli peut être utilisé pour traduire automatiquement les fichiers JSON de votre projet, quelle que soit la bibliothèque i18n que vous utilisez.

Remarque : Nous prenons actuellement en charge la syntaxe et le formatage de chaînes personnalisées pour les bibliothèques i18n suivantes : next-intl, i18next, gt-next, gt-react.

Si vous utilisez une bibliothèque i18n différente, les résultats de traduction peuvent ne pas être précis pour les chaînes avec une syntaxe et un formatage personnalisés (par exemple, les messages ICU). Vous ne voyez pas votre bibliothèque préférée ? Veuillez nous le faire savoir, et nous l'ajouterons dès que possible !

Nous suivrons ces 4 étapes :

Ajouter vos variables d'environnement

Installer gtx-cli

Initialiser votre projet avec la commande gtx-cli init

Astuce : Évitez les tracas liés à l'utilisation des fichiers de traduction avec le composant <T>.


Étape 1 : Ajouter vos variables d'environnement

Ajoutez votre clé API de production et l'ID de projet à vos variables d'environnement. Ceci est nécessaire pour utiliser l'outil gtx-cli. Vous obtenez ces informations depuis le tableau de bord General Translation.

.env
GT_API_KEY=<your-api-key>
GT_PROJECT_ID=<your-project-id>

Étape 2 : Installer gtx-cli

Installez l'outil gtx-cli dans votre projet.

npm i --save-dev gtx-cli

Étape 3 : Initialiser votre projet avec la commande gtx-cli init

Exécutez la commande gtx-cli init pour configurer votre projet.

npx gtx-cli init

Étape 4 : Ajouter la commande gtx-cli translate à votre processus de build

Ajoutez la commande gtx-cli translate à votre processus de build ou CI avant la commande de build pour ajouter automatiquement des traductions à votre projet.

package.json
{
  "scripts": {
    "translate": "npx gtx-cli translate",
    "build": "npm run translate && <your build command>"
  }
}

Cela générera des traductions pour toutes vos locales et les enregistrera dans votre projet. Si vous souhaitez valider ces fichiers dans votre dépôt, vous pouvez plutôt exécuter cette commande avant de valider.

C'est terminé ! Maintenant, votre projet mettra automatiquement à jour tous vos fichiers JSON de traduction chaque fois que votre projet change.


Remarques

  • Vous pouvez ajouter automatiquement des traductions à votre projet avec la commande gtx-cli translate.
  • Si vous souhaitez valider vos fichiers de traduction, vous devriez exécuter la commande gtx-cli translate avant de valider.
  • Pour configurer le chemin de sortie de vos traductions, consultez la documentation de configuration.

Prochaines étapes

  • Consultez le guide d'utilisation pour l'outil CLI.
  • Si vous souhaitez voir des traductions en direct pendant le développement (pensez au rechargement à chaud), consultez le composant <T>.

Sur cette page