Typová kontrola volání zpráv
Vygenerujte a zahrňte deklarace, které už při úpravách kontrolují zdrojové řetězce, kontexty a hodnoty zpráv.
Volání zprávy může být z pohledu TypeScriptu platné, a přesto požadovat nesprávnou položku katalogu. Změna kontextu nebo překlep v zástupném symbolu může způsobit, že na obrazovce zůstane zdrojový text nebo {name}. Extrakce generuje deklarace, které začleňují známé zdrojové zprávy do typového systému aplikace.
Vygenerujte deklaraci a zahrňte ji #
Po instalaci CLI spusťte:
npx lingo extract --src src --source-locale enVýchozími výstupy jsou locales/en.jsonc a lingo.d.ts. Pokud žádný ze stávajících vzorů nezahrnuje lingo.d.ts, přidejte jej do stávajícího seznamu include v souboru tsconfig aplikace. Ostatní položky ponechte beze změny:
{
"include": ["src", "lingo.d.ts"]
}Spusťte obvyklou typovou kontrolu aplikace. Deklarace, která není součástí projektu překladače, žádná volání neomezuje. Pokud extrakce používá --types nebo i18n.typesPath, zahrňte místo výchozí cesty skutečnou cestu k výstupu.
Co znamená vygenerované rozhraní #
Soubor rozšiřuje LingoMessages o zdrojové řetězce a jejich volby. Následující ukázka znázorňuje výslednou strukturu:
export {};
declare module "@lingo.dev/react" {
interface LingoMessages {
"Hello, {name}.": {
values: { name: string | number };
context: "Greeting on the account dashboard";
};
"Save": {
context: "Submit settings" | "Bookmark an article";
};
}
}Soubor vždy znovu vygenerujte, místo abyste ukázku udržovali ručně. Pozdrav nyní vyžaduje values.name a svůj extrahovaný kontext. Save přijímá kterýkoli ze zaznamenaných kontextů. Zdrojový řetězec, který není v seznamu, nesplní omezení MessageKey.
Bez vygenerovaných položek je LingoMessages prázdné a MessageKey povoluje libovolný řetězec. Po doplnění položek se MessageKey stává sjednocením jeho řetězcových klíčů. Chování za běhu se nemění: tato omezení pro l.text a l.rich se uplatňují pouze při úpravách.
Udržujte typy v souladu se zdrojovým textem #
Po změně textu, kontextu nebo zástupných symbolů spusťte extrakci znovu. Odstraněné zprávy se stanou osiřelými položkami a z generování se vyloučí. Pro položky bez kontextu se žádná signatura nevygeneruje, pokud kontext neposkytuje jiná aktivní položka se stejným zdrojovým řetězcem. Více kontextů pro stejný zdrojový řetězec tvoří sjednocení.
Pro kontrolu aktuálnosti bez zápisu do souborů spusťte:
npx lingo extract --src src --source-locale en --checkTato kontrola porovná JSONC i deklarace s aktuální extrakcí. Jde o lokální kontrolu, nikoli o požadavek na překlad. Spouštějte ji společně s typovou kontrolou, aby zastaralá deklarace nemohla bez upozornění určovat již neaktuální sadu zpráv.
Typy hodnot a rozsah kontroly #
Generátor rozpoznává argumenty ICU na nejvyšší úrovni. Pro argumenty plural, ordinal a number používá number, pro argumenty select string, pro argumenty data a času Date | number a pro jednoduché zástupné symboly string | number. Nerozpozná všechny zástupné symboly vnořené do větví plurálu, proto hodnoty těchto větví otestujte samostatně.
Vygenerovaná omezení zdrojových řetězců se vztahují na text a rich. Pomocné funkce plural a select si zachovávají vlastní signatury pro tvary a volby. Volání s formátováním přidávají mapu značek, jejíž zadání je nepovinné, ale deklarace neověřují umístění značek v cílovém textu.
Typy vám řeknou, zda volání odpovídá kontraktu extrahovanému ze zdrojového textu. Testy vykreslování ověří, zda načtený překlad dokáže tyto hodnoty použít. Používejte obojí: i platné volání může narazit na chybějící položku katalogu nebo nesprávně sestavený výraz ICU v cílovém textu.