Config

gt.config.json

Die Datei gt.config.json

Übersicht

Die Datei gt.config.json ist für das Speichern der Projektkonfiguration zuständig. Sie enthält wichtige Informationen wie die projectId Ihres Projekts, die unterstützten locales und mehr. Sie enthält außerdem interne Informationen wie die versionId Ihres Projekts.

Diese Datei wird von (1) Ihrer withGTConfig-Komponente und (2) dem Befehl gtx-cli translate eingelesen. Daher empfehlen wir, die Konfiguration in der Datei gt.config.json zu hinterlegen, statt sie als Prop an die withGTConfig-Komponente zu übergeben.

Grundsätzlich ist alles, was mit einem Unterstrich beginnt (z. B. _versionId), eine interne Eigenschaft und sollte nicht geändert werden. Alles andere kann frei angepasst werden.


Felder

FeldTypBeschreibung
projectIdstringEindeutiger Bezeichner für Ihr Projekt im GT‑System
localesstring[]Array der unterstützten locale code für Ihr Projekt
defaultLocalestringDer primäre locale code, der als Standardwert verwendet wird, wenn Übersetzungen fehlen
cacheUrlstringURL‑Endpunkt zum Caching von Übersetzungsdaten
runtimeUrlstringURL‑Endpunkt für Übersetzungsdienste zur Laufzeit
stageTranslationsbooleanKonfiguration für Staging-/Vorschaufunktionen für Übersetzungen
filesobjectPfad zu lokalen Übersetzungsfiles für Entwicklung und Tests
_versionIdstringInterne Eigenschaft zur Nachverfolgung der Projektversion (nicht ändern)

cacheUrl und runtimeUrl

Wenn Sie Ihre Übersetzungen in der Cloud speichern, ist die cacheUrl die Basis-URL des Caches. Die runtimeUrl ist die Basis-URL der Runtime und gilt nur für Übersetzungen während der Entwicklung.

stageTranslations

stageTranslations ist ein Flag, das vom Tool gtx-cli verwendet wird, um Ihre Übersetzungen als zur Überprüfung erforderlich zu markieren. Das bedeutet, dass sie manuell freigegeben werden müssen, bevor sie über den Befehl gtx-cli translate in die Produktion ausgerollt 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"
    }
  },
}

Weitere Informationen zur Verwendung des Felds files finden Sie in den Konfigurationsdokumenten des CLI-Tools.


Beispiele

Ihre Locales festlegen

gt.config.json
{
  "defaultLocale": "en", // Primäre Locale ist Englisch
  "locales": ["fr", "es"] // Sekundäre Locales sind Französisch und Spanisch
}

Hinweise

  • Die Datei gt.config.json definiert die Konfiguration Ihres Projekts.
  • Sie wird sowohl von der Komponente withGTConfig als auch vom Befehl gtx-cli translate eingelesen.

Nächste Schritte

Wie ist diese Anleitung?