Das CLI-Tool
Das allgemeine Übersetzungs-CLI-Tool
Überblick
Dies ist ein Referenzdokument über das General Translation CLI-Tool.
Lesen Sie mehr über gtx-cli hier.
Für eine Schritt-für-Schritt-Anleitung, schauen Sie sich den Bereitstellung in die Produktion Leitfaden an.
Installation
Was macht das CLI-Tool?
Das CLI-Tool wird zur Verwaltung Ihres Projekts und Ihrer Übersetzungen verwendet.
Es gibt zwei Hauptbefehle, die Sie kennen sollten: translate und setup.
- Der
translate-Befehl soll zur CD-Pipeline hinzugefügt werden. Er wird verwendet, um Ihr Projekt nach zu übersetzendem Inhalt zu durchsuchen. Der Inhalt wird dann zu einem CDN hochgeladen oder Ihrem App-Bundle hinzugefügt, um zur Laufzeit verwendet zu werden. - Der
setup-Befehl wird verwendet, um die General Translation-Bibliothek automatisch in Ihr Projekt zu integrieren. Er durchsucht Ihr Projekt und umschließt jeden JSX-Inhalt mit einer<T>-Komponente.
Übersetzen
Um das CLI-Tool zu verwenden, führen Sie den folgenden Befehl vom Stammverzeichnis Ihres Projekts aus:
Nur für den Produktionseinsatz!
Da dieses CLI-Tool übersetzten Inhalt auf das CDN veröffentlicht, ist es nur 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 und Ihre Projekt-ID in Ihren Umgebungsvariablen anzugeben.
Flags
| Prop | Type | Default |
|---|---|---|
--api-key? | string | - |
--project-id? | string | - |
--options? | string | gt.config.json |
--new? | string | - |
--dictionary? | string | - |
--dry-run? | boolean | false |
--ignore-errors? | boolean | false |
--inline? | boolean | true |
Wenn Sie das CLI-Tool zum ersten Mal ausführen, wird es versuchen, 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.
Einrichtung
Zusätzlich kann das CLI-Tool Ihr Projekt automatisch scannen und für die Übersetzung einrichten. Wenn Sie die Allgemeine Übersetzung zum ersten Mal verwenden, empfehlen wir, die Einrichtung durchzuführen, um loszulegen.
Änderungen sichern!
Dies wird Ihren Code ändern, also stellen Sie sicher, dass Sie entweder Ihre Änderungen sichern oder committen.
Das Ausführen dieses Befehls wird <T>-Komponenten um die oberste Ebene der JSX-Elemente wickeln, die übersetzbaren Inhalt enthalten.
Es wird auch jeglichen nicht-statischen Inhalt mit <Var>-Komponenten umwickeln.
Hier sind einige Beispiele dafür, was der Scan konvertieren wird:
Wird konvertiert zu:
Das CLI wird nur direkte Kinder innerhalb von JSX-Elementen umwickeln. Es wird andere JSX-Elemente separat mit ihren eigenen <T>-Komponenten umwickeln.
Experimentell
Diese Funktion ist derzeit experimentell und funktioniert möglicherweise nicht perfekt.
Nach dem Ausführen des Scans sollten Sie die Ausgabe manuell überprüfen und sicherstellen, dass sie korrekt ist.
Beachten Sie insbesondere, dass alle nicht-statischen JSX-Ausdrücke {...} in <Var>-Komponenten umwickelt werden.
Möglicherweise müssen Sie diese Fälle manuell überprüfen und bearbeiten.
Bitte melden Sie alle Probleme, auf die Sie stoßen, hier.
Flags
| Prop | Type | Default |
|---|---|---|
--src? | string | - |