Config

gt.config.json

File gt.config.json

Panoramica

Il file gt.config.json memorizza la configurazione del tuo progetto. Contiene informazioni importanti come il projectId del progetto, le lingue/locale supportati e altro. Include anche informazioni interne rilevanti, come il versionId del progetto.

Questo file viene letto (1) dal componente <GTProvider> e (2) dal comando gtx-cli translate. Per questo motivo consigliamo di conservare la configurazione nel file gt.config.json invece di passarla come prop al componente <GTProvider>.

In generale, qualsiasi elemento che inizi con un underscore (ad es. _versionId) è una proprietà interna e non dovrebbe essere modificata. Tutto il resto può essere modificato liberamente.

Campi

CampoTipoDescrizione
projectIdstringIdentificatore univoco del progetto nel sistema GT
localesstring[]Elenco dei codici locale supportati per il progetto
defaultLocalestringCodice locale principale usato come fallback quando mancano traduzioni
cacheUrlstringEndpoint URL per la memorizzazione in cache dei dati di traduzione
runtimeUrlstringEndpoint URL per i servizi di traduzione in runtime
stageTranslationsbooleanConfigurazione per le funzionalità di traduzione di staging/anteprima
filesobjectPercorso dei file di traduzione locali per sviluppo e test
_versionIdstringProprietà interna usata per tenere traccia della versione del progetto (non modificare)

cacheUrl e runtimeUrl

Se archivii le traduzioni nel cloud, cacheUrl è l’URL di base della cache. runtimeUrl è l’URL di base del runtime e si applica solo alle traduzioni in fase di sviluppo.

stageTranslations

stageTranslations è un flag utilizzato dallo strumento gtx-cli per contrassegnare le traduzioni come da sottoporre a revisione. Questo significa che devono essere approvate manualmente prima di poter essere distribuite in produzione tramite il comando gtx-cli translate.

files

Il campo files indica il percorso delle traduzioni archiviate localmente (anziché nel cloud). Nello specifico, il campo output indica dove verranno scritte le traduzioni.

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

Consulta la documentazione di configurazione dello strumento CLI per ulteriori informazioni su come usare il campo files.


Esempi

Specificare le tue lingue locali

gt.config.json
{
  "defaultLocale": "en", // La locale principale è l'inglese
  "locales": ["fr", "es"] // Le locale secondarie sono francese e spagnolo
}

Note

  • Il file gt.config.json definisce la configurazione del progetto.
  • Viene letto sia dal componente <GTProvider> sia dal comando gtx-cli translate.

Passaggi successivi

Come valuti questa guida?

gt.config.json