Aperçu

Ce tutoriel vous montrera comment gérer automatiquement les fichiers de traduction de votre projet si vous utilisez i18next.

Nous suivrons ces 4 étapes :

Étape 1 : Ajoutez vos variables d’environnement

Ajoutez votre clé d’API de production et l’ID de projet à vos variables d’environnement. C’est nécessaire pour utiliser l’outil gtx-cli. Vous pouvez les récupérer depuis le tableau de bord General Translation.

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 gtx-cli

yarn add --dev gtx-cli

bun add --dev gtx-cli

pnpm add --save-dev gtx-cli

Étape 3 : Créez un fichier gt.config.json

Créez un fichier gt.config.json à la racine de votre projet.

{
  "defaultLocale": "en",
  "locales": ["zh", "es", "ja"],
  "files": {
    "json": {
      "include": ["messages/[locale]/*.json"]
    },
  },
}

N'hésitez pas à personnaliser le fichier gt.config.json selon vos besoins. Consultez la documentation de configuration pour en savoir plus.

Mettez à jour le format de fichier json afin que le chemin include corresponde à la structure de votre projet.

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

Ajoutez la commande gtx-cli translate à votre pipeline de build ou de CI, avant la commande de build, afin d’ajouter automatiquement les traductions à votre projet.

{
  "scripts": {
    "translate": "npx gtx-cli translate",
    "build": "npm run translate && <votre commande de compilation>"
  }
}

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

C’est terminé ! Désormais, votre projet mettra automatiquement à jour tous vos files JSON de traduction à chaque modification du projet.

Notes

• Vous pouvez ajouter automatiquement des traductions à votre projet avec la commande gtx-cli translate.
• Si vous souhaitez valider vos fichiers de traduction, vous pouvez plutôt 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 de l’outil CLI.