JSON

Wie man JSON-Dateien automatisch mit General Translation übersetzt

Übersicht

gtx-cli kann verwendet werden, um die JSON-Dateien deines Projekts automatisch zu übersetzen, unabhängig davon, welche i18n-Bibliothek du verwendest.

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

Wenn du eine andere i18n-Bibliothek verwendest, sind die Übersetzungsergebnisse für Strings mit benutzerdefinierter Syntax und Formatierung (zum Beispiel ICU-Nachrichten) möglicherweise nicht korrekt. Deine Lieblingsbibliothek ist nicht dabei? Lass es uns wissen, und wir werden sie so schnell wie möglich hinzufügen!

Wir folgen diesen 4 Schritten:

Füge deine Umgebungsvariablen hinzu

Installiere gtx-cli

Erstelle eine gt.config.json-Datei

Tipp: Vermeide den Aufwand mit Übersetzungsdateien durch die Nutzung der <T> Komponente.


Schritt 1: Fügen Sie Ihre Umgebungsvariablen hinzu

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

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

Schritt 2: Installiere gtx-cli

Installiere das Tool gtx-cli in deinem Projekt.

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

Schritt 3: Erstellen Sie eine gt.config.json-Datei

Erstellen Sie eine gt.config.json-Datei im Root-Verzeichnis Ihres Projekts.

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

Passen Sie die gt.config.json-Datei gerne an Ihre Bedürfnisse an. Weitere Informationen finden Sie in der Konfigurationsdokumentation.

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

Übersetzungen bewahren die ursprüngliche String-Syntax.

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

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

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

Dadurch werden Übersetzungen für alle Ihre Sprachversionen generiert und in Ihrem Projekt gespeichert. Wenn Sie diese Dateien in Ihr Repository committen möchten, können Sie stattdessen diesen Befehl vor dem Commit ausführen.

Fertig! Ihr Projekt wird nun automatisch alle Ihre Übersetzungs-JSON-Dateien aktualisieren, sobald sich Ihr Projekt ändert.


Hinweise

  • Sie können Übersetzungen automatisch zu Ihrem Projekt hinzufügen mit dem gtx-cli translate Befehl.
  • Wenn Sie Ihre Übersetzungsdateien committen möchten, sollten Sie den gtx-cli translate Befehl vor dem Commit ausführen.
  • Um den Ausgabepfad für Ihre Übersetzungen zu konfigurieren, siehe die Konfigurations- Dokumentation.

Nächste Schritte

Wie ist dieser Leitfaden?