Übersetzen
Wie man sein Projekt übersetzt
Verwendung
Führen Sie dies in Ihrer CI-Pipeline bevor Sie Ihre Next.js-App für die Produktion bauen aus.
Hinweis: Dieser Befehl benötigt einen Produktions-API-Schlüssel! Erhalten Sie einen auf der Plattform.
Überblick
Der Befehl gtx-cli translate übersetzt Ihr Projekt. Er durchläuft den Dateibaum Ihres Projekts und übersetzt alle Inhalte, die in einer <T>-Komponente eingeschlossen sind.
Zusätzlich werden Inhalte aus der Wörterbuchdatei (falls vorhanden) einbezogen.
Dieser Befehl ist die primäre Methode zur Nutzung der General Translation API und zugehöriger Dienste.
Nur für den Produktionseinsatz!
Dieser Befehl ist für Produktions-Builds gedacht und sollte nicht in der Entwicklung verwendet werden.
Bevor Sie diesen Befehl ausführen, stellen Sie bitte sicher, dass Sie sich auf dem Branch befinden, der für die Produktion verwendet wird.
Denken Sie auch daran, Ihren Produktions-API-Schlüssel (GT_API_KEY) und Ihre Projekt-ID (GT_PROJECT_ID) in Ihren Umgebungsvariablen anzugeben.
Verwendung
Es gibt vier Möglichkeiten, den Befehl translate zu verwenden. Methoden 1 und 2 erfordern einen Produktions-API-Schlüssel:
Wir empfehlen, den Einrichtungsassistenten auszuführen: npx gtx-cli configure, um Ihr Projekt zu konfigurieren, bevor Sie den Befehl translate ausführen.
Je nachdem, wie Ihr Projekt konfiguriert ist, kann sich das Verhalten des Übersetzungsbefehls ändern.
Methode 1: Übersetzen der JSON-Dateien Ihres Projekts.
Wenn Sie andere i18n-Bibliotheken wie next-intl, react-i18next oder next-i18next verwenden, können Sie diese Methode nutzen, um die JSON-Dateien Ihres Projekts zu übersetzen.
Übersetzungen werden automatisch in Ihrer Codebasis gespeichert.
Um das CLI-Tool zum Übersetzen der JSON-Dateien Ihres Projekts zu verwenden, ändern Sie Ihre gt.config.json-Datei, um json in der Eigenschaft files einzuschließen.
Weitere Details finden Sie in der CLI-Konfigurationsdokumentation.
Das CLI-Tool erkennt Ihre i18n-Bibliothek automatisch, indem es Ihre package.json-Datei liest, und übersetzt Ihre JSONs unter Berücksichtigung der Syntax Ihrer i18n-Bibliothek.
Methode 2: Übersetzen Ihres GT-Projekts.
Wenn Ihr Projekt gt-next oder gt-react verwendet, können Sie diese Methode nutzen, um Übersetzungen für Ihr Projekt zu generieren.
Standardmäßig werden Übersetzungen im GT CDN gespeichert.
Wenn Sie die Übersetzungen jedoch in Ihrer Codebasis speichern möchten, fügen Sie die Eigenschaft gt zum Objekt files in der Datei gt.config.json hinzu.
gt-next und gt-react unterstützen sowohl das lokale Bereitstellen von Übersetzungen als auch die Verwendung des öffentlichen CDN von General Translation.
Wir empfehlen die Verwendung des CDN für geringere Latenz, bessere Leistung und kleinere Bundle-Größen.
Weitere Details finden Sie in der CLI-Konfigurationsdokumentation.
Methode 3: Validieren der <T>-Komponenten und der Wörterbuchdatei Ihres Projekts.
Diese Methode ist nützlich zur Validierung der <T>-Komponenten und der Wörterbuchdatei Ihres Projekts.
Dies stellt sicher, dass Ihr Projekt korrekt konfiguriert ist und dass die Übersetzungen gültig und genau sein werden.
Es werden keine Übersetzungen generiert, wenn das Flag --dry-run angegeben wird.
Flags
| Parameter | Beschreibung | Typ | Optional | Standard |
|---|---|---|---|---|
--api-key | Einen Produktions-API-Schlüssel angeben | string | true | |
--project-id | Die Projekt-ID angeben | string | true | |
--version-id | Eine Versions-ID angeben (standardmäßig ein Hash des Inhalts) | string | true | |
--config <path> | Einen Pfad zur GT-Konfigurationsdatei angeben | string | true | "gt.config.json" |
--tsconfig, --jsconfig <path> | Einen Pfad zur TS- oder JS-Konfigurationsdatei angeben | string | true | |
--src <paths> | Das/die zu scannende(n) Quellverzeichnis(se) angeben | [string] | true | ./src && ./app && ./pages && ./components |
--dictionary <path> | Einen Pfad zur Wörterbuchdatei angeben | string | true | |
--inline | Inline-<T>-Tags zusätzlich zum Wörterbuch einbeziehen | boolean | true | true |
--timeout | Das Timeout für die Übersetzungsanfrage in Sekunden | number | true | 600 |
--new, --locales <locales> | Sprachen, in die Ihr Projekt übersetzt werden soll | [string] | true | |
--default-locale <locale> | Die Quellsprache für das Projekt | string | true | en |
--ignore-errors | Fehler ignorieren und Übersetzung für gültige Inhalte erzwingen | flag | true | false |
--dry-run | Testlauf des Befehls | flag | true | false |
--no-wait | Nicht auf den Abschluss der Übersetzungen warten, bevor das Programm beendet wird | flag | true | false |
--publish | Die Übersetzungen im CDN veröffentlichen | flag | true | false |
Alle diese Parameter sind optional und können alternativ in der Datei gt.config.json angegeben werden.
Fügen Sie Ihren API-Schlüssel nicht zur Datei gt.config.json hinzu!
Sie sollten ihn stattdessen als Umgebungsvariable festlegen. Die CLI liest automatisch GT_API_KEY, wenn diese Variable gesetzt ist.
Es gibt einige wichtige Parameter:
| Parameter | Beschreibung |
|---|---|
--dry-run | Dieser Flag bewirkt, dass die CLI Ihr Projekt analysiert und validiert, aber nicht mit der GT-API kommuniziert. Dies ist nützlich zur Validierung Ihrer Codebasis. |
--api-key | Wenn Sie nicht --dry-run verwenden, müssen Sie einen Produktions-API-Schlüssel angeben. |
--project-id | Ebenso müssen Sie, wenn Sie nicht --dry-run verwenden, eine Projekt-ID angeben. |
--publish | Wenn Sie lokale Übersetzungen verwenden und Ihre Übersetzungen öffentlich im GT-CDN verfügbar machen möchten, können Sie diesen Flag verwenden. |
--new, --locales <locales> | Sprachen, in die Ihr Projekt übersetzt werden soll. Diese werden zu den in Ihrer Datei gt.config.json angegebenen Sprachen hinzugefügt. |
Konfigurationsdatei
Wenn Sie das CLI-Tool zum ersten Mal ausführen, wird versucht, eine Datei gt.config.json im Stammverzeichnis Ihres Projekts zu erstellen.
Diese Datei enthält Metadaten über Ihr Projekt, die für die Übersetzung Ihrer Inhalte verwendet werden.
Lesen Sie mehr über die Datei gt.config.json hier.