gt.config.json

Die gt.config.json Datei

Überblick

Die Datei gt.config.json ist für die Speicherung der Konfiguration Ihres Projekts zuständig. Sie enthält wichtige Informationen wie die projectId Ihres Projekts, Ihre unterstützten Sprachen und mehr. Sie enthält auch wichtige interne Informationen wie die versionId Ihres Projekts.

Diese Datei wird von (1) Ihrer <GTProvider>-Komponente und (2) dem Befehl gtx-cli translate gelesen. Aus diesem Grund empfehlen wir, Ihre Konfiguration in Ihrer gt.config.json-Datei zu speichern, anstatt sie als Prop an Ihre <GTProvider>-Komponente zu übergeben.

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


Felder

| Feld | Typ | Beschreibung | |-------|-------------| | projectId | string | Eindeutige Kennung für Ihr Projekt im GT-System | | locales | string[] | Array von unterstützten Gebietsschema-Codes für Ihr Projekt | | defaultLocale | string | Der primäre Gebietsschema-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 Verfolgung 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

Die stageTranslations ist ein Flag, das vom gtx-cli-Tool verwendet wird, um Ihre Übersetzungen als überprüfungsbedürftig zu markieren. Das bedeutet, dass sie manuell genehmigt werden müssen, bevor sie über den Befehl gtx-cli translate 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"
    }
  },
}

Beispiele

Festlegen Ihrer Sprachen

gt.config.json
{
  "defaultLocale": "en", // Primary locale is English
  "locales": ["fr", "es"] // Secondary locales are French and Spanish
}

Hinweise

  • Die Datei gt.config.json wird verwendet, um die Konfiguration Ihres Projekts festzulegen.
  • Sie wird sowohl von der Komponente <GTProvider> als auch vom Befehl gtx-cli translate gelesen.

Nächste Schritte

Auf dieser Seite