vite-plugin-i18n-ally

vite-plugin-i18n-ally

English | 中文

A vite plugin for lazy loading i18n resources

NOTE: This plugin is independent of the language framework. Whether you use React or Vue (or any other language), as long as it is vite, you can implement lazy loading of internationalization resources based on this plugin

Features

• Seamless development experience, no need to manually import resource files
• Lazy loading language resource files to reduce the size of the first screen resource
• Read the configuration items of i18n-ally by default, no additional configuration is required
• Support vite hmr out of the box

Install

pnpm add vite-plugin-i18n-ally -D

Online Demo

Demo

Options

If i18n.ally is configured, the plugin will read the configuration by default

Option	Type	Default	Description
localesPaths	string[]	i18n-ally.localesPaths || ['./src/locales', './locales']	The directory of language resources, relative to root
root	string	process.cwd()	The project root path
namespace	boolean	i18n-ally.namespace || false	Enable namespace
pathMatcher	string	auto detected by structure	Resource file matching rule
parserPlugins	ParserPlugin[]	[jsonParser, json5Parser, yamlParser]	Resource file parsing plugin
autoDetectI18nConfig	boolean | { stopAt: string }	true	Whether to automatically detect i18n-ally configuration, if stopAt is passed in, it will stop detecting in the specified directory

Config Reference

vite.config.ts

import path from 'node:path'
import { defineConfig } from 'vite'
import { i18nDetector } from 'vite-plugin-i18n-ally'

// https://vitejs.dev/config/
export default defineConfig({
  plugins: [
    i18nDetector({
      localesPaths: ['./src/locales'],
    }),
  ],
})

Use with React-i18next

main.tsx

import i18next from 'i18next'
import LanguageDetector from 'i18next-browser-languagedetector'
import React from 'react'
import ReactDOM from 'react-dom/client'
import { initReactI18next } from 'react-i18next'
import { setupI18n } from 'vite-plugin-i18n-ally/client'
import App from './App'

const root = ReactDOM.createRoot(document.querySelector('#root') as HTMLElement)

const lookupTarget = 'lang'
const fallbackLng = 'en'

i18next
  .use(LanguageDetector)
  .use(initReactI18next)
  .init({
    resources: {}, // !!! important: No resources are added at initialization, otherwise what's lazy loading :)
    nsSeparator: '.',
    fallbackLng,
    detection: {
      order: ['querystring', 'cookie', 'localStorage', 'sessionStorage', 'navigator'],
      caches: ['localStorage', 'sessionStorage', 'cookie'],
      lookupQuerystring: lookupTarget,
      // ... For more configurations, please refer to `i18next-browser-languagedetector`
    },
  })


const { loadResourceByLang } = setupI18n({
  language: i18next.language,
  onInited() {
    root.render(
      <React.StrictMode>
        <App />
      </React.StrictMode>,
    )
  },
  onResourceLoaded: (langs, currentLang) => { // Once the resource is loaded, add it to i18next
    Object.keys(langs).forEach((ns) => {
      i18next.addResourceBundle(currentLang, ns, langs[ns])
    })
  },
  fallbackLng,
  cache: {
    querystring: lookupTarget,
  },
})

const _changeLanguage = i18next.changeLanguage
i18next.changeLanguage = async (lang: string, ...args) => {
  // Load resources before language change
  await loadResourceByLang(lang)
  return _changeLanguage(lang, ...args)
}

Full Example

Please refer to i18next example

vscode i18n-ally configuration reference

.vscode => settings.json

{
  "i18n-ally.localesPaths": ["src/locales"],
  "i18n-ally.keystyle": "nested",
  "i18n-ally.enabledParsers": ["json"],
  "i18n-ally.enabledFrameworks": ["react", "i18next"],
  "i18n-ally.namespace": true,
  "i18n-ally.pathMatcher": "{locale}/{namespaces}.{ext}",
}

⚠️ Warm Tips

Built-in support for json / json5 / yaml / yml resource files, customizable plugin parsing language

Thanks

• i18n-ally
• vite

License

MIT

Changelog

3.0.0 (2024-03-19)

Performance Improvements

• enhance dts exports (dbc1c7a)