Pravidla pro klíče

Určete, zda se hodnota převezme ze zdrojového obsahu, existujícího cílového obsahu, překladu, nebo metadat jazyka.

Některé hodnoty v katalogu mají zůstat ve všech jazycích stejné. Jiné se mají přebírat z ručně spravovaného cílového obsahu. Pravidla pro klíče tyto volby jednoznačně určují při opětovném sestavování výstupu obslužným modulem souborů, který tato pravidla podporuje.

Jde o nastavení položek souborů v .lingo/config.json. Neslouží k výběru souborů ani k vyžádání aktualizace klíčů; k tomu slouží rozsahy překladu.

PravidloChování výstupu
lockedKeysZkopíruje zdrojovou hodnotu bez překladu.
preservedKeysZachová existující cílovou hodnotu, pokud je k dispozici.
ignoredKeysOdstraní vybraný obsah z výstupu formátu, který toto pravidlo podporuje.
injectLocaleZapíše cílový jazyk na zvolené místo.

Přiřaďte každé hodnotě vlastníka #

json
{
  "pattern": "locales/en.json",
  "lockedKeys": ["product.id"],
  "preservedKeys": ["legal.notice"],
  "ignoredKeys": ["internal.note"],
  "injectLocale": { "enabled": true, "key": "meta.locale" }
}

V tomto příkladu se ID produktu přebírá ze zdroje, stávající právní upozornění se zachovává z cílového obsahu a interní poznámka se vynechává. Vložení jazyka zapíše cílový jazyk do meta.locale a podle potřeby vytvoří chybějící nadřazené objekty. Při zápisu do pole zadejte existující pole a vyberte existující prvek nebo pozici bezprostředně za koncem pole; cesty, které vytvářejí mezery nebo procházejí nekompatibilními hodnotami, selžou.

Zachování nevytvoří ruční překlad tam, kde žádný není. Běžné přírůstkové zpracování už využívá existující cílový obsah k zachování úprav u nezměněných klíčů; preservedKeys nad rámec tohoto chování přidává výslovnou ochranu. Změna zdroje nebo přejmenování klíče JSON může i tak vyžadovat nové zpracování.

Cesty a překrývající se pravidla #

Pravidla pro JSON/JSONC používají názvy oddělené tečkami a indexy v hranatých závorkách, například checkout.submit nebo items[0].title. Chráněná cesta může zahrnovat i potomky. Pokud samotný název klíče obsahuje tečku, použijte vlastnost JSONPath v uvozovkách, například $['checkout.submit']. lingo push umí číst také seznamy zapsané pro starší CLI pomocí /: každý název mezi / se chápe jako celek, takže checkout/submit odpovídá checkout.submit a common/error.message označuje klíč error.message pod common. Názvy s procentním kódováním, například legal/Terms%20of%20use, se dekódují; vzor bez / je cesta v tečkové notaci a nedekóduje se. Samostatný zakódovaný název proto zapište jako JSONPath, například $['Terms of use']. Protože se tímto způsobem čte každý vzor s /, název klíče obsahující / vyžaduje zápis JSONPath, například $.routes['/about'].title. Koncové *, například v internal/*, zahrnuje hodnoty přímo pod internal, nikoli však objekty nebo pole vnořené na tomto místě, stejně jako ve starším CLI. Starší CLI zahrnovalo i klíče pokračující znaky - nebo ., takže legal/terms zahrnovalo legal/terms-short. Toto porovnávání podle předpony už neplatí; takové klíče uveďte samostatně. GitHub App nepřijímá zápis s lomítky: pokud stejnou konfiguraci čte GitHub App, zapište tyto seznamy v tečkové notaci nebo jako JSONPath. Tento zápis popisuje část Rozsahy.

Na stejném místě pravidlo vynechání odstraní hodnotu, a to i vloženou hodnotu jazyka. Vložení jazyka má přednost před zamknutím i zachováním. Zamknutí má přednost před zachováním, takže u klíče uvedeného v obou seznamech se použije zdrojová hodnota. Vynechání nadřazeného prvku odstraní i všechny jeho potomky. Kde je to možné, přiřaďte každé hodnotě jediného vlastníka. Pokud se pravidla v rámci objektu nebo pole překrývají, zkontrolujte výstup.

Vynucené zpracování celého souboru vymaže artefakt s aktuálním cílovým obsahem odesílaný na server. Bez tohoto cílového kontextu nemůže pravidlo zachování uchovat dřívější ručně vytvořené znění. Před vynuceným nahrazením si uložte kopii, ze které lze obsah obnovit.

Omezení obslužných modulů #

JSON a JSONC podporují všechny čtyři možnosti řízení. TypeScript, PHP, YAML a YAML s jazyky na kořenové úrovni podporují uzamčení, zachování a ignorování; stringsdict podporuje uzamčení a zachování. Formát Java properties podporuje uzamčení, zachování, ignorování a rozsah klíčů. Každý vzor přitom porovnává s celým klíčem stejně jako předchozí CLI. Formát CSV nepodporuje žádné ze tří pravidel pro klíče: CLI i GitHub App odmítnou položku CSV, která má nastavené lockedKeys, preservedKeys nebo ignoredKeys. Podrobnosti o podobě výstupu najdete v referenční dokumentaci zvoleného formátu.

Zkrácený zápis cesty podporuje * zastupující celé segmenty, číselné indexy a prázdné hranaté závorky. Zástupné znaky nahrazující jen část segmentu odmítá. Při použití lingo push přijímají tři seznamy pravidel pro klíče také zápis s lomítky; GitHub App ani umístění pro vložení jej nepřijímají. Názvy obsahující interpunkci zapisujte doslovně jako vlastnosti JSONPath v uvozovkách; explicitní dotazy $ se předávají beze změny. Vložení vyžaduje jediné umístění; při aktivním vkládání je výchozím klíčem language.