Справочник
Архитектура
vue-i18n-kit
│
├── plugin.ts
│ createVueI18nPlugin() — устанавливает vue-i18n (через createI18n.ts), предзагружает
│ defaultLocale/fallbackLocale, хранит I18nService через app.provide();
│ возвращает Plugin & { service }
│
├── createI18n.ts
│ Внутренняя обёртка над собственным createI18n() из vue-i18n — не публичный экспорт
│
├── state.ts
│ Состояние на приложение через provide/inject — Ref locale, Ref isLoading, availableLocales,
│ список подписчиков, кэш сообщений; безопасно для SSR (без синглтонов на уровне модуля)
│
├── config/
│ schema.ts — I18nKitConfig, I18nKitRules, I18nKitIgnore, LocaleConfig, LocaleMeta
│ index.ts — findConfigPath / readConfig / writeConfig (только Node.js; используется
│ CLI и сервером редактора, не входит в браузерный бандл)
│
├── composables/
│ useLocale() — locale, setLocale, isLoading, localeMeta
│ useT() — поиск ключа t() + интерполяция; tm() ICU-плюрализация
│ useAvailableLocales() — вычисляемый список { code, meta } из зарегистрированных локалей
│ useFormat() — formatDate / formatNumber / formatCurrency через Intl
│ usePluralize() — движок Intl.PluralRules, питающий tm(); экспортирует pluralCategory()
│ useNamespace() — лениво загружает namespace для активной локали, знает об SSR
│
├── utils/
│ loadLocale.ts — разрешает синхронные объекты и асинхронные загрузчики; кэширует по коду локали
│ persistLocale.ts — хелперы чтения/записи localStorage (try/catch для SSR/приватного режима)
│ localeKeys.ts — flattenKeys, compareLocales (общие для CLI + Vite-плагина)
│ localeEntry.ts — isLocaleDefinition, extractMessages, extractMeta
│ scanner.ts — сканирование исходников на использование t()/tm()/$t() (CLI + редактор)
│ sort.ts — алфавитная сортировка ключей, общая для merge/split/merge-ns
│
├── vite-plugin/
│ vueI18nCheckPlugin — сравнение ключей при buildStart + HMR с референсной локалью
│ vueI18nInlinePlugin — virtual:vue-i18n-kit/locales (встраивает JSON в бандл)
│ vueI18nNamespacePlugin — virtual:vue-i18n-namespaces (динамические импорты по неймспейсам)
│ vueI18nDevPlugin — переписывание шаблонов SFC (автообёртка); внедряет сборку dev-overlay/
│ vueI18nMapPlugin — карта локалей для сервера редактора (пишется через init/auto-config)
│
│ dev-overlay/ (собран заранее, внедряется vueI18nDevPlugin во время разработки)
│ DevOverlay.vue, I18nInspect.vue — плавающий оверлей редактора + попап проверки
│ directive.ts — v-i18n-inspect
│ eventBus.ts — шина сообщений между оверлеем и приложением-хостом
│
├── ui-app/ — SPA редактора локалей на Vue (собирается в dist/ui-server/public/)
│ App.vue, LocaleTable.vue, Dashboard.vue, api.ts
│
├── ui-server/
│ server.ts — HTTP-сервер Node.js; читает/пишет JSON локали; SSE для живой перезагрузки
│
└── cli/
init / dev / ui / auto-config / add / check / merge / prune / types
split / merge-ns / stale / export / import / statsРазмер бандла и peer-зависимости
| Точка входа | Peer-зависимости | Примечания |
|---|---|---|
vue-i18n-kit | vue ^3.3, vue-i18n ^11.0 | Runtime composables и плагин — для приложений Vue |
vue-i18n-kit/vite | vue ^3.3, vite >=5.0 (опционально) | Плагины Vite — для vite.config.ts |
vue-i18n-kit/config | — | Только типы: I18nKitConfig, LocaleConfig, LocaleMeta, I18nKitRules, I18nKitIgnore |
vue-i18n-kit (bin) | — | CLI — init, add, check, ui, dev и другое |
Пакет поставляется как tree-shakeable ESM (dist/index.mjs) и CommonJS (dist/index.js). Неиспользуемые composables удаляются tree-shaking'ом. Vite-плагины и CLI не входят в браузерный бандл.
Разработка
bash
# Установить зависимости
npm install
# Сборка (ESM + CJS + декларации типов)
npm run build
# Запустить тесты
npm test
# Режим наблюдения
npm run test:watch
# Проверка типов
npm run typecheckТесты написаны с использованием Vitest и @vue/test-utils. Тестовый набор покрывает плагин, все composables, движок ICU, утилиты ключей локали и логику разграничения LocaleEntry.
Лицензия
MIT