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 právem číst a zapisovat
ID projektu Strings zobrazené na kartě API v nastavení projektu
Základní znalosti YAML, včetně odsazení
Oprávnění pro čtení a zápis Git, pokud bude úložiště spouštět phrase push nebo phrase pull v CI

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

Z příkazového řádku zadejte phrase init pro vytvoření souboru .phrase.yml.

Průvodce konfigurací se spustí v CLI.
Uveďte:
- Přístupový token
  
  Vložte nebo stiskněte Enter, aby se $PHRASE_ACCESS_TOKEN mohl použít
- ID projektu Strings (např. abcdef1234567890abcdef1234567890)
- Formát souboru locale (např. json, rails_yaml, ios_strings)
- Místní cesta
  
  Globální nebo přesná cesta k souborům locale v kódu projektu (např. config/locales/*.json)

Základní soubor .phrase.yml je vytvořen v aktuálním adresáři.

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 ho 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	Povinné	Popis
`phrase.access_token`	řetězec	Ano	Veřejný přístupový token.
`phrase.project_id`	řetězec	Ano	Veřejné ID projektu zobrazené v nastavení projektu Strings.
`phrase.file_format`	řetězec	Ano	Výchozí kód jazyka formát souboru (rozšíření API).
`phrase.locale_mapping`	objekt	Ne	Mapuje ID jazyků Phrase na vlastní názvy pro použití v cestách souborů se zástupným znakem `<locale_name>`. To je užitečné pro platformy s nestandardními názvovými konvencemi, jako je Android. Pokud není v mapování specifikována lokalita, použije se její standardní název lokalizace Phrase jako výchozí.

Odeslat: Zdroje

Klíč	Typ	Povinné	Popis
`push.sources[].file`	cesta	Ano	Relativní cesta k souboru/souborům, které se mají odeslat, např. `./path/to/file/<locale_code>.json`. Podporuje `<locale_name>`, `<locale_code>`, `<tags>`.
`push.sources[].project_id`	řetězec		Přepište globální `project_id` pro tento konkrétní zdroj souboru. Užitečné při odesílání souborů do více projektů Phrase z jednoho konfiguračního souboru.

Odeslat: Parametry

Parametr	Typ	Výchozí	Popis
`file_format`	řetězec	hlavička	Přepište formát souboru pro tento zdroj.
`locale_id`	řetězec	—	Název lokality (např. `en-US`) nebo veřejné ID lokality.
`tags`	řetězec	—	Tagy oddělené čárkami pro nové klíče.
`update_translations`	boolean	`false`	Aktualizujte existující překlady pomocí obsahu 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`	Aktualizujte popisy klíčů; prázdné popisy přepíší stávající.
`skip_upload_tags`	boolean	`false`	Nahrané štítky nejsou vytvářeny.
`přeskočit_neověření`	boolean	`false`	Aktualizované překlady nejsou neověřené.
`file_encoding`	řetězec	—	Kódování souboru: `UTF-8`, `UTF-16`, `UTF-16BE`, `UTF-16LE` nebo `ISO-8859-1`.
`locale_mapping`	objekt	—	(Pouze Excel/CSV) Mapujte kódy lokalizace na názvy sloupců, např. `{"en": "C", "de": "D"}` pro analýzu překladů. To se liší od vrcholového `locale_mapping` používaného pro cesty k souborům.
`autotranslate`	boolean	`false`	Automaticky načtěte překlady pro nahraný jazyk.
`mark_reviewed`	boolean	`false`	Oz označte importované překlady jako zkontrolované (pokročilý pracovní postup kontroly musí být povolen).

Odeslat: Možnosti formátu

Všechny dostupné možnosti formátu jsou podporovány v konfiguraci CLI. Viz Ukázkový konfigurační soubor pro příklady.

Načíst: Cíle

Klíč	Typ	Povinné	Popis
`pull.targets[].file`	cesta	Ano	Relativní cesta pro stažené soubory jazyka, např. `./Radio.de/<locale_code>.lproj/Localizable.strings`.
`pull.targets[].project_id`	řetězec		Přepsat globální `project_id` pro tento konkrétní cíl stahování. Povolit stahování překladů z více projektů Phrase pomocí stejného konfiguračního souboru.

Pull: Parametry

Parametr	Typ	Výchozí	Popis
`file_format`	řetězec	—	Musí být `strings`.
`locale_id`	řetězec	—	Název lokality (např. `en-US`) nebo veřejné ID lokality.
`tags`	řetězec	—	Tagy oddělené čárkami pro filtrování, které klíče stáhnout.
`include_empty_translations`	boolean	`false`	Zahrnout klíče bez jakýchkoli překladů.
`exclude_empty_zero_forms`	boolean	`false`	Vyloučit nulté formy množného čísla, když jsou prázdné.
`include_translated_keys`	boolean	`true`	Zahrnout klíče, které již mají překlady.
`keep_notranslate_tags`	boolean	`false`	Zachovat `[NOTRANSLATE]` tagy ve výstupu.
`encoding`	řetězec	—	Kódování souboru: `UTF-8`, `UTF-16`, `UTF-16BE`, `UTF-16LE` nebo `ISO-8859-1`.
`include_unverified_translations`	boolean	`true`	Pokud `false`, vyloučit neověřené překlady.
`use_last_reviewed_version`	boolean	`false`	Pokud `true`, použít poslední zkontrolovanou verzi (vyžaduje pokročilý pracovní postup kontroly).
`fallback_locale_id`	řetězec	—	Záložní jazyk pro použití při chybějících překladech.

Pull: Možnosti formátu

Všechny dostupné možnosti formátu jsou podporovány v konfiguraci CLI. Viz Ukázkový konfigurační soubor pro příklady.

Více konfigurací

V monorepozitářích 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 CI úlohy na různé konfigurační soubory s volbou --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_configuration_overview.yml
(8 KB)