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 bien plus encore. Il contient é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 (par exemple _versionId) est une propriété interne et ne doit pas être modifié. Tout le reste peut être modifié.


Champs

ChampTypeDescription
projectIdstringIdentifiant unique de votre projet dans le système GT
localesstring[]Tableau des codes de locale pris en charge pour votre projet
defaultLocalestringCode de locale principal utilisé comme 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 staging/de prévisualisation des traductions
filesobjectChemin vers les files de traduction locales pour le développement et les tests
_versionIdstringPropriété interne utilisée pour le suivi de 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’environnement d’exécution et ne s’applique qu’aux traductions en développement.

stageTranslations

Le paramètre stageTranslations est un indicateur utilisé par l’outil gtx-cli pour signaler que vos traductions nécessitent 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 un chemin vers des traductions stockées localement (par opposition à un stockage dans le cloud). Plus précisément, le champ output indique l’emplacement où les traductions seront écrites.

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

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


Exemples

Définir vos locales

gt.config.json
{
  "defaultLocale": "en", // La locale par défaut est l'anglais
  "locales": ["fr", "es"] // Les locales 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

Comment trouvez-vous ce guide ?