@intlify/unplugin-vue-i18n 6.0.4 → 6.0.5

package/README.md

@@ -280,17 +280,11 @@ About details, See the [here](https://vue-i18n.intlify.dev/guide/advanced/optimi
 
   If nothing is specified for this option, i.e. `undefined`, nothing is done to the resource in the above format.
 
-> [!WARNING]
->
-> `json` resources matches this option, it will be handled **before the internal json plugin of bundler, and will not be processed afterwards**, else the option doesn't match, the bundler side will handle.
+> [!WARNING] > `json` resources matches this option, it will be handled **before the internal json plugin of bundler, and will not be processed afterwards**, else the option doesn't match, the bundler side will handle.
 
-> [!WARNING]
->
-> `yaml` resources don't support multi documentation with `|`, alias with `&` and `*`, tags with `! `, `@`, etc. Only simple data structures.
+> [!WARNING] > `yaml` resources don't support multi documentation with `|`, alias with `&` and `*`, tags with `! `, `@`, etc. Only simple data structures.
 
-> [!WARNING]
->
-> `js` and `ts` resources are set **simple export (`export default`) as locale messages object, as default**.
+> [!WARNING] > `js` and `ts` resources are set **simple export (`export default`) as locale messages object, as default**.
 
 ```js
 export default {
@@ -309,22 +303,22 @@ If you need to use programmatically dynamic resource construction, you would be
 - **Type:** `string`
 - **Default:** `'vue-i18n'`
 
-> [!NOTE]
-> This options is supported from v5.1.0, and works with vue-i18n v10 and later.
+  > [!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’`.
+  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.
+  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`
+  - 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.
+  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`
+  - 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.
+  If you are using petite-vue-i18n, you will need to set this value.
 
 ### `strictMessage`
 
@@ -366,7 +360,7 @@ If you are using petite-vue-i18n, you will need to set this value.
   }
   ```
 
-  If you fetch some resources from the backend, the data **must be pre-compiled** for production. example is [here](https://github.com/intlify/vue-i18n-next/tree/master/examples/backend).
+  If you fetch some resources from the backend, the data **must be pre-compiled** for production. exmaple is [here](https://github.com/intlify/vue-i18n-next/tree/master/examples/backend).
 
 ### `jitCompilation`
 
@@ -374,15 +368,15 @@ If you are using petite-vue-i18n, you will need to set this value.
 - **Default:** `true`
 
 > [!IMPORTANT]
-> 'jitCompilation' option is deprecated in v5.
+> 'jitCompilation' option is deprected in v5.
 > This option will be supported with vue-i18n until v9 latest version.
 
-Whether locale messages should be compiled by JIT (Just in Time) compilation with vue-i18n's message compiler.
+Whether locale mesages should be compiled by JIT (Just in Time) compilation with vue-i18n's message compiler.
 
-JIT compilation has been supported since vue-i18n v9.3. This means that since v9 was released until now, the message compiler compiles to executable JavaScript code, however it did not work in the CSP environment. Also, since this was an AOT (Ahead of Time) compilation, it was not possible to dynamically retrieve locale messages from the back-end Database and compose locale messages with programatic.
+JIT compilation has been supported since vue-i18n v9.3. This means that since v9 was released until now, the message compiler compiles to executable JavaScript code, however it did not work in the CSP environment. Also, since this was an AOT (Ahead of Time) compilation, it was not possible to dynamically retrieve locale messages from the back-end Database and compose locale mesages with programatic.
 
 > [!WARNING]
-> Enabling JIT compilation causes the message compiler to generate AST objects for locale messages instead of JavaScript code. If you pre-compile locale messages with a tool such as the [Intlify CLI](https://github.com/intlify/cli) and import them dynamically, you need to rebuild that resource.
+> Enabling JIT compilation causes the message compiler to generate AST objects for locale mesages instead of JavaScript code. If you pre-compile locale messages with a tool such as the [Intlify CLI](https://github.com/intlify/cli) and import them dynamically, you need to rebuild that resource.
 
 About JIT compilation, See [here](https://vue-i18n.intlify.dev/guide/advanced/optimization.html#jit-compilation)
 
@@ -439,9 +433,6 @@ If do you will use this option, you need to enable `jitCompilation` option.
 
   For more details, See [here](https://vue-i18n.intlify.dev/guide/advanced/optimization.html#reduce-bundle-size-with-feature-build-flags)
 
-> [!CAUTION]
-> This option will be removed in v7
-
 ### `fullInstall`
 
 - **Type:** `boolean`
@@ -449,7 +440,7 @@ If do you will use this option, you need to enable `jitCompilation` option.
 
   Whether to install the full set of APIs, components, etc. provided by Vue I18n. By default, all of them will be installed.
 
-  If `false` is specified, **build-in components and directive will not be installed in vue and will be tree-shaken.**
+  If `false` is specified, **buld-in components and directive will not be installed in vue and will be tree-shaken.**
 
   For more details, See [here](https://vue-i18n.intlify.dev/guide/advanced/optimization.html#reduce-bundle-size-with-feature-build-flags)
 
@@ -606,10 +597,8 @@ If do you will use this option, you need to enable `jitCompilation` option.
 
   This option that to use i18n custom blocks in `vue-class-component`.
 
-> [!IMPORTANT]
->
-> `useClassComponent` option is deprecated in v5.
-> This option will be supported with vue-i18n until v9 latest version.
+  > [!IMPORTANT] > `useClassComponent` option is deprecated in v5.
+  > This option will be supported with vue-i18n until v9 latest version.
 
 ### `onlyLocales`
 
@@ -625,12 +614,10 @@ If do you will use this option, you need to enable `jitCompilation` option.
 
   Whether to use the import name of `petite-vue-i18n` with the same import name as vue-i18n (`import { xxx } from 'vue-i18n'`).
 
-  This option allows a smooth migration from `petite-vue-i18n` to `vue-i18n` and allows progressive enhancement.
+  This option allows a smooth migration from `petite-vue-i18n` to `vue-i18n` and allows progressive enhacement.
 
-> [!IMPORTANT]
->
-> `useVueI18nImportName` option is deprecated in v5.
-> This option will be supported with vue-i18n until v9 latest version.
+  > [!IMPORTANT] > `useVueI18nImportName` option is deprecated in v5.
+  > This option will be supported with vue-i18n until v9 latest version.
 
 ### `optimizeTranslationDirective`
 
@@ -641,8 +628,8 @@ If do you will use this option, you need to enable `jitCompilation` option.
 
   If you want to put it manually, you can specify the signature of the translation function as a string or a string array.
 
-> [!WARNING]
-> About for manually signature, see the details [vue-i18n-extensions API docs](https://github.com/intlify/vue-i18n-extensions/blob/next/docs/%40intlify/vue-i18n-extensions-api.md#translationsignatures) and [usecase from vue-i18n-extensions PR](https://github.com/intlify/vue-i18n-extensions/pull/217/files#diff-3fb9543f91e011d4b0dc9beff44082fe1a99c9eab70c1afab23c3c34352b7c38R121-R200)
+  > [!WARNING]
+  > About for manually signature, see the details [vue-i18n-extensions API docs](https://github.com/intlify/vue-i18n-extensions/blob/next/docs/%40intlify/vue-i18n-extensions-api.md#translationsignatures) and [usecase from vue-i18n-extensions PR](https://github.com/intlify/vue-i18n-extensions/pull/217/files#diff-3fb9543f91e011d4b0dc9beff44082fe1a99c9eab70c1afab23c3c34352b7c38R121-R200)
 
 ### `transformI18nBlock`
 
@@ -694,8 +681,8 @@ If do you will use this option, you need to enable `jitCompilation` option.
   </i18n>
   ```
 
-> [!IMPORTANT]
-> The function **must** return a string or the build will fail.
+  > [!IMPORTANT]
+  > The function **must** return a string or the build will fail.
 
 ## 📜 Changelog
 

package/lib/index.cjs

@@ -84,6 +84,7 @@ function resolveOptions(options) {
   const globalSFCScope = !!options.globalSFCScope;
   const runtimeOnly = shared.isBoolean(options.runtimeOnly) ? options.runtimeOnly : true;
   const dropMessageCompiler = !!options.dropMessageCompiler;
+  const compositionOnly = moduleType === "vue-i18n" ? shared.isBoolean(options.compositionOnly) ? options.compositionOnly : true : true;
   const fullInstall = moduleType === "vue-i18n" ? shared.isBoolean(options.fullInstall) ? options.fullInstall : true : false;
   const ssrBuild = !!options.ssr;
   const allowDynamic = !!options.allowDynamic;
@@ -102,6 +103,7 @@ function resolveOptions(options) {
     globalSFCScope,
     runtimeOnly,
     dropMessageCompiler,
+    compositionOnly,
     fullInstall,
     ssrBuild,
     allowDynamic,
@@ -191,6 +193,7 @@ function resourcePlugin({
   globalSFCScope,
   runtimeOnly,
   dropMessageCompiler,
+  compositionOnly,
   fullInstall,
   ssrBuild,
   strictMessage,
@@ -200,7 +203,7 @@ function resourcePlugin({
 }, meta) {
   const filter = pluginutils.createFilter(include, exclude);
   const getVueI18nAliasPath = ({ ssr = false, runtimeOnly: runtimeOnly2 = false }) => {
-    return `${module}/dist/${module}${runtimeOnly2 ? ".runtime" : ""}.${!ssr ? "esm-bundler.js" : "node.js"}`;
+    return `${module}/dist/${module}${runtimeOnly2 ? ".runtime" : ""}.${!ssr ? "esm-bundler.js" : "node.mjs"}`;
   };
   let isProduction = false;
   let sourceMap = false;
@@ -225,6 +228,7 @@ function resourcePlugin({
       config() {
         const defineConfig = {
           define: {
+            __VUE_I18N_LEGACY_API__: !compositionOnly,
             __VUE_I18N_FULL_INSTALL__: fullInstall,
             __INTLIFY_DROP_MESSAGE_COMPILER__: dropMessageCompiler,
             __VUE_I18N_PROD_DEVTOOLS__: false
@@ -352,10 +356,12 @@ function resourcePlugin({
         if (webpack) {
           compiler.options.plugins.push(
             new webpack.DefinePlugin({
+              __VUE_I18N_LEGACY_API__: JSON.stringify(compositionOnly),
               __VUE_I18N_FULL_INSTALL__: JSON.stringify(fullInstall),
               __INTLIFY_PROD_DEVTOOLS__: "false"
             })
           );
+          debug$2(`set __VUE_I18N_LEGACY_API__ is '${compositionOnly}'`);
           debug$2(`set __VUE_I18N_FULL_INSTALL__ is '${fullInstall}'`);
         } else {
           debug$2("ignore vue-i18n feature flags with webpack.DefinePlugin");

package/lib/index.mjs

@@ -72,6 +72,7 @@ function resolveOptions(options) {
   const globalSFCScope = !!options.globalSFCScope;
   const runtimeOnly = isBoolean(options.runtimeOnly) ? options.runtimeOnly : true;
   const dropMessageCompiler = !!options.dropMessageCompiler;
+  const compositionOnly = moduleType === "vue-i18n" ? isBoolean(options.compositionOnly) ? options.compositionOnly : true : true;
   const fullInstall = moduleType === "vue-i18n" ? isBoolean(options.fullInstall) ? options.fullInstall : true : false;
   const ssrBuild = !!options.ssr;
   const allowDynamic = !!options.allowDynamic;
@@ -90,6 +91,7 @@ function resolveOptions(options) {
     globalSFCScope,
     runtimeOnly,
     dropMessageCompiler,
+    compositionOnly,
     fullInstall,
     ssrBuild,
     allowDynamic,
@@ -179,6 +181,7 @@ function resourcePlugin({
   globalSFCScope,
   runtimeOnly,
   dropMessageCompiler,
+  compositionOnly,
   fullInstall,
   ssrBuild,
   strictMessage,
@@ -188,7 +191,7 @@ function resourcePlugin({
 }, meta) {
   const filter = createFilter(include, exclude);
   const getVueI18nAliasPath = ({ ssr = false, runtimeOnly: runtimeOnly2 = false }) => {
-    return `${module}/dist/${module}${runtimeOnly2 ? ".runtime" : ""}.${!ssr ? "esm-bundler.js" : "node.js"}`;
+    return `${module}/dist/${module}${runtimeOnly2 ? ".runtime" : ""}.${!ssr ? "esm-bundler.js" : "node.mjs"}`;
   };
   let isProduction = false;
   let sourceMap = false;
@@ -213,6 +216,7 @@ function resourcePlugin({
       config() {
         const defineConfig = {
           define: {
+            __VUE_I18N_LEGACY_API__: !compositionOnly,
             __VUE_I18N_FULL_INSTALL__: fullInstall,
             __INTLIFY_DROP_MESSAGE_COMPILER__: dropMessageCompiler,
             __VUE_I18N_PROD_DEVTOOLS__: false
@@ -340,10 +344,12 @@ function resourcePlugin({
         if (webpack) {
           compiler.options.plugins.push(
             new webpack.DefinePlugin({
+              __VUE_I18N_LEGACY_API__: JSON.stringify(compositionOnly),
               __VUE_I18N_FULL_INSTALL__: JSON.stringify(fullInstall),
               __INTLIFY_PROD_DEVTOOLS__: "false"
             })
           );
+          debug$2(`set __VUE_I18N_LEGACY_API__ is '${compositionOnly}'`);
           debug$2(`set __VUE_I18N_FULL_INSTALL__ is '${fullInstall}'`);
         } else {
           debug$2("ignore vue-i18n feature flags with webpack.DefinePlugin");

package/lib/types.d.cts

@@ -7,6 +7,7 @@ interface PluginOptions {
     module?: VueI18nModule;
     dropMessageCompiler?: boolean;
     runtimeOnly?: boolean;
+    compositionOnly?: boolean;
     ssr?: boolean;
     fullInstall?: boolean;
     forceStringify?: boolean;

package/lib/types.d.mts

@@ -7,6 +7,7 @@ interface PluginOptions {
     module?: VueI18nModule;
     dropMessageCompiler?: boolean;
     runtimeOnly?: boolean;
+    compositionOnly?: boolean;
     ssr?: boolean;
     fullInstall?: boolean;
     forceStringify?: boolean;

package/lib/types.d.ts

@@ -7,6 +7,7 @@ interface PluginOptions {
     module?: VueI18nModule;
     dropMessageCompiler?: boolean;
     runtimeOnly?: boolean;
+    compositionOnly?: boolean;
     ssr?: boolean;
     fullInstall?: boolean;
     forceStringify?: boolean;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@intlify/unplugin-vue-i18n",
   "type": "module",
-  "version": "6.0.4",
+  "version": "6.0.5",
   "description": "unplugin for Vue I18n",
   "author": {
     "name": "kazuya kawaguchi",