Übersetzen
So übersetzen Sie Ihr Projekt
Verwendung
Führen Sie dies in Ihrer CI-Pipeline aus, bevor Sie Ihre App für die Produktion bauen.
npx gtx-cli translateHinweis: Dieser Befehl erfordert einen Production-API-Schlüssel! Sie erhalten einen auf der Plattform.
Übersicht
Der Befehl gtx-cli translate übersetzt Ihr Projekt.
Er durchläuft die Dateistruktur Ihres Projekts und übersetzt alle Inhalte, die in eine <T>-Komponente eingebettet sind
oder die useGT()-Funktionen verwenden.
Zusätzlich wird auch Inhalt aus der Wörterbuchdatei einbezogen (sofern eine bereitgestellt wird).
Dieser Befehl ist die Hauptmethode zur Nutzung der General Translation API und der zugehörigen 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 die Projekt-ID (GT_PROJECT_ID) in Ihren Umgebungsvariablen anzugeben.
Verwendung
Es gibt 3 Möglichkeiten, den translate Befehl zu verwenden. Methode 1 und 2 erfordern einen Produktions-API-Schlüssel:
Wir empfehlen, den Setup-Assistenten auszuführen: npx gtx-cli configure, um Ihr Projekt vor der Ausführung des translate Befehls zu konfigurieren.
Je nachdem, wie Ihr Projekt konfiguriert ist, kann sich das Verhalten des translate Befehls ändern.
Methode 1: Übersetzen Sie die 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 zur Übersetzung der JSON-Dateien Ihres Projekts zu verwenden, ändern Sie Ihre gt.config.json Datei, um json in der files Eigenschaft einzuschließen.
Siehe die CLI-Konfigurationsdokumentation für weitere Details.
npx gtx-cli translateDas CLI-Tool erkennt automatisch Ihre i18n-Bibliothek durch das Lesen Ihrer package.json Datei und übersetzt Ihre JSONs unter Berücksichtigung der Syntax Ihrer i18n-Bibliothek.
Methode 2: Übersetzen Sie Ihr GT-Projekt.
Wenn Ihr Projekt gt-next oder gt-react verwendet, können Sie diese Methode nutzen, um Übersetzungen für Ihr Projekt zu generieren.
npx gtx-cli translateStandardmäßig werden Übersetzungen im GT CDN gespeichert.
Wenn Sie jedoch die Übersetzungen in Ihrer Codebasis speichern möchten, fügen Sie die gt Eigenschaft zum files Objekt in der gt.config.json Datei 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 reduzierte Latenz, bessere Leistung und kleinere Bundle-Größen.
Siehe die CLI-Konfigurationsdokumentation für weitere Details.
Methode 3: Validieren Sie die <T> Komponenten und die 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 --dry-run Flag bereitgestellt wird.
npx gtx-cli translate --dry-runFlags
| 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 einschließen | 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ültigen Inhalt erzwingen | flag | true | false |
--dry-run | Den Befehl als Testlauf ausführen | flag | true | false |
Alle diese Parameter sind optional.
Fügen Sie Ihren API-Schlüssel nicht zur gt.config.json-Datei hinzu!
Sie sollten ihn stattdessen als Umgebungsvariable setzen. Die CLI liest automatisch GT_API_KEY, wenn es gesetzt ist.
Es gibt einige wichtige Parameter:
| Parameter | Beschreibung |
|---|---|
--dry-run | Dieses Flag bewirkt, dass die CLI Ihr Projekt parst und validiert, aber nicht mit der GT-API kommuniziert. Dies ist nützlich zur Validierung Ihrer Codebasis. |
--api-key | Sofern Sie nicht --dry-run verwenden, müssen Sie einen Produktions-API-Schlüssel bereitstellen. |
--project-id | Ebenso müssen Sie, sofern Sie nicht --dry-run verwenden, eine Projekt-ID bereitstellen. |
--new, --locales <locales> | Sprachen, in die Ihr Projekt übersetzt werden soll. Diese werden an die in Ihrer gt.config.json-Datei angegebenen Sprachen angehängt. |
Konfigurationsdatei
Beim ersten Ausführen des CLI-Tools wird versucht, eine gt.config.json-Datei im Stammverzeichnis Ihres Projekts zu erstellen.
Diese Datei enthält Metadaten über Ihr Projekt, die zur Übersetzung Ihres Inhalts verwendet werden.
Lesen Sie mehr über die gt.config.json-Datei hier.
Wichtige Tipps
Inhaltsquellen
Der translate Befehl wird rekursiv nach übersetzbaren Inhalten in Ihrem Projekt suchen.
Standardmäßig sucht er in den folgenden Verzeichnissen:
./src./app./pages./components
Sie können alternative Verzeichnisse zum Durchsuchen angeben, indem Sie das --src Flag verwenden,
oder indem Sie die src Eigenschaft in Ihrer gt.config.json Datei ändern.
Wörterbuch-Datei
Der translate Befehl wird automatisch die Wörterbuch-Datei in Ihrem Projekt erkennen.
Standardmäßig sucht er nach einer Datei namens dictionary.[json|ts|js] in den folgenden Verzeichnissen:
./src./
Sie können eine alternative Wörterbuch-Datei angeben, indem Sie das --dictionary Flag verwenden,
oder indem Sie die dictionary Eigenschaft in Ihrer gt.config.json Datei ändern.
Wie ist dieser Leitfaden?