JSON

Traduire automatiquement des fichiers JSON avec General Translation

Vue d’ensemble

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 les syntaxes et formatages de chaînes personnalisées pour les bibliothèques i18n suivantes : next-intl, i18next, gt-next, gt-react.

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

Nous allons suivre ces 4 étapes :

Ajoutez vos variables d’environnement

Installez gtx-cli

Créez un fichier gt.config.json

Astuce : Évitez la gestion fastidieuse des fichiers de traduction grâce au composant <T>.


Étape 1 : Ajoutez vos variables d’environnement

Ajoutez votre clé d’API de production et l’identifiant 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.

.env
GT_API_KEY=<votre-clé-api>
GT_PROJECT_ID=<votre-id-projet>

É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éer un fichier gt.config.json

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

gt.config.json
{
  "defaultLocale": "en",
  "locales": ["zh", "es", "ja"],
  "files": {
    "json": {
      "include": ["i18n/[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.

Les traductions conserveront la syntaxe de la chaîne d’origine.

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

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

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

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 exécuter cette commande avant de valider.

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


Remarques

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

Prochaines étapes

Que pensez-vous de ce guide ?

JSON