Vytvoření konfiguračního souboru CLI (Strings)

Obsah je strojově přeložen z angličtiny s použitím Phrase Language AI.

Předpoklady

API přístupový token s rozsahem read write
ID projektu Strings zobrazené v záložce API v nastavení projektu
Základní znalost YAML, včetně odsazení
Oprávnění pro čtení a zápis do Gitu, pokud bude úložiště v CI spouštět phrase push nebo phrase pull

Tip

Podrobnější informace naleznete v Developer Hub.

Chcete-li automaticky vytvořit konfigurační soubor, postupujte takto:

Z příkazového řádku zadejte phrase init a vytvořte soubor .phrase.yml.

Konfigurační průvodce se spustí v CLI.
Uveďte:
- Přístupový token
  
  Vložte nebo stiskněte Enter pro použití $PHRASE_ACCESS_TOKEN
- ID projektu Strings (např. abcdef1234567890abcdef1234567890)
- Formát souboru kódu jazyka (např. json, rails_yaml, ios_strings)
- Místní cesta
  
  Glob nebo přesná cesta k souborům kódu jazyka v základu kódu projektu (např. config/locales/*.json)

V aktuálním adresáři se vytvoří základní soubor .phrase.yml.

Tip

Zadejte příznaky pro úplné přeskočení průvodce, například phrase init --access_token=$PHRASE_ACCESS_TOKEN --project_id=... --file_format=ios_strings --path='ios/*.strings'.

Pokud používáte ručně vytvořený nebo zkopírovaný konfigurační soubor, umístěte do jednoho z těchto míst:

Aktuální pracovní adresář (pwd), ve kterém je volán klient CLI.
Hlavní adresář aktuálního uživatele ($HOME v Unixu, $HomePath ve Windows).
Cesta zadaná v proměnné prostředí PHRASEAPP_CONFIG.
Cesta ke konfiguračnímu souboru pomocí příznaku --config (např. /some/path/to/phrase.yml).

Přehled možností CLI

Vzorový konfigurační soubor.

Globální nastavení

Klíč	Typ	Požadováno	Popis
`phrase.access_token`	řetěz\|ec	Ano	Osobní přístupový token.
`phrase.project_id`	řetěz\|ec	Ano	Veřejné ID projekt zobrazené v nastavení projekt Strings.
`phrase.file_format`	řetěz\|ec	Ano	Výchozí kód jazyka formát souboru (rozšíření API).
`phrase.locale_mapping`	objekt	Ne	Mapuje ID kód jazyka Phrase na Vlastní názvy pro použít v cestách k souborům se zástupný znak `<locale_name>`. To je užitečné pro platformy s nestandardními konvencemi pojmenování, jako je Android. Pokud kód jazyka není v mapování specifikován, standardně se použije jeho název kód jazyka Phrase.

Odeslat: Zdroj

Klíč	Typ	Požadováno	Popis
`push.sources[].file`	cesta	Ano	Relativní cesta k souboru/souborům pro odeslání, např. `./path/to/file/<kód jazyka>.json`. Podporuje `<locale_name>`, `<kód jazyka>`, `<tags>`.
`push.sources[].project_id`	řetěz\|ec		Přepsat globální `ID projekt` pro tento konkrétní zdroj. Užitečné při odesílání souborů do více projekt Phrase ze stejného konfiguračního souboru.

Odeslat: Parametry

Parametr	Typ	Výchozí	Popis
`file_format`	řetěz\|ec	záhlaví	Přepsat formát souboru pro tento zdroj.
`locale_id`	řetěz\|ec	—	Název kódu jazyka (např. `en-US`) nebo veřejné ID kódu jazyka.
`tags`	řetěz\|ec	—	Čárkou oddělené štítky pro nové klíče.
`update_translations`	boolean	`false`	Aktualizovat stávající překlady obsahem souboru.
`update_translation_keys`	boolean	`true`	Zde předejte `false`, abyste zabránili vytváření nových klíčů a aktualizaci stávajících klíčů.
`update_descriptions`	boolean	`false`	Aktualizovat popisy klíčů; prázdné popisy přepíší stávající.
`skip_upload_tags`	boolean	`false`	Štítky nahrávání nejsou vytvořeny.
`skip_unverification`	boolean	`false`	Aktualizované překlady nejsou neověřeny.
`file_encoding`	řetěz\|ec	—	Kódování souboru: `UTF-8`, `UTF-16`, `UTF-16BE`, `UTF-16LE` nebo `ISO-8859-1`.
`locale_mapping`	objekt	—	(Pouze Excel/CSV) Mapovat kódy jazyka na názvy sloupců, např. `{\"en\": \"C\", \"de\": \"D\"}` pro analýzu překladů. Toto se liší od `locale_mapping` na nejvyšší úrovni používaného pro cesty k souborům.
`autotranslate`	boolean	`false`	Automaticky načíst překlady pro nahraný jazyk.
`mark_reviewed`	boolean	`false`	Označit importované překlady jako zkontrolované (musí být povolen pokročilý pracovní postup kontroly).

Push: Možnosti formátu

Všechny dostupné možnosti formátu jsou podporovány v konfiguraci CLI. Příklady naleznete v ukázkovém konfiguračním souboru.

Stáhnout: cíle

Klíč	Typ	Požadováno	Popis
`pull.targets[].file`	cesta	Ano	Relativní cesta pro stažené soubory s kódem jazyka, např. `./Radio.de/<kód_jazyka>.lproj/Localizable.Strings`.
`pull.targets[].project_id`	řetěz\|ec		Přepsat globální `ID projektu` pro tento konkrétní cíl stažení. Povolit stahování překladů z více projektů Phrase pomocí stejného konfiguračního souboru.

Stáhnout: Parametry

Parametr	Typ	Výchozí	Popis
`file_format`	řetěz\|ec	—	Musí být `Strings`.
`locale_id`	řetěz\|ec	—	Název kódu jazyka (např. `en-US`) nebo veřejné ID kódu jazyka.
`tags`	řetěz\|ec	—	Čárkou oddělené tagy pro filtrování klíčů, které se mají stáhnout.
`include_empty_translations`	boolean	`false`	Zahrnout klíče bez jakýchkoli překladů.
`exclude_empty_zero_forms`	boolean	`false`	Vyloučit plurály s nulovým tvarem, pokud jsou prázdné.
`include_translated_keys`	boolean	`true`	Zahrnout klíče, které již mají překlady.
`keep_notranslate_tags`	boolean	`false`	Zachovat tagy `[NOTRANSLATE]` ve výstupu.
`Kódování`	řetěz\|ec	—	Kódování souboru: `UTF-8`, `UTF-16`, `UTF-16BE`, `UTF-16LE` nebo `ISO-8859-1`.
`include_unverified_translations`	boolean	`true`	Pokud je `false`, vyloučit neověřené překlady.
`use_last_reviewed_version`	boolean	`false`	Pokud je `true`, použít poslední zkontrolovanou verzi (vyžaduje pokročilý pracovní postup kontroly).
`fallback_locale_id`	řetěz\|ec	—	Záložní kód jazyka, který se má použít pro chybějící překlady.

Stáhnout: Možnosti formátu

Všechny dostupné možnosti formátu jsou podporovány v konfiguraci CLI. Příklady naleznete v ukázkovém konfiguračním souboru.

Více konfigurací

V monorepo umístěte jeden konfigurační soubor do každého balíčku a spusťte CLI z odpovídající podsložky, nebo nasměrujte úlohy CI na různé konfigurační soubory pomocí volby --config.

Integrace Git

GitLab:

Konfigurační soubor .phrase.yml musí být v úložišti. Soubor definuje, které soubory chcete importovat (pull) nebo exportovat (push) z úložiště.
Úložiště vyžaduje přístup pro čtení i zápis.
Nesprávně definované konfigurační soubory mohou způsobit chyby. Ujistěte se, že soubor obsahuje alespoň jeden cíl pro push a pull, správné formáty souborů a správné nastavení parametru update_translations.
Pro zajištění kompatibility API použijte GitLab 9.5 nebo novější.

GitHub:

Konfigurační soubor .phrase.yml musí být v úložišti. Soubor definuje, které soubory chcete importovat (pull) nebo exportovat (push) z úložiště.
Úložiště vyžaduje přístup pro čtení i zápis.
Nesprávně definované konfigurační soubory mohou způsobit chyby. Ujistěte se, že soubor obsahuje alespoň jeden cíl pro push a pull, správné formáty souborů a správné nastavení parametru update_translations.
Přístupový token GitHub pro rozsah úložiště (public_repo, pokud se synchronizuje s veřejným úložištěm).
Pokud je v GitHubu povoleno SSO, musí být povoleno i pro přístupový token.
Větev phrase_translations nelze ochránit.
Ujistěte se, že nastavení úložiště nevyžaduje podepsané revize.

BitBucket:

Konfigurační soubor .phrase.yml musí být v úložišti. Soubor definuje, které soubory chcete importovat (pull) nebo exportovat (push) z úložiště.
Úložiště vyžaduje přístup pro čtení i zápis.
Nesprávně definované konfigurační soubory mohou způsobit chyby. Ujistěte se, že soubor obsahuje alespoň jeden cíl pro push a pull, správné formáty souborů a správné nastavení parametru update_translations.

phrase.yml.sample
(3 KB)