Config

gt.config.json

Le fichier gt.config.json

Vue d’ensemble

Le fichier gt.config.json est responsable du stockage de la configuration de votre projet. Il contient des informations importantes comme le projectId de votre projet, les locales que vous prenez en charge, et plus encore. Il inclut également des informations internes essentielles, telles que le versionId de votre projet.

Ce fichier est lu par (1) votre composant withGTConfig et (2) la commande gtx-cli translate. C’est pourquoi nous recommandons de stocker votre configuration dans votre fichier gt.config.json plutôt que de la passer comme prop à votre composant withGTConfig.

De manière générale, tout ce qui commence par un underscore (p. ex. _versionId) est une propriété interne et ne doit pas être modifiée. Tout le reste est librement modifiable.


Champs

ChampTypeDescription
projectIdstringIdentifiant unique de votre projet dans le système GT
localesstring[]Liste des codes de locale pris en charge pour votre projet
defaultLocalestringCode de locale principal utilisé en secours lorsque des traductions sont manquantes
cacheUrlstringURL de point de terminaison pour la mise en cache des données de traduction
runtimeUrlstringURL de point de terminaison pour les services de traduction à l’exécution
stageTranslationsbooleanConfiguration des fonctionnalités de traduction en préproduction/aperçu
filesobjectChemin vers les fichiers de traduction locaux pour le développement et les tests
_versionIdstringPropriété interne utilisée pour suivre la version du projet (ne pas modifier)

cacheUrl et runtimeUrl

Si vous stockez vos traductions dans le cloud, cacheUrl est l’URL de base du cache. runtimeUrl est l’URL de base de l’exécution et ne s’applique qu’aux traductions en environnement de développement.

stageTranslations

Le stageTranslations est un indicateur utilisé par l’outil gtx-cli pour marquer vos traductions comme nécessitant une relecture. Cela signifie qu’elles doivent être approuvées manuellement avant de pouvoir être déployées en production via la commande gtx-cli translate.

files

Le champ files indique le chemin des traductions stockées localement (plutôt que dans le cloud). Plus précisément, le champ output précise l’emplacement où les traductions seront enregistrées.

{
  "files": {
    "gt": {
      "output": "public/_gt/[locale].json"
    }
  },
}

Voir la documentation de configuration de l’outil CLI configuration docs pour en savoir plus sur l’utilisation du champ files.


Exemples

Définir vos locales

gt.config.json
{
  "defaultLocale": "en", // La langue principale est l’anglais
  "locales": ["fr", "es"] // Les langues secondaires sont le français et l’espagnol
}

Notes

  • Le fichier gt.config.json sert à définir la configuration de votre projet.
  • Il est lu à la fois par le composant withGTConfig et par la commande gtx-cli translate.

Prochaines étapes

Que pensez-vous de ce guide ?

gt.config.json