CLI-Konfigurationsdatei erstellen (Strings)

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

Voraussetzungen

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

Tipp

Weitere detaillierte Informationen finden Sie im Developer Hub.

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 startet im CLI.
Stelle Folgendes bereit:
- Zugriffstoken
  
  Einfügen oder Enter drücken, um $PHRASE_ACCESS_TOKEN zu verwenden
- Strings-Projekt-ID (z. B. abcdef1234567890abcdef1234567890)
- Sprachdateiformat (z. B. json, rails_yaml, ios_strings)
- Lokaler Pfad
  
  Glob oder exakter Pfad zu Sprachdateien im Projekt-Codebase (z. B. config/locales/*.json)

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

Tipp

Geben Sie 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-Kunde aufgerufen wird.
Verzeichnis des aktuellen Users ($HOME in Unix, $HomePath in Windows).
Der in der Umgebungsvariablen PHRASEAPP_CONFIG angegebene Pfad.
Pfad zur Konfigurationsdatei über --config melden (z.B. /some/path/to/phrase.yml).

Übersicht der CLI-Optionen

Beispiel:Konfigurationsdatei.

Globale Einstellungen

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

Push: Ausgangssprachen

Key	Typ	Erforderlich	Beschreibung
`push.sources[].file`	Pfad	Ja	Relativer Pfad zu der/den Datei(en) für den Push, z. B. `./path/to/file/<locale_code>.json`. Supports `<locale_name>`, `<locale_code>`, `<tags>`.
`push.sources[].project_id`	Zeichenfolge		Überschreiben Sie die globale `project_id` für diese spezifische Ausgangssprache. Nützlich beim Hochladen von Dateien in mehrere Phrase-Projekte aus derselben Konfigurationsdatei.

Push: Parameter

Parameter	Typ	Standard	Beschreibung
`file_format`	Zeichenfolge	Header	Überschreiben Sie das Format für diese Ausgangssprache.
`locale_id`	Zeichenfolge	—	Sprache (z. B. `en-US`) oder öffentliche ID der Sprache.
`tags`	Zeichenfolge	—	Durch Kommas getrennte Tags für neue Keys.
`update_translations`	Boolean	`false`	Aktualisieren Sie vorhandene Übersetzungen mit dem Content der Datei.
`update_translation_keys`	Boolean	`true`	Übergeben Sie hier `false`, um zu verhindern, dass neue Keys erstellt und vorhandene Keys aktualisiert werden.
`update_descriptions`	Boolean	`false`	Aktualisieren Sie Key-Beschreibungen; leer Beschreibungen überschreiben vorhandene.
`skip_upload_tags`	Boolean	`false`	Upload-Tags werden nicht erstellt.
`skip_unverification`	Boolean	`false`	Aktualisierte Übersetzungen sind nicht nicht verifiziert.
`file_encoding`	Zeichenfolge	—	Dateikodierung: `UTF-8`, `UTF-16`, `UTF-16BE`, `UTF-16LE` oder `ISO-8859-1`.
`locale_mapping`	Objekt	—	(Nur Excel/CSV) Ordnen Sie Sprachcodes Spaltennamen zu, z. B. `{\"en\": \"C\", \"de\": \"D\"}` für das Parsen von Übersetzungen. Dies unterscheidet sich vom `locale_mapping` auf oberster Ebene, das für Dateipfade verwendet wird.
`autotranslate`	Boolean	`false`	Übersetzungen für die hochgeladene Sprache automatisch abrufen.
`mark_reviewed`	Boolean	`false`	Importierte Übersetzungen als geprüft markieren (erweiterter Workflow für die Prüfung muss aktiviert sein).

Push: Format-Optionen

Alle verfügbaren Format-Optionen werden in der CLI-Konfiguration unterstützt. Siehe Beispiel-Konfigurationsdatei für Beispiele.

Pull: Zielsprachen

Key	Typ	Erforderlich	Beschreibung
`pull.targets[].file`	Pfad	Ja	Relativer Pfad für abgerufene Sprachdateien, z. B. `./Radio.de/<locale_code>.lproj/Localizable.strings`.
`pull.targets[].project_id`	Zeichenfolge		Überschreiben Sie die globale `Projekt-ID` für dieses spezifische Pull-Ziel. Aktivieren Sie das Abrufen von Übersetzungen aus mehreren Phrase-Projekten unter Verwendung derselben Konfigurationsdatei.

Pull: Parameter

Parameter	Typ	Standard	Beschreibung
`file_format`	Zeichenfolge	—	Muss `Strings` sein.
`locale_id`	Zeichenfolge	—	Sprache (z. B. `en-US`) oder öffentliche ID der Sprache.
`tags`	Zeichenfolge	—	Durch Kommas getrennte Tags, um zu filtern, welche Keys abgerufen werden sollen.
`include_empty_translations`	Boolean	`false`	Keys ohne Übersetzungen einbeziehen.
`exclude_empty_zero_forms`	Boolean	`false`	Null-Form-Plurale ausschließen, wenn leer.
`include_translated_keys`	Boolean	`true`	Schließen Sie Schlüssel ein, die bereits Übersetzungen haben.
`keep_notranslate_tags`	Boolean	`false`	`[NOTRANSLATE]`-Tags im Output beibehalten.
`Encoding`	Zeichenfolge	—	Dateikodierung: `UTF-8`, `UTF-16`, `UTF-16BE`, `UTF-16LE` oder `ISO-8859-1`.
`include_unverified_translations`	Boolean	`true`	Wenn `false`, nicht verifizierte Übersetzungen Ausschließen.
`use_last_reviewed_version`	Boolean	`false`	Wenn `true`, die zuletzt geprüfte Version verwenden (erfordert einen erweiterten Workflow für die Prüfung).
`fallback_locale_id`	Zeichenfolge	—	Fallback-Sprache, die für fehlende Übersetzungen zu verwenden ist.

Pull: Format-Optionen

Alle verfügbaren Format-Optionen werden in der CLI-Konfiguration unterstützt. Siehe Beispiel-Konfigurationsdatei für Beispiele.

Mehrere Konfigurationen

Platzieren Sie in Monorepos eine Konfigurationsdatei in jedem Paket und führen Sie die CLI aus dem entsprechenden Unterordner aus, oder verweisen Sie CI-Jobs mit der Option --config auf verschiedene Konfigurationsdateien.

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 festgelegte 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 festgelegte 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, für die Synchronisation eines öffentlichen Repositorys.)
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 für die Repository-Einstellungen keine signierten Commits erforderlich sind.

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 festgelegte 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.