Typisierte Schlüssel & CLI

Die Typen generieren #

npx svelte-dialect typegen --messages src/lib/messages --out src/lib/i18n-keys.d.ts

Lass die CLI über deine Message-Dateien laufen und übergib das Ergebnis an createDialect. Bekannte Schlüssel werden nun vervollständigt, während jeder gewöhnliche String weiterhin kompiliert. Schlüssel, die erst zur Laufzeit existieren, etwa aus einer Datenbank, funktionieren also weiter. Die Kehrseite: Auch ein falsch geschriebener Schlüssel kompiliert, ihn findet svelte-dialect check (siehe unten).

import type { MessageKey } from './i18n-keys.js';

export const { t, loadTranslations } = createDialect<MessageKey>({ … });

Strikte Parameter #

Die generierte Datei exportiert außerdem MessageParams. Übergib es als zweites Generic, und die Parameter, die eine Nachricht nennt, werden Teil der Signatur von t — ein Aufruf, dem einer fehlt oder bei dem einer falsch geschrieben ist, ist nun ein Typfehler statt eines stillen Fallback-Texts zur Laufzeit.

import type { MessageKey, MessageParams } from './i18n-keys.js';

export const { t } = createDialect<MessageKey, MessageParams>({ … });

t('home:greeting', { name: 'Kat' }); // ✅
t('home:greeting'); // ✗ Expected 2 arguments, but got 1
t('home:greeting', { nmae: 'Kat' }); // ✗ 'nmae' does not exist
t('cms:hero'); // ✅ nothing is known about a runtime-only key, so anything goes

Beide Generics sind additiv: Lässt du eines weg, bleibt jeder Aufruf so permissiv wie zuvor.

Schlüssel aus einer Datenbank #

Typen sind eine Momentaufnahme dessen, was die Generierung gesehen hat. Für einen Katalog, der woanders liegt, exportierst du einen {locale: {namespace: {…}}}-Dump, richtest typegen --from-json darauf und generierst neu, sobald sich der Dump ändert.

npx svelte-dialect typegen --from-json dump.json --out src/lib/i18n-keys.d.ts

Die CLI #

Drei Befehle, ausschließlich über Flags statt über eine Konfigurationsdatei gesteuert. --messages darf bei allen dreien mehrfach angegeben werden, falls gebündelte und lazy Bäume getrennt liegen. Alle Flags und Exit-Codes stehen in der CLI-Referenz.

npx svelte-dialect typegen   # the .d.ts above
npx svelte-dialect check     # compare t('…') calls in code against the catalogs
npx svelte-dialect migrate   # convert i18next / ICU MessageFormat JSON to MF2, in place

check #

Durchsucht deinen Quellcode nach t('ns:key')-Literalen und meldet Schlüssel, die in einer Locale fehlen (Exit-Code 1, gehört also in die CI), sowie mit --unused Katalogschlüssel, auf die nichts verweist. Aus Variablen zusammengesetzte Schlüssel sind für einen statischen Scan unsichtbar, er berichtet also ehrlich über das, was er sehen kann.

migrate #

Schreibt i18next-Interpolationen im {{name}}-Stil um, fasst die Plural-Suffixe key_one/key_other zu einem MF2-.match zusammen und versteht die gängigen ICU-MessageFormat-Konstrukte. Jeder erzeugte String wird vor dem Schreiben mit dem echten MF2-Parser validiert; was sich nicht umwandeln lässt, bleibt unangetastet und wird gemeldet. Starte zuerst mit --dry-run, um die Vorher-Nachher-Paare zu sehen.