JSON

So übersetzen Sie JSON files automatisch mit General Translation

Überblick

gtx-cli kann verwendet werden, um die JSON-Dateien Ihres Projekts automatisch zu übersetzen – unabhängig davon, welche i18n‑Bibliothek Sie verwenden.

Hinweis: Wir unterstützen derzeit benutzerdefinierte String‑Syntax und Formatierung für die folgenden i18n‑Bibliotheken: next-intl, i18next, gt-next, gt-react.

Wenn Sie eine andere i18n‑Bibliothek verwenden, sind die Übersetzungsergebnisse für Strings mit benutzerdefinierter Syntax und Formatierung (zum Beispiel ICU‑Messages) möglicherweise nicht korrekt. Ihre Lieblingsbibliothek ist nicht dabei? Lassen Sie es uns wissen, und wir fügen sie so bald wie möglich hinzu!

Wir folgen diesen 4 Schritten:

Fügen Sie Ihre Umgebungsvariablen hinzu

Installieren Sie gtx-cli

Erstellen Sie die Datei gt.config.json

Führen Sie gtx-cli translate aus

Tipp: Sparen Sie sich den Aufwand mit Übersetzungsdateien – verwenden Sie die <T>-Komponente.


Schritt 1: Umgebungsvariablen hinzufügen

Fügen Sie Ihren Produktions-API-Schlüssel und Ihre Projekt-ID zu Ihren Umgebungsvariablen hinzu. Dies ist erforderlich, um das Tool gtx-cli zu verwenden. Sie erhalten beides im General Translation Dashboard.

.env
GT_API_KEY=<your-api-key>
GT_PROJECT_ID=<your-project-id>

Schritt 2: gtx-cli installieren

Installieren Sie das Tool gtx-cli in Ihrem Projekt.

npm i gtx-cli
yarn add --dev gtx-cli
bun add --dev gtx-cli
pnpm add --save-dev gtx-cli

Schritt 3: Erstellen Sie die Datei gt.config.json

Erstellen Sie die Datei gt.config.json im Stammverzeichnis Ihres Projekts.

gt.config.json
{
  "defaultLocale": "en",
  "locales": ["zh", "es", "ja"],
  "files": {
    "json": {
      "include": ["i18n/[locale]/*.json"]
    },
  },
}

Passen Sie die Datei gt.config.json nach Ihren Anforderungen an. Weitere Informationen finden Sie in der Dokumentation zur Konfiguration.

Aktualisieren Sie das json-Dateiformat, damit der include-Pfad Ihrer Projektstruktur entspricht.

Übersetzungen behalten die ursprüngliche String-Syntax bei.

Schritt 4: Fügen Sie den Befehl gtx-cli translate zu Ihrem Build-Prozess hinzu

Fügen Sie den Befehl gtx-cli translate vor dem Build-Befehl in Ihren Build- oder CI-Prozess ein, um Übersetzungen automatisch zu Ihrem Projekt hinzuzufügen.

package.json
{
  "scripts": {
    "translate": "npx gtx-cli translate",
    "build": "npm run translate && <your build command>"
  }
}

Dies generiert Übersetzungen für alle deine locales und speichert sie in deinem Projekt. Wenn du diese files in dein Repo committen möchtest, kannst du stattdessen vor dem Commit diesen Befehl ausführen.

Fertig! Dein Projekt aktualisiert nun automatisch alle deine Übersetzungs-JSON files, sobald sich dein Projekt ändert.


Hinweise

  • Sie können Ihrem Projekt automatisch Übersetzungen mit dem Befehl gtx-cli translate hinzufügen.
  • Wenn Sie Ihre Übersetzungsdateien committen möchten, sollten Sie den Befehl gtx-cli translate vor dem Commit ausführen.
  • Informationen zur Konfiguration des Ausgabepfads für Ihre Übersetzungen finden Sie in der Dokumentation zur Konfiguration.

Nächste Schritte

Wie ist diese Anleitung?