JSON

Aperçu

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

Remarque : Nous prenons actuellement en charge la syntaxe personnalisée des chaînes et le formatage 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 précis pour les chaînes avec une syntaxe personnalisée et un formatage particulier (par exemple, les 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

Exécutez gtx-cli translate

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

Étape 1 : Ajoutez vos variables d'environnement

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

.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

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.

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 configuration pour plus d'informations.

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

Les traductions préserveront la syntaxe originale des chaînes.

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

Ajoutez la commande gtx-cli translate à votre processus de build ou d'intégration continue (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 && <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 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 de votre 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 devez 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.

JSON

Aperçu

Étape 1 : Ajoutez vos variables d'environnement

Étape 2 : Installer gtx-cli

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

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

Notes

Prochaines étapes

Sur cette page

Étape 2 : Installer `gtx-cli`

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

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