Lingo check

Nechte CI skončit s chybou, pokud jsou překlady zastaralé, a kontrolujte katalogy pro React.

lingo check skončí s chybou, pokud jsou překlady zastaralé. Porovnává každý zdrojový soubor s .lingo/lock.json, vyžaduje všechny cílové soubory a v projektech @lingo.dev/react kontroluje také extrahované katalogy, deklarace, kontext a překlady.

sh
lingo check --json

Které kontroly se provádějí #

KontrolaKdy se spouští
Kontrola souborů.lingo/config.json obsahuje files nebo projekt nepoužívá React.
Kontroly pro ReactKořenový package.json nebo ten nejbližší k --src uvádí @lingo.dev/react, @lingo.dev/react-next či @lingo.dev/react-tanstack, nebo existuje vygenerovaný soubor deklarací (ve výchozím nastavení lingo.d.ts).

V projektu React s files se spouštějí obě kontroly. Pokud žádný vzor files neodpovídá žádnému souboru, kontrola skončí s chybou no-source-files, stejně jako lingo push. Výjimkou jsou projekty React, ve kterých se spustí pouze kontroly pro React a na stderr se o tom vypíše zpráva. Projekt bez files i bez Reactu skončí se stejnou chybou konfigurace jako lingo push.

lingo check nepotřebuje klíč API a nic nezapisuje. Kromě telemetrie CLI, kterou DO_NOT_TRACK=1 vypíná, neprovádí žádná síťová volání. Pokud nahlásí jakýkoli problém nebo narazí na chybu konfigurace (například kolizi cílů nebo poškozený soubor Lockfile), skončí s kódem 1, jinak s kódem 0.

Kontrola souborů #

Zdroje jsou soubory, které by lingo push odeslal. Cíle jsou cesty, na které by příkaz push zapisoval soubory pro každý nakonfigurovaný cílový jazyk.

SituaceProblémNáprava
Zdroj odpovídá svému záznamu v souboru Lockfile a jeho cíle existujížádný
Žádný vzor files neodpovídá žádnému souboruno-source-filesOpravte vzory files
Zdroj se od posledního překladu změnilsource-changedlingo push --wait nebo lingo pull, pokud příkaz push stále běží
Zdroj nemá záznam v souboru Lockfilesource-not-pushedlingo push --wait
Cílový soubor chybí a jeho zdroj je aktuálnímissing-targetlingo push --backfill-missing --wait
Cílový soubor chybí a jeho zdroj se změnil nebo nebyl nikdy odeslánmissing-targetlingo push --wait
Cílový soubor byl ručně upravenžádný
Soubor Lockfile chybí a všechny cílové soubory existujížádný, s poznámkou na stderr
Chybí soubor Lockfile i některý cílový soubormissing-target, s poznámkou na stderrlingo push --backfill-missing --wait, poté zahrňte cílové soubory a .lingo/lock.json do commitu

Záznamy v souboru Lockfile pro cesty, které už nejsou nakonfigurované jako zdroje, se ignorují. Varování o odhadnutých cílech a přeskočených souborech YAML, která vypisuje lingo push, se i zde vypisují na stderr.

Jak číst hlášení o problému #

TypNáprava k prověření
missing-contextDoplňte k extrahované zprávě užitečný kontext.
stale-jsoncZnovu vygenerujte zdrojový katalog a zkontrolujte ho.
stale-typesZnovu vygenerujte deklarace a zahrňte je do typové kontroly aplikace.
missing-translationPrověřte aktivní klíč, který nemá neprázdnou aktivní cílovou hodnotu.
orphanedPřed vyčištěním zjistěte, zda byla zpráva odstraněna, nebo ji extrakce nezachytila.

Problémy při kontrole souborů a jejich řešení najdete v části Kontrola souborů.

Výstup JSON #

Výstup JSON obsahuje issues a stats. Pro lokální použití je k dispozici čitelný textový výstup se stejnými problémy.

Každý problém má type a message. Problémy z kontrol pro React mohou mít src; problémy z kontroly souborů mají file a problém missing-target má navíc locale.

Statistiky obsahují messages, locales, missingContext, missingTranslations, orphaned, staleJsonc a staleTypes. Pokud se kontroly pro React nespustily, mají tyto položky hodnotu nula nebo false. Počet jazyků zahrnuje nalezené cílové jazyky i zdrojový jazyk. Pokud proběhla kontrola souborů, stats.files obsahuje lockfile, sources, locales, changedSources a missingTargets. Tyto údaje popisují konzistenci, nikoli naměřenou jazykovou kvalitu.

Spouštění v CI #

Spouštějte kontrolu při každém požadavku na sloučení (pull request nebo merge request), včetně těch z forků:

yaml
- uses: actions/checkout@v4
- run: npx @lingo.dev/cli@latest check

Použijte stejné vstupy jako při extrakci #

--src, --out, --types a --source-locale se vztahují pouze na kontroly pro React. Výchozí hodnota --src je src a výchozí hodnota --source-locale je en. --out má přednost před nakonfigurovanou cestou ke katalogu, další v pořadí je locales; --types má přednost před nakonfigurovanou cestou k deklaracím, další v pořadí je lingo.d.ts. Cesty se vyhodnocují vzhledem ke kořenovému adresáři projektu. Výchozí hodnota zdrojového jazyka je nezávislá na konfiguraci lokalizace. --json má výchozí hodnotu false a vztahuje se na obě kontroly.

Neaktuální data napravíte spuštěním extrakce se stejnými vstupy. Projděte varování a přehled změn, poté znovu spusťte kontrolu a sestavení aplikace. Odstraňujte pouze záznamy, u kterých jste ověřili, že už nejsou potřeba, a poté znovu vygenerujte deklarace.

Omezení #

  • Kontrola souborů pracuje na úrovni souborů. Chybějící klíč uvnitř existujícího cílového souboru nehlásí, s výjimkou katalogů .jsonc pro React.
  • Jazyky v jednom sdíleném katalogu, například v souboru .xcstrings, se nekontrolují. Ruční úprava v takovém katalogu se počítá jako změna zdroje.
  • Z repozitáře, který přešel z CLI na GitHub App, byste měli odstranit .lingo/lock.json.
  • Chyby konfigurace, například dva zdroje vedoucí ke stejnému cíli nebo poškozený soubor Lockfile, způsobí ukončení s kódem 1 a zprávou na stderr, bez výstupu JSON.
  • Hashe zdrojů se počítají z přesné bajtové podoby souborů, takže checkout, ve kterém běžel lingo push, a checkout v CI musí používat stejné konce řádků. Přidejte * text=auto eol=lf do .gitattributes.

U katalogů pro React jsou cíli soubory .jsonc v adresáři katalogu. Pokud vzory files odpovídají zdrojovému katalogu (například locales/en.jsonc), vyžaduje se také soubor pro každý nakonfigurovaný cílový jazyk.

Na problémy s kontextem se převádějí pouze varování extrakce o chybějícím kontextu. Varování o dynamických výrazech a informace o kolizích zde nepokrývají všechny podmínky pro ukončení s chybou; ukončení při kolizi vynucuje samotná extrakce. Kontrolou přítomnosti může projít i neprázdný zástupný text ve zdrojovém jazyce, přestože nejde o překlad.

Použijte extract --check, pokud potřebujete ověřit pouze aktuálnost vygenerovaných dat na úrovni bajtů. Vedle této kontroly zachovejte i validaci nativního formátu a kontrolu obsahu; úspěšný výsledek nevypovídá nic o prostředcích Androidu, vykreslování Markdownu ani významu překladů nad rámec skutečně provedených kontrol.