Vue d’ensemble

Ce guide vous explique comment utiliser l’outil en ligne de commande de General Translation (gtx-cli) pour traduire votre projet.

L’outil CLI est compatible avec n’importe quelle bibliothèque i18n, que vous utilisiez gt-next, gt-react ou des bibliothèques tierces comme next-intl ou react-i18next.

L’outil CLI relie votre projet au service de traduction IA de General Translation.

Il existe plusieurs façons d’utiliser l’outil CLI. Veuillez consulter la section correspondant à votre cas d’usage.

Installation

Pour installer l’outil CLI, exécutez la commande suivante :

npm i gtx-cli

yarn add --dev gtx-cli

bun add --dev gtx-cli

pnpm add --save-dev gtx-cli

Cas d’usage

Traduction des projets GT

L’outil CLI peut être utilisé pour traduire vos projets qui utilisent gt-next ou gt-react.

Ce guide part du principe que vous avez déjà configuré votre base de code pour utiliser gt-next ou gt-react, conformément aux tutoriels gt-next ou gt-react.

1. Commencez par configurer les paramètres GT de votre projet.

npx gtx-cli configure

2. Ensuite, créez un projet dans le tableau de bord General Translation.

Après avoir créé un projet, générez une clé d’API de production. Rendez-vous sur la page « API Keys » et cliquez sur le bouton « Create API Key ».

3. Ensuite, ajoutez votre clé d’API et votre ID de projet à vos variables d’environnement.

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

4. Enfin, exécutez la commande de traduction.

npx gtx-cli translate

Consultez la référence de l’API pour plus d’informations sur la commande translate.

Traduction des fichiers de langue (bibliothèques i18n tierces ou projets GT autonomes)

L’outil CLI vous permet de traduire des fichiers de langue pour des bibliothèques i18n tierces ou avec une implémentation autonome de gt-next ou gt-react.

La plupart des bibliothèques i18n s’appuient sur des fichiers JSON pour stocker les données de traduction. L’outil CLI peut être utilisé pour traduire automatiquement ces fichiers JSON dans les langues de votre choix.

1. Commencez par configurer les paramètres GT de votre projet.

npx gtx-cli configure

Cette commande crée un fichier gt.config.json à la racine de votre projet, contenant quelques paramètres de configuration de base, comme la locale par défaut de votre projet et les locales prises en charge.

2. Ensuite, vous devez créer un projet dans le tableau de bord General Translation.

Après avoir créé un projet, vous devrez générer une clé d’API de production. Accédez à la page « API Keys » et cliquez sur le bouton « Create API Key ».

3. Ajoutez ensuite votre clé d’API et l’ID de projet à vos variables d’environnement.

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

4. Enfin, exécutez la commande de traduction.

npx gtx-cli translate

Génération de fichiers de langue pour les projets GT

L’outil CLI peut être utilisé pour générer des fichiers de langue pour les projets qui utilisent gt-next ou gt-react.

Ce cas d’usage est utile si vous souhaitez utiliser votre propre prestataire de traduction.

Contrairement à d’autres bibliothèques i18n, gt-next et gt-react prennent en charge les traductions en ligne, ce qui signifie qu’il n’existe pas de structure de fichier JSON traditionnelle contenant des clés et des valeurs pour chaque langue.

Ainsi, pour suivre les modifications du texte, les bibliothèques GT stockent les hachages du texte original dans le code source.

Cette structure de données interne (qui contient des hachages) est difficile à manipuler ; c’est pourquoi l’outil CLI fournit une commande pratique pour générer des fichiers de langue pour votre projet.

1. D’abord, vous devrez configurer les paramètres GT de votre projet.

npx gtx-cli configure

Lorsque l’on vous demande si vous souhaitez enregistrer les traductions sur le CDN de GT (réseau de diffusion de contenu), sélectionnez l’option « No ».

2. Exécutez :

npx gtx-cli generate

Cette commande génère un fichier source pour votre locale par défaut, ainsi que pour toutes les autres locales que vous avez configurées pour votre projet.

Le contenu de chaque fichier est identique et sera fusionné avec les traductions précédentes présentes dans votre projet.

Consultez la Référence de l’API pour plus d’informations sur la commande generate.

Notes

• gtx-cli translate est utilisé pour générer automatiquement les traductions de votre projet.
• Si vous utilisez une bibliothèque i18n tierce, vous pouvez automatiquement mettre à jour tous vos files JSON de traduction à chaque modification de votre projet. Il suffit d’ajouter la commande gtx-cli translate à votre build ou à votre processus de CD (Continuous Delivery/Déploiement continu) avant la commande de build pour ajouter automatiquement des traductions à votre projet.

Prochaines étapes

• Consultez la référence de l’API du CLI pour en savoir plus.