Config

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

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 Fallback verwendet wird, wenn Übersetzungen fehlen
cacheUrlstringURL-Endpunkt für das Caching von Übersetzungsdaten
runtimeUrlstringURL-Endpunkt für Laufzeit-Übersetzungsdienste
stageTranslationsbooleanKonfiguration für Staging-/Vorschau-Übersetzungsfunktionen
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 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 Feld files gibt einen Pfad zu lokal gespeicherten Übersetzungen an (im Gegensatz zur Speicherung in der Cloud). Insbesondere gibt das Feld output an, wohin die Übersetzungen geschrieben werden.

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

Weitere Informationen zur Verwendung des Feldes files finden Sie in der CLI-Tool-Konfigurationsdokumentation.


Beispiele

Festlegen Ihrer Sprachversionen

gt.config.json
{
  "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 Komponente withGTConfig() als auch vom Befehl gtx-cli translate gelesen.

Nächste Schritte

Wie ist dieser Leitfaden?