Assistant de configuration
Exécuter l'assistant de configuration GT
Utilisation
npx gtx-cli init
Utilisez cette commande pour exécuter l'assistant de configuration GT.
Cette commande équivaut à exécuter setup
, puis configure
.
L'assistant va :
- Installer les dépendances nécessaires pour votre projet.
- Vous aider à envelopper votre contenu JSX avec des balises
<T>
(dans un projet basé sur React). - Créer un fichier
gt.config.json
à la racine de votre projet. - Générer une clé API et un ID de projet pour votre projet.
Dépendances
La commande init
installera les dépendances suivantes pour votre projet :
gt-react
ougt-next
(si votre projet est basé sur React)gtx-cli
comme dépendance de développement (si elle n'est pas déjà installée)
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 manuellement votre projet.
Consultez la documentation React ou la documentation Next.js pour plus d'informations.
Étant donné que l'assistant est actuellement expérimental, il est possible qu'il ne fonctionne pas pour tous les projets basés sur React. Dans ces cas, vous devrez peut-être configurer manuellement votre projet.
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éera un fichier gt.config.json
à la racine de votre projet.
Le fichier contiendra les paramètres suivants :
defaultLocale
: La locale par défaut pour votre projet.locales
: Un tableau des locales supportées pour votre projet.files
: Il s'agit d'un objet qui contient des informations sur le contenu que vous souhaitez traduire.
Pour des informations plus spécifiques sur le fichier gt.config.json
, veuillez consulter la documentation de configuration.
Cette partie de l'assistant peut également être exécutée indépendamment via npx gtx-cli configure
.
Identifiants
L'assistant vous aidera à générer une clé API et un ID de projet pour votre projet (s'ils ne sont pas déjà configurés).
Veuillez noter que la clé API et l'ID de projet ne sont pas nécessaires pour utiliser gt-react
ou gt-next
.
L'assistant ajoutera la clé 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 partie de l'assistant peut également être exécutée indépendamment via npx gtx-cli auth
.
Comment trouvez-vous ce guide ?