gt.config.json
Die gt.config.json Datei
Übersicht
Die Datei gt.config.json
ist dafür verantwortlich, die Konfiguration deines Projekts zu speichern.
Sie enthält wichtige Informationen wie die projectId
deines Projekts, deine unterstützten Sprachversionen und mehr.
Außerdem enthält sie wichtige interne Informationen wie die versionId
deines Projekts.
Diese Datei wird von (1) deiner withGTConfig()
-Komponente und (2) dem gtx-cli translate
-Befehl gelesen.
Deshalb empfehlen wir, deine Konfiguration in deiner gt.config.json
-Datei zu speichern, anstatt sie als Prop an deine withGTConfig()
-Komponente zu übergeben.
Im Allgemeinen gilt: Alles, was mit einem Unterstrich beginnt (z. B. _versionId
), ist eine interne Eigenschaft und sollte nicht verändert werden.
Alles andere kann beliebig angepasst werden.
Felder
Feld | Typ | Beschreibung |
---|---|---|
projectId | string | Eindeutiger Bezeichner für Ihr Projekt im GT-System |
locales | string[] | Array der unterstützten Locale-Codes für Ihr Projekt |
defaultLocale | string | Der primäre Locale-Code, der als Fallback verwendet wird, wenn Übersetzungen fehlen |
cacheUrl | string | URL-Endpunkt für das Caching von Übersetzungsdaten |
runtimeUrl | string | URL-Endpunkt für Laufzeit-Übersetzungsdienste |
stageTranslations | boolean | Konfiguration für Staging-/Vorschau-Übersetzungsfunktionen |
files | object | Pfad zu lokalen Übersetzungsdateien für Entwicklung und Tests |
_versionId | string | Interne Eigenschaft zur Nachverfolgung der Projektversion (nicht ändern) |
cacheUrl
und runtimeUrl
Wenn Sie Ihre Übersetzungen in der Cloud speichern, ist die cacheUrl
die Basis-URL für den Cache.
Die runtimeUrl
ist die Basis-URL für die Laufzeit und gilt nur für Entwicklungsübersetzungen.
stageTranslations
Das stageTranslations
-Flag wird vom gtx-cli
-Tool verwendet, um Ihre Übersetzungen als überprüfungsbedürftig zu markieren.
Das bedeutet, dass sie manuell genehmigt werden müssen, bevor sie mit dem gtx-cli translate
-Befehl in die Produktion übernommen werden können.
files
Das files
-Feld gibt einen Pfad zu lokal gespeicherten Übersetzungen an (im Gegensatz zur Speicherung in der Cloud).
Insbesondere gibt das output
-Feld an, wohin die Übersetzungen geschrieben werden.
{
"files": {
"gt": {
"output": "public/_gt/[locale].json"
}
},
}
Weitere Informationen zur Verwendung des files
-Feldes finden Sie in der CLI-Tool-Konfigurationsdokumentation.
Beispiele
Festlegen Ihrer Sprachversionen
{
"defaultLocale": "en", // Primäre Sprache ist Englisch
"locales": ["fr", "es"] // Sekundäre Sprachen sind Französisch und Spanisch
}
Hinweise
- Die Datei
gt.config.json
wird verwendet, um die Konfiguration Ihres Projekts festzulegen. - Sie wird sowohl von der
withGTConfig()
Komponente als auch vomgtx-cli translate
Befehl gelesen.
Nächste Schritte
- Erfahren Sie, wie Sie Ihre Übersetzungen zum Bundle Ihres Projekts hinzufügen.
Wie ist dieser Leitfaden?