gt.config.json

Aperçu

Le fichier gt.config.json est chargé de stocker la configuration de votre projet. Il contient des informations importantes comme le projectId de votre projet, vos locales prises en charge, et plus encore. Il contient également des informations internes importantes telles que le versionId de votre projet.

Ce fichier est lu par (1) votre composant <GTProvider> et (2) la commande gtx-cli translate. Pour cette raison, nous recommandons de stocker votre configuration dans votre fichier gt.config.json au lieu de la passer comme prop à votre composant <GTProvider>.

Généralement, tout ce qui commence par un trait de soulignement (par exemple _versionId) est une propriété interne et ne doit pas être modifié. Tout le reste peut être modifié.

Champs

| Champ | Type | Description | |-------|-------------| | projectId | string | Identifiant unique pour votre projet dans le système GT | | locales | string[] | Tableau des codes de langue pris en charge pour votre projet | | defaultLocale | string | Le code de langue principal utilisé comme solution de repli lorsque des traductions sont manquantes | | cacheUrl | string | URL de point de terminaison pour la mise en cache des données de traduction | | runtimeUrl | string | URL de point de terminaison pour les services de traduction en temps réel | | stageTranslations | boolean | Configuration pour les fonctionnalités de traduction en prévisualisation/préproduction | | files | object | Chemin vers les fichiers de traduction locaux pour le développement et les tests | | _versionId | string | Propriété interne utilisée pour suivre la version du projet (ne pas modifier) |

cacheUrl et runtimeUrl

Si vous stockez vos traductions dans le cloud, le cacheUrl est l'URL de base pour le cache. Le runtimeUrl est l'URL de base pour l'environnement d'exécution et s'applique uniquement aux traductions en développement.

stageTranslations

Le stageTranslations est un indicateur utilisé par l'outil gtx-cli pour marquer vos traductions comme nécessitant une révision. 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 spécifie un chemin vers les traductions stockées localement (par opposition au stockage dans le cloud). Plus précisément, le champ output spécifie où les traductions seront écrites.

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

Exemples

Spécification de vos locales

{
  "defaultLocale": "en", // Primary locale is English
  "locales": ["fr", "es"] // Secondary locales are French and Spanish
}

Notes

• Le fichier gt.config.json est utilisé pour spécifier la configuration de votre projet.
• Il est lu à la fois par le composant <GTProvider> et par la commande gtx-cli translate.

Prochaines étapes

• Apprenez comment faire ajouter vos traductions au bundle de votre projet.