gt.config.json
Die Datei gt.config.json
Übersicht
Die Datei gt.config.json speichert die Konfiguration Ihres Projekts.
Sie enthält wichtige Informationen wie die projectId Ihres Projekts, die unterstützten locales und mehr.
Sie enthält außerdem interne Schlüsselinformationen wie die versionId Ihres Projekts.
Diese Datei wird (1) von Ihrer <GTProvider>-Komponente und (2) vom gtx-cli translate-Befehl gelesen.
Daher empfehlen wir, Ihre Konfiguration in der Datei gt.config.json zu hinterlegen, statt sie als Prop an die <GTProvider>-Komponente zu übergeben.
Im Allgemeinen ist alles, was mit einem Unterstrich beginnt (z. B. _versionId), eine interne Eigenschaft und sollte nicht geändert werden.
Alles andere kann frei verwendet werden.
Felder
| Feld | Typ | Beschreibung |
|---|---|---|
projectId | string | Eindeutiger Bezeichner für Ihr Projekt im GT-System |
locales | string[] | Array der unterstützten locale code für Ihr Projekt |
defaultLocale | string | Primärer locale code, der als Standardwert verwendet wird, wenn Übersetzungen fehlen |
cacheUrl | string | URL-Endpunkt zum Zwischenspeichern von Übersetzungsdaten |
runtimeUrl | string | URL-Endpunkt für Übersetzungsdienste zur Laufzeit |
stageTranslations | boolean | Konfiguration für Staging-/Preview-Übersetzungsfunktionen |
files | object | Pfad zu lokalen Übersetzungs-files 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 Laufzeitumgebung und gilt nur für Übersetzungen während der Entwicklung.
stageTranslations
stageTranslations ist ein Flag, das vom Tool gtx-cli verwendet wird, um deine Übersetzungen als zur Überprüfung erforderlich zu kennzeichnen.
Das bedeutet, dass sie manuell freigegeben werden müssen, bevor sie mit dem Befehl gtx-cli translate für die Produktion bereitgestellt werden können.
files
Das Feld files gibt einen Pfad zu lokal gespeicherten Übersetzungen an (im Gegensatz zur Speicherung in der Cloud).
Das Feld output legt fest, wohin die Übersetzungen geschrieben werden.
{
"files": {
"gt": {
"output": "public/_gt/[locale].json"
}
},
}Siehe die Konfigurationsdokumentation des CLI-Tools für weitere Informationen zur Verwendung des Felds files.
Beispiele
Ihre Locales festlegen
{
"defaultLocale": "en", // Primäre Locale ist Englisch
"locales": ["fr", "es"] // Sekundäre Locales sind Französisch und Spanisch
}Hinweise
- Die Datei
gt.config.jsonlegt die Konfiguration Ihres Projekts fest. - Sie wird sowohl von der Komponente
<GTProvider>als auch vom Befehlgtx-cli translateeingelesen.
Nächste Schritte
Wie ist diese Anleitung?