Utilisation

npx gtx-cli init

Utilisez cette commande pour lancer l’assistant de configuration de GT.

Cette commande revient à exécuter setup, puis configure.

L’assistant va :

1. Installer les dépendances requises pour votre projet.
2. (Si Next.js) Ajouter la fonction withGTConfig à votre fichier next.config.js et configurer le composant GTProvider.
3. Créer un fichier gt.config.json à la racine de votre projet.
4. Générer une clé d’API et un id de projet pour votre projet.

Dépendances

La commande init installera les dépendances suivantes pour votre projet :

• gt-react ou gt-next (si votre projet utilise React)
• gtx-cli en tant que dépendance de développement (si ce n’est pas déjà installé)

Projets basés sur React

Si votre projet est basé sur React, l’assistant vous aidera à configurer votre projet pour utiliser gt-react ou gt-next.

Si vous utilisez déjà une autre bibliothèque d’i18n, vous devrez peut-être configurer votre projet manuellement.

Consultez la documentation React ou la documentation Next.js pour en savoir plus.

Étant donné que l’assistant est actuellement expérimental, il se peut qu’il ne fonctionne pas pour tous les projets basés sur React. Dans ces cas, vous devrez peut-être configurer votre projet manuellement.

Si vous rencontrez des problèmes, veuillez nous en informer sur GitHub.

Cette partie de l’assistant peut également être exécutée indépendamment via npx gtx-cli setup.

gt.config.json

La commande init vous aide à configurer les paramètres GT de votre projet.

Elle crée un fichier gt.config.json à la racine de votre projet.

Le fichier contient les paramètres suivants :

• defaultLocale : la locale par défaut de votre projet.
• locales : un tableau de locales prises en charge pour votre projet.
• files : un objet qui contient des informations sur le contenu que vous souhaitez traduire.

Pour des informations plus détaillées sur le fichier gt.config.json, consultez la documentation de configuration.

Cette étape de l’assistant peut aussi être exécutée séparément via npx gtx-cli configure.

Identifiants

L’assistant vous aidera à générer une clé d’API et un ID de projet pour votre projet (s’ils ne sont pas déjà configurés).

Veuillez noter que la clé d’API et l’ID de projet ne sont pas nécessaires pour utiliser gt-react ou gt-next.

L’assistant ajoutera la clé d’API et l’ID de projet à votre fichier .env.local. Si ce fichier n’existe pas, l’assistant le créera et l’ajoutera à votre fichier .gitignore.

Cette étape de l’assistant peut également être exécutée séparément via npx gtx-cli auth.