Config

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 Informationen wie die versionId Ihres Projekts.

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

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


Felder

FeldTypBeschreibung
projectIdstringEindeutiger Bezeichner für Ihr Projekt im GT‑System
localesstring[]Array der unterstützten Locale‑Codes für Ihr Projekt
defaultLocalestringDer primäre Locale‑Code, der als Standardwert verwendet wird, wenn Übersetzungen fehlen
cacheUrlstringURL‑Endpunkt zum Cachen von Übersetzungsdaten
runtimeUrlstringURL‑Endpunkt für Übersetzungsdienste zur Laufzeit
stageTranslationsbooleanKonfiguration für Staging-/Vorschaufunktionen der Übersetzung
filesobjectPfad zu lokalen Übersetzungsdateien 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 im Entwicklungsmodus.

stageTranslations

stageTranslations ist ein Flag, das vom gtx-cli-Tool verwendet wird, um deine Übersetzungen als überprüfungsbedürftig zu markieren. Das bedeutet, dass sie manuell freigegeben werden müssen, bevor sie über den Befehl gtx-cli translate in Produktion bereitgestellt werden können.

files

Das Feld files gibt einen Pfad zu lokal gespeicherten Übersetzungen an (im Gegensatz zur Speicherung in der Cloud). Konkret legt das Feld output fest, wohin die Übersetzungen geschrieben werden.

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

Siehe die Konfigurationsdokumentation des CLI-Tools, um mehr darüber zu erfahren, wie das Feld files verwendet wird.


Beispiele

Ihre locales angeben

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 legt die Konfiguration Ihres Projekts fest.
  • Sie wird sowohl von der Komponente withGTConfig als auch vom Befehl gtx-cli translate gelesen.

Nächste Schritte

Wie ist dieser Leitfaden?

gt.config.json