feat(unplugin-vue-i18n): support module option (#394)

Author: kazupon

packages/unplugin-vue-i18n/README.md

@@ -253,13 +253,6 @@ This plugin will automatically select and bundle Vue I18n build according to the
 
 About details, See the [here](https://vue-i18n.intlify.dev/guide/advanced/optimization.html#improve-performance-and-reduce-bundle-size-with-runtime-build-only)
 
-### For `petite-vue-i18n`
-
-This plugin will automatically select and bundle `petite-vue-i18n` build according to the following vite behavior:
-
-- vite dev: `petite-vue-i18n.esm-bundler.js`
-- vite build: `petite-vue-i18n.runtime.esm-bundler.js`
-
 
 ## 🔧 Options
 
@@ -302,6 +295,27 @@ This plugin will automatically select and bundle `petite-vue-i18n` build accordi
 > [!WARNING]
   If you use the `js` and `ts` resources formats, set the paths, so your application code is not targeted. We recommend that resources be isolated from the application code.
 
+### `module`
+
+- **Type:** `string`
+- **Default:** `'vue-i18n'`
+
+  > [!NOTE]
+  This options is supported from v5.1.0, and works with vue-i18n v10 and later.
+
+  Bundle target vue-i18n module. You can specify either `‘vue-i18n’` or `‘petite-vue-i18n’`.
+
+  The default is `'vue-i18n'`, and the following installed in node_modules will be bundled.
+
+  - development: `vue-i18n.esm-bundler.js`
+  - production: `vue-i18n.runtime.esm-bundler.js`
+
+  In the case of `‘petite-vue-i18n’`, the following installed in node_modules will be bundled.
+
+  - development: `petite-vue-i18n.esm-bundler.js`
+  - production: `petite-vue-i18n.runtime.esm-bundler.js`
+
+  If you are using petite-vue-i18n, you will need to set this value.
 
 ### `strictMessage`
 

packages/unplugin-vue-i18n/package.json

@@ -34,7 +34,6 @@
     "fast-glob": "^3.2.12",
     "js-yaml": "^4.1.0",
     "json5": "^2.2.3",
-    "mlly": "^1.7.1",
     "pathe": "^1.0.0",
     "picocolors": "^1.0.0",
     "source-map-js": "^1.0.2",

packages/unplugin-vue-i18n/src/core/options.ts

@@ -3,12 +3,10 @@ import { isString, isBoolean, isArray } from '@intlify/shared'
 
 import type { PluginOptions } from '../types'
 import type { TranslationDirectiveResolveIndetifier } from '../vue'
-import type { InstalledPackageInfo } from '../utils'
 
-export function resolveOptions(
-  options: PluginOptions,
-  installedPkgInfo: InstalledPackageInfo
-) {
+export function resolveOptions(options: PluginOptions) {
+  const moduleType = (options.module || 'vue-i18n') as string
+
   // normalize for `options.onlyLocales`
   let onlyLocales: string[] = []
   if (options.onlyLocales) {
@@ -43,14 +41,14 @@ export function resolveOptions(
   const dropMessageCompiler = !!options.dropMessageCompiler
 
   // prettier-ignore
-  const compositionOnly = installedPkgInfo.pkg === 'vue-i18n'
+  const compositionOnly = moduleType === 'vue-i18n'
       ? isBoolean(options.compositionOnly)
         ? options.compositionOnly
         : true
       : true
 
   // prettier-ignore
-  const fullInstall = installedPkgInfo.pkg === 'vue-i18n'
+  const fullInstall = moduleType === 'vue-i18n'
     ? isBoolean(options.fullInstall)
       ? options.fullInstall
       : true
@@ -85,6 +83,7 @@ export function resolveOptions(
   return {
     include,
     exclude,
+    module: moduleType,
     onlyLocales,
     forceStringify,
     defaultSFCLang,

packages/unplugin-vue-i18n/src/core/resource.ts

@@ -36,7 +36,6 @@ import type {
   TransformResult
 } from 'unplugin'
 import type { ResolvedOptions } from '../core/options'
-import type { InstalledPackageInfo } from '../utils'
 import type { VueQuery } from '../vue'
 import type { PluginOptions } from '../types'
 
@@ -50,6 +49,7 @@ export function resourcePlugin(
     onlyLocales,
     include,
     exclude,
+    module,
     forceStringify,
     defaultSFCLang,
     globalSFCScope,
@@ -63,18 +63,17 @@ export function resourcePlugin(
     escapeHtml,
     transformI18nBlock
   }: ResolvedOptions,
-  meta: UnpluginContextMeta,
-  installedPkgInfo: InstalledPackageInfo
+  meta: UnpluginContextMeta
 ): UnpluginOptions {
   const filter = createFilter(include, exclude)
   const getVueI18nAliasPath = ({ ssr = false, runtimeOnly = false }) => {
-    return `${installedPkgInfo.alias}/dist/${installedPkgInfo.pkg}${runtimeOnly ? '.runtime' : ''}.${
+    return `${module}/dist/${module}${runtimeOnly ? '.runtime' : ''}.${
       !ssr ? 'esm-bundler.js' /* '.mjs' */ : 'node.mjs'
     }`
   }
   let isProduction = false
   let sourceMap = false
-  const vueI18nAliasName = installedPkgInfo.alias
+  const vueI18nAliasName = module
   debug(`vue-i18n alias name: ${vueI18nAliasName}`)
 
   let vuePlugin: RollupPlugin | null = null

packages/unplugin-vue-i18n/src/index.ts

@@ -1,13 +1,12 @@
 import { createUnplugin } from 'unplugin'
 import createDebug from 'debug'
-import { raiseError, checkInstallPackage, resolveNamespace } from './utils'
+import { raiseError, resolveNamespace } from './utils'
 import { resolveOptions, resourcePlugin, directivePlugin } from './core'
 
 import type { UnpluginFactory, UnpluginInstance } from 'unplugin'
 import type { PluginOptions } from './types'
 
 const debug = createDebug(resolveNamespace('root'))
-const installedPkgInfo = checkInstallPackage(debug)
 
 export * from './types'
 
@@ -22,10 +21,10 @@ export const unpluginFactory: UnpluginFactory<PluginOptions | undefined> = (
   }
 
   debug('plugin options (resolving):', options)
-  const resolvedOptions = resolveOptions(options, installedPkgInfo)
+  const resolvedOptions = resolveOptions(options)
   debug('plugin options (resolved):', resolvedOptions)
 
-  const plugins = [resourcePlugin(resolvedOptions, meta, installedPkgInfo)]
+  const plugins = [resourcePlugin(resolvedOptions, meta)]
   if (resolvedOptions.optimizeTranslationDirective) {
     if (meta.framework === 'webpack') {
       raiseError(

packages/unplugin-vue-i18n/src/types.ts

@@ -1,8 +1,11 @@
 export type SFCLangFormat = 'json' | 'json5' | 'yml' | 'yaml'
+export type VueI18nModule = 'vue-i18n' | 'petite-vue-i18n'
+
 export interface PluginOptions {
   include?: string | string[]
   onlyLocales?: string | string[]
   allowDynamic?: boolean
+  module?: VueI18nModule
   dropMessageCompiler?: boolean
   runtimeOnly?: boolean
   compositionOnly?: boolean

packages/unplugin-vue-i18n/src/utils/index.ts

@@ -1,4 +1,2 @@
 export * from './log'
 export * from './plugin'
-export * from './resolver'
-export * from './pkg'