https://github.com/PengBoUESTC/vite-plugin-i18n-autoimport

https://github.com/PengBoUESTC/vite-plugin-i18n-autoimport

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/PengBoUESTC/vite-plugin-i18n-autoimport
• Owner: PengBoUESTC
• License: mit
• Created: 2023-07-14T04:42:10.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2023-09-11T08:52:40.000Z (about 1 year ago)
• Last Synced: 2024-07-01T14:19:11.883Z (3 months ago)
• Language: TypeScript
• Size: 28.3 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• fucking-awesome-vite - v3 - Auto import i18n config file for components. (Plugins / Vue)
• awesome-vite - v3 - Auto import i18n config file for components. (Plugins / Vue)

README

        
# vite-plugin-i18n-autoimport

## plugin options

```javascript

type includeFilter = (id: string) => boolean;

export interface Options {

    locales: string[];  // i18n locale list

    dts?: string; // .d.ts file position, should include in tsconfig.json's include option; default i18n.d.sts

    root?: string; // default cwd()

    include?: FilterPattern | includeFilter;  // filter

    exclude?: FilterPattern;

    getLocaleFs?: (locale: string) => string;  // get the locale config based on the locale value in locales

    genImportName?: (locale: string) => string; // generate the import name of locale config file based on the locale value in locales

}

```

## use plugin in vite

```javascript

import { autoImport } from 'vite-plugin-i18n-autoimport'

const LOCALE_ENUM = {

    zhCn: "zh-CN",

    zhHant: "zh-Hant"

}

export default defineConfig(() => {

  return {

    plugins: [

      autoImport({

        locales: [LOCALE_ENUM.zhCn, LOCALE_ENUM.zhHant],

        dts: './i18ntest.d.ts'

      }),

    ]

  }

})

```

## use in composition API 

```javascript

const { t } = defineI18n()

// compile to

import { useI18n } from 'vue-i18n'

// './lang/zh-CN.json' is generated by [ getLocaleFs ]

// 'zh_CN'  is generated by [ genImportName ]

import zh_CN from './lang/zh-CN.json';

import zh_Hant from './lang/zh-Hant.json';

const { t } = useI18n({

    messages: {

        ['zh_CN']: zh_CN,

        ['zh_Hant']: zh_Hant,

    }

})

```