@dokebi/i18n
v0.2.8
Published
Compiled translation catalogs, locale negotiation, cardinal plurals and named Intl formats.
Maintainers
Readme
@dokebi/i18n
Application-owned translations with immutable locale views, compiled named placeholders, cardinal plurals, language negotiation and reusable Intl number/date formats. Optional; no web dependency or automatic request hooks.
Install with npx dokebi add @dokebi/i18n in a Dokebi project. Edit src/infra/i18n/extension.ts; it starts with an English catalog. Configure options.dokebi-i18n.defaultLocale in private dokebi.yaml when changing the default.
See AI.md for the complete API, message syntax, limits and error handling. Node >=24.0.0 and core ^0.4.0 are required. This is a plain-text message format, not full ICU MessageFormat or a translation service.
Store translations by language and namespace, for example src/shared/locales/en/auth.json and ko/auth.json. The generated entry discovers these files with loadCatalogs from @dokebi/i18n/catalogs. Nested JSON keys resolve as auth.password.minimum. Use translator.t(key, defaultValue, parameters?) for an explicit fallback, or t(key, parameters?) for the configured locale fallback chain.
Optional HTTP integration
Set options.dokebi-i18n.http.enabled: true with web installed. Use request.i18n.t('auth.password.minimum', 'At least eight characters'); the plugin selects the language, attaches the immutable translator, supplies the page locale and manages language response headers. Application code does not need a shared/i18n/server.ts hook. The server provider remains usable without HTTP.
Vue pages
With HTTP integration on, every page also gets the prop i18n: the messages of its namespaces (http.pageMessages, default all; pageMessages(request, 'posts') adds one for a route), sent once per browser: Inertia visits name the bundles the page holds, and the browser keeps them between page loads (http.pageCache, a cookie of content hashes), so a reload's HTML leaves them out (D-0126). Inertia apps made by dokebi app add --inertia install the browser runtime of @dokebi/template-inertia/i18n in views/app.js and views/ssr.js; pages call useI18n() for t, n, d and switchLocale with the same rules as the server. See AI.md.
Catalogs are shared application resources at src/shared/locales/<language>/<namespace>.json. Use CLI 0.4.6 or newer. Existing legacy catalog folders and edited entries are preserved during upgrades; follow the migration instructions before removing them.
