CLI-Konfigurationsdatei erstellen (Strings)

Inhalte werden von Phrase Language AI maschinell aus dem Englischen übersetzt.

Voraussetzungen

API-Zugriffstoken mit Lesen Schreiben Berechtigung
Strings-Projekt-ID, die im API-Tab der Projekteinstellungen angezeigt wird
Grundkenntnisse in YAML, einschließlich Einrückung
Git-Lese- und Schreibberechtigungen, wenn das Repository phrase push oder phrase pull in CI ausführen wird

Gehe folgendermaßen vor, um automatisch eine Konfigurationsdatei zu erstellen:

Gib in der Kommandozeile phrase init ein, um eine .phrase.yml-Datei zu erstellen.

Der Konfigurationsassistent beginnt im CLI.
Stelle Folgendes bereit:
- Zugriffstoken
  
  Füge ein oder drücke Enter, damit $PHRASE_ACCESS_TOKEN verwendet werden kann
- Strings-Projekt-ID (z. B. abcdef1234567890abcdef1234567890)
- Dateiformat der Locale-Datei (z. B. json, rails_yaml, ios_strings)
- Lokaler Pfad
  
  Glob oder exakter Pfad zu Locale-Dateien im Projektcode (z. B. config/locales/*.json)

Eine grundlegende .phrase.yml-Datei wird im aktuellen Verzeichnis erstellt.

Tipp

Gib Flags an, um den Assistenten vollständig zu überspringen, zum Beispiel phrase init --access_token=$PHRASE_ACCESS_TOKEN --project_id=... --file_format=ios_strings --path='ios/*.strings'.

Wenn du eine manuell erstellte oder kopierte Konfigurationsdatei verwendest, platziere sie an einem der folgenden Speicherorte:

Das aktuelle Arbeitsverzeichnis (pwd), in dem der CLI-Client aufgerufen wird.
Das Home-Verzeichnis des aktuellen Users ($HOME in Unix, $HomePath in Windows).
Der in der PHRASEAPP_CONFIG Umgebungsvariablen angegebene Pfad.
Pfad zur Konfigurationsdatei über das --config melden (z.B. /some/path/to/phrase.yml).

CLI-Optionen Übersicht

Beispiel Konfigurationsdatei.

Globale Einstellungen

Key	Typ	Erforderlich	Beschreibung
`phrase.access_token`	Zeichenfolge	Ja	Öffentliches Zugriffstoken.
`phrase.project_id`	Zeichenfolge	Ja	Öffentliche Projekt-ID, die in den Strings-Projekteinstellungen angezeigt wird.
`phrase.file_format`	Zeichenfolge	Ja	Standard-Locale Dateiformat (API-Erweiterung).
`phrase.locale_mapping`	Objekt	Nein	Ordnet Phrase-Locale-IDs benutzerdefinierten Namen zu, die in Dateipfaden mit dem `<locale_name>` Platzhalter verwendet werden können. Dies ist nützlich für Plattformen mit nicht standardmäßigen Namenskonventionen, wie Android. Wenn eine Sprache im Mapping nicht angegeben ist, wird standardmäßig der Name der Phrase-Sprache verwendet.

Push: Quellen

Key	Typ	Erforderlich	Beschreibung
`push.sources[].file`	Pfad	Ja	Relativer Pfad zu Datei(en), die gepusht werden sollen, z.B. `./pfad/zur/datei/<locale_code>.json`. Supports `<locale_name>`, `<locale_code>`, `<tags>`.
`push.sources[].project_id`	Zeichenfolge		Überschreiben Sie die globale `projekt_id` für diese spezifische Dateiquelle. Nützlich, wenn Dateien von derselben Konfigurationsdatei in mehrere Phrase-Projekte gepusht werden.

Push: Parameter

Parameter	Typ	Standard	Beschreibung
`file_format`	Zeichenfolge	Kopfzeile	Dateiformat für diese Quelle überschreiben.
`locale_id`	Zeichenfolge	—	Sprachenname (z.B. `en-US`) oder öffentliche Sprach-ID.
`tags`	Zeichenfolge	—	Durch Kommas getrennte Tags für neue Schlüssel.
`update_translations`	Boolean	`false`	Aktualisieren Sie vorhandene Übersetzungen mit dem Dateiinhalte.
`update_translation_keys`	Boolean	`true`	Geben Sie `false` hier ein, um zu verhindern, dass neue Schlüssel erstellt und vorhandene Schlüssel aktualisiert werden.
`update_descriptions`	Boolean	`false`	Aktualisieren Sie die Schlüsseldeskriptionen; leere Beschreibungen überschreiben vorhandene.
`skip_upload_tags`	Boolean	`false`	Hochlade-Tags werden nicht erstellt.
`skip_unverification`	Boolean	`false`	Aktualisierte Übersetzungen sind nicht nicht verifiziert.
`file_encoding`	Zeichenfolge	—	Dateicodierung: `UTF-8`, `UTF-16`, `UTF-16BE`, `UTF-16LE` oder `ISO-8859-1`.
`locale_mapping`	Objekt	—	(Nur Excel/CSV) Ordnen Sie die Gebietsschema-Codes den Spaltennamen zu, z.B. `{"en": "C", "de": "D"}` zum Parsen von Übersetzungen. Dies unterscheidet sich vom obersten `locale_mapping`, das für Dateipfade verwendet wird.
`autotranslate`	Boolean	`false`	Automatisches Abrufen von Übersetzungen für die hochgeladene Sprache.
`mark_reviewed`	Boolean	`false`	Markieren Sie importierte Übersetzungen als geprüft (advanced review workflow muss aktiviert sein).

Push: Format Options

Alle verfügbaren Formatoptionen werden in der CLI-Konfiguration unterstützt. Siehe Sample configuration file für Beispiele.

Pull: Ziele

Key	Typ	Erforderlich	Beschreibung
`pull.targets[].file`	Pfad	Ja	Relativer Pfad für gezogene Sprachdateien, z. B. `./Radio.de/<locale_code>.lproj/Localizable.strings`.
`pull.targets[].project_id`	Zeichenfolge		Überschreibe die globale `projekt_id` für dieses spezifische Ziel. Aktivieren Sie das Ziehen von Übersetzungen aus mehreren Phrase-Projekten mit derselben Konfigurationsdatei.

Pull: Parameter

Parameter	Typ	Standard	Beschreibung
`file_format`	Zeichenfolge	—	Muss `Strings` sein.
`locale_id`	Zeichenfolge	—	Sprachenname (z.B. `en-US`) oder öffentliche Sprach-ID.
`tags`	Zeichenfolge	—	Durch Kommas getrennte Tags, um zu filtern, welche Schlüssel gezogen werden sollen.
`include_empty_translations`	Boolean	`false`	Schlüssel ohne Übersetzungen einbeziehen.
`exclude_empty_zero_forms`	Boolean	`false`	Null-Form-Mehrzahlen ausschließen, wenn leer.
`include_translated_keys`	Boolean	`true`	Schlüssel einbeziehen, die bereits Übersetzungen haben.
`keep_notranslate_tags`	Boolean	`false`	`[NOTRANSLATE]` Tags im Output beibehalten.
`kodierung`	Zeichenfolge	—	Dateicodierung: `UTF-8`, `UTF-16`, `UTF-16BE`, `UTF-16LE` oder `ISO-8859-1`.
`include_unverified_translations`	Boolean	`true`	Wenn `false`, unbestätigte Übersetzungen ausschließen.
`use_last_reviewed_version`	Boolean	`false`	Wenn `true`, die letzte geprüfte Version verwenden (erfordert einen fortgeschrittenen Prüfungsworkflow).
`fallback_locale_id`	Zeichenfolge	—	Fallback-Sprache für fehlende Übersetzungen.

Pull: Format-Optionen

Alle verfügbaren Formatoptionen werden in der CLI-Konfiguration unterstützt. Siehe Sample configuration file für Beispiele.

Mehrere Konfigurationen

In Monorepos sollte eine Konfigurationsdatei in jedem Paket platziert und die CLI aus dem entsprechenden Unterordner ausgeführt werden, oder CI-Jobs sollten auf verschiedene Konfigurationsdateien mit der Option --config verweisen.

Git-Integration

GitLab:

Die Konfigurationsdatei .phrase.yml muss im Repository vorhanden sein. Die Datei legt fest, welche Dateien aus dem Repository importiert (pull) oder exportiert (push) werden sollen.
Für das Repository ist Lese- und Schreibzugriff erforderlich.
Falsch definierte Konfigurationsdateien können Fehler verursachen. Stelle sicher, dass die Datei mindestens ein Push- und ein Pull-Ziel, die korrekten Dateiformate und die korrekte Einstellung des Parameters update_translations enthält.
Verwende GitLab 9.5 oder neuer, um die API-Kompatibilität zu gewährleisten.

GitHub:

Die Konfigurationsdatei .phrase.yml muss im Repository vorhanden sein. Die Datei legt fest, welche Dateien aus dem Repository importiert (pull) oder exportiert (push) werden sollen.
Für das Repository ist Lese- und Schreibzugriff erforderlich.
Falsch definierte Konfigurationsdateien können Fehler verursachen. Stelle sicher, dass die Datei mindestens ein Push- und ein Pull-Ziel, die korrekten Dateiformate und die korrekte Einstellung des Parameters update_translations enthält.
Ein GitHub-Zugriffstoken für den Anwendungsbereich des Repositorys (public_repo, wenn mit einem öffentlichen Repository synchronisiert wird).
Wenn SSO in GitHub aktiviert ist, muss es auch für das Zugriffstoken aktiviert werden.
Der Branch phrase_translations kann nicht geschützt werden.
Stelle sicher, dass die Repository-Einstellungen keine signierten Commits erfordern.

BitBucket:

Die Konfigurationsdatei .phrase.yml muss im Repository vorhanden sein. Die Datei legt fest, welche Dateien aus dem Repository importiert (pull) oder exportiert (push) werden sollen.
Für das Repository ist Lese- und Schreibzugriff erforderlich.
Falsch definierte Konfigurationsdateien können Fehler verursachen. Stelle sicher, dass die Datei mindestens ein Push- und ein Pull-Ziel, die korrekten Dateiformate und die korrekte Einstellung des Parameters update_translations enthält.

phrase_configuration_overview.yml
(8 kB)