Guide d'utilisation
Guide d'utilisation de l'outil en ligne de commande GT
Aperçu
Ce guide vous accompagnera dans le processus d'utilisation de l'outil CLI 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 est responsable de la connexion de votre projet au service de traduction IA de General Translation.
Il existe plusieurs façons d'utiliser l'outil CLI, veuillez naviguer vers la section pertinente pour votre cas d'utilisation.
Installation
Pour installer l'outil CLI, exécutez la commande suivante :
Cas d'utilisation
Traduction de projets GT
L'outil CLI peut être utilisé pour traduire vos projets qui utilisent gt-next ou gt-react.
Ce guide suppose que vous avez déjà configuré votre base de code pour utiliser gt-next ou gt-react selon les tutoriels gt-next ou gt-react.
- Tout d'abord, vous devrez configurer les paramètres GT de votre projet.
Cette commande générera automatiquement une clé API et un ID de projet pour votre projet via le tableau de bord.
Cependant, si vous souhaitez définir manuellement la clé API et l'ID de projet, suivez les étapes 2 et 3 ci-dessous.
- Ensuite, vous devrez créer un projet dans le tableau de bord General Translation.
Après avoir créé un projet, vous devrez générer une clé API de production. Rendez-vous sur la page "API Keys" et cliquez sur le bouton "Create API Key".
- Ajoutez ensuite votre clé API et l'ID de projet à vos variables d'environnement.
- Enfin, exécutez la commande de traduction.
Par défaut, l'outil CLI publiera les traductions sur le CDN de General Translation, afin qu'elles soient prêtes à être utilisées dans votre projet.
Si vous souhaitez désactiver ce comportement (par exemple, si vous chargez les traductions depuis une autre source), ajoutez l'option --no-publish à la commande.
Consultez la référence API pour plus d'informations sur la commande translate.
Traduction de 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 utilisent 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.
- Tout d'abord, vous devrez configurer les paramètres GT de votre projet.
Cette commande créera un fichier gt.config.json à la racine de votre projet, contenant quelques paramètres de configuration de base, comme la langue par défaut de votre projet et les langues prises en charge.
Cette commande générera automatiquement une clé API et un ID de projet pour votre projet via le tableau de bord.
Cependant, si vous souhaitez définir manuellement la clé API et l'ID de projet, suivez les étapes 2 et 3 ci-dessous.
- Ensuite, vous devrez créer un projet dans le tableau de bord General Translation.
Après avoir créé un projet, vous devrez générer une clé API de production. Rendez-vous sur la page "API Keys" et cliquez sur le bouton "Create API Key".
- Ajoutez ensuite votre clé API et l'ID de projet à vos variables d'environnement.
- Enfin, exécutez la commande de traduction.
Par défaut, l'outil CLI recherchera les fichiers à traduire selon la propriété files dans votre fichier gt.config.json.
Il utilisera la defaultLocale spécifiée dans votre fichier gt.config.json comme langue source.
Les fichiers traduits seront enregistrés à l'emplacement de sortie correspondant spécifié dans votre fichier gt.config.json.
Consultez la documentation de configuration pour plus d'informations sur la propriété files.
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'utilisation est utile si vous souhaitez utiliser votre propre fournisseur 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'y a pas de structure de fichier JSON traditionnelle contenant des clés et des valeurs pour chaque langue.
Cela signifie que, pour suivre les modifications du texte, les bibliothèques GT stockent les empreintes (hashes) du texte original dans le code source.
Cette structure de données interne (contenant les empreintes) est difficile à manipuler, c'est pourquoi l'outil CLI fournit une commande pratique pour générer des fichiers de langue pour votre projet.
- Tout d'abord, vous devrez configurer les paramètres GT de votre projet.
Lorsque l'on vous demande si vous souhaitez enregistrer les traductions sur le CDN de GT, sélectionnez l'option « Non ».
- Exécutez :
Cette commande générera un fichier source pour votre langue par défaut, ainsi que pour toutes les autres langues que vous avez configurées pour votre projet.
Le contenu de chaque fichier est identique, et sera fusionné avec toutes les traductions précédentes présentes dans votre projet.
Consultez la référence API pour plus d'informations sur la commande generate.
Notes
gtx-cli translateest utilisé pour générer automatiquement des traductions pour votre projet.- Si vous utilisez une bibliothèque i18n tierce, vous pouvez mettre à jour automatiquement tous vos fichiers JSON de traduction chaque fois que votre projet change. Ajoutez simplement la commande
gtx-cli translateà votre processus de build ou CD avant la commande de build pour ajouter automatiquement des traductions à votre projet.
Prochaines étapes
- Consultez la référence API CLI pour plus d'informations.
- Si vous souhaitez voir des traductions en direct pendant le développement (pensez au rechargement à chaud), consultez le composant
<T>.