JSON-Dateien

Wie man General Translation verwendet, um automatische Übersetzungen für die JSON-Dateien Ihres Projekts einzurichten

Ü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-Nachrichten) möglicherweise nicht genau. Vermissen Sie Ihre bevorzugte Bibliothek? Bitte teilen Sie uns das mit, und wir werden sie so schnell wie möglich hinzufügen!

Wir werden diese 4 Schritte befolgen:

Fügen Sie Ihre Umgebungsvariablen hinzu

Installieren Sie gtx-cli

Erstellen Sie eine gt.config.json Datei

Führen Sie gtx-cli translate aus

Tipp: Vermeiden Sie den Aufwand der Verwendung von Übersetzungsdateien mit 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 aus dem General Translation Dashboard.

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

Schritt 2: Installieren Sie gtx-cli

Installieren Sie das gtx-cli-Tool in Ihrem Projekt.

npm i --save-dev gtx-cli

Schritt 3: Erstelle eine gt.config.json Datei

Erstelle eine gt.config.json Datei im Hauptverzeichnis deines Projekts.

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

Du kannst die gt.config.json Datei nach Bedarf anpassen. Weitere Informationen findest du in der Konfigurationsdokumentation.

Aktualisiere das json Dateiformat so, dass der include Pfad deiner 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 hinzu, bevor der Build-Befehl ausgeführt wird, um automatisch Übersetzungen 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 Ihre Sprachen und speichert sie in Ihrem Projekt. Wenn Sie diese Dateien in Ihr Repository übernehmen möchten, können Sie diesen Befehl stattdessen vor dem Commit ausführen.

Sie sind fertig! Jetzt wird Ihr Projekt automatisch alle Ihre Übersetzungs-JSON-Dateien aktualisieren, wenn sich Ihr Projekt ändert.


Hinweise

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

Nächste Schritte

  • Lesen Sie die Nutzungsanleitung für das CLI-Tool.
  • Wenn Sie Live-Übersetzungen in der Entwicklung sehen möchten (wie Hot Reload), schauen Sie sich die <T> Komponente an.

Auf dieser Seite