READ THIS FIRST!

This plugin is still in beta. Expect bugs!

vite-plugin-vue3-auto-i18n

Introdction

Auto import Vue-i18n in every vue sfc files and auto replace i18n words in vue sfc files.

• replace matched reactive string variable ref('xxx') with ref(t('xxx')) in both setup script and setup function.✅
• replace matched literal string 'xxx' with computed(()=>t('xxx')) in both setup script and setup function. ✅
• replace matched plain node value xxx with $t('xxx') in template. ❌

Installation

npm install -D vite-plugin-vue3-auto-i18n

First, make sure you have added vue-i18n in your project. For example:

import { createApp } from 'vue'
import { createI18n } from 'vue-i18n'
import App from './App.vue'

const messages = {
  en: {
    message: {
      hello: 'hello world',
      Hi: 'hi'
    },
  },
  ch: {
    message: {
      hello: '你好，世界',
      Hi: '嗨'
    },
  },
}

const i18n = createI18n({
  locale: 'ch', // set locale
  fallbackLocale: 'en', // set fallback locale
  messages, // set locale messages
})

createApp(App).use(i18n).mount('#app')

Then, add this plugin to your vite.config.js.

Load order: This plugin should come after vue plugin, if you use vite-plugin-vue-i18n, then this plugin should also come after it

import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import vueI18n from '@intlify/vite-plugin-vue-i18n' // if any
import autoI18n from 'vite-plugin-vue3-autoI18n'

export default defineConfig({
  plugins: [vue(), vueI18n(), autoI18n()],
})

Usage

write your code as usual, like:

<script setup lang="ts">
import { ref } from 'vue'
// ...
</scrip>

<template>
  <div>hello world</div>
</template>

Finally,this plugin will matches all the strings in the i18n configuration and replaces them automatically. For example,The above code will be converted to:

<script setup lang="ts">
import { ref } from 'vue'
import { useI18n } from 'vue-i18n'
const { t } = useI18n()

// ...
</script>

<template>
  <div>{{ $t('message.hello') }}</div>
</template>

License

MIT License © 2022 love-JS