@intlify/unplugin-vue-i18n 0.9.1 → 0.9.3

package/README.md

@@ -277,9 +277,16 @@ This plugin will automatically select and bundle `petite-vue-i18n` build accordi
   - ts
   ```
 
-  Note `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.
+  If nothing is specified for this option, i.e. `undefined`, nothing is done to the resource in the above format.
+
+  > ⚠️ NOTE: 
+  `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.
+
+  > ⚠️ NOTE: 
+  `yaml` resources don't support multi documentation with `|`, alias with `&` and `*`, tags with `! `, `@`, etc. Only simple data structures.
 
-  Note that `js` and `ts` resources are limited to **simple export (`export default`) as locale messages object only**, such as programmatically dynamic resource construction is not guaranteed to work currently.
+  > ⚠️ NOTE: 
+  `js` and `ts` resources are set **simple export (`export default`) as locale messages object, as default**.
 
   ```js
   export default {
@@ -288,7 +295,31 @@ This plugin will automatically select and bundle `petite-vue-i18n` build accordi
   }
   ```
 
-  If nothing is specified for this option, i.e. `undefined`, nothing is done to the resource in the above format.
+  If you need to use programmatically dynamic resource construction, you would be enable `allowDynamic` option. about details, see the section.
+
+  > ⚠️ NOTE: 
+  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.
+
+### `allowDynamic`
+
+- **Type:** `boolean`
+- **Default:** `false`
+
+  Whether or not programmatically dynamic resource construction for `js` or `ts` resource format.
+
+  In this case, you need to export the function with `export default` and construct the resource with the function:
+
+  ```js
+  import resources from './locales/all.json'
+
+  export default async function loadResource(url) {
+    const res = await import(url).then(r => r.default || r)
+    return { ...resources, ...res }
+  }
+  ```
+
+  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).
+
 
 ### `runtimeOnly`
 

package/lib/index.cjs

@@ -135,6 +135,7 @@ const unplugin = unplugin$1.createUnplugin((options = {}, meta) => {
   const getVueI18nAliasPath = (aliasName) => vueI18nVersion === "8" ? `${aliasName}/dist/${aliasName}.esm.js` : `${aliasName}/dist/${installedPkg}.runtime.esm-bundler.js`;
   const esm = shared.isBoolean(options.esm) ? options.esm : true;
   debug("esm", esm);
+  const allowDynamic = !!options.allowDynamic;
   let isProduction = false;
   let sourceMap = false;
   const vueI18nAliasName = getVueI18nAliasName();
@@ -251,6 +252,7 @@ const unplugin = unplugin$1.createUnplugin((options = {}, meta) => {
                   inSourceMap,
                   isGlobal: globalSFCScope,
                   useClassComponent,
+                  allowDynamic,
                   bridge,
                   exportESM: esm,
                   forceStringify
@@ -410,6 +412,7 @@ const unplugin = unplugin$1.createUnplugin((options = {}, meta) => {
               inSourceMap,
               isGlobal: globalSFCScope,
               useClassComponent,
+              allowDynamic,
               bridge,
               exportESM: esm,
               forceStringify
@@ -583,7 +586,8 @@ function getOptions(filename, isProduction, query, sourceMap, {
   isGlobal = false,
   bridge = false,
   exportESM = true,
-  useClassComponent = false
+  useClassComponent = false,
+  allowDynamic = false
 }) {
   const mode = isProduction ? "production" : "development";
   const baseOptions = {
@@ -592,6 +596,7 @@ function getOptions(filename, isProduction, query, sourceMap, {
     inSourceMap,
     forceStringify,
     useClassComponent,
+    allowDynamic,
     bridge,
     exportESM,
     env: mode,

package/lib/index.mjs

@@ -131,6 +131,7 @@ const unplugin = createUnplugin((options = {}, meta) => {
   const getVueI18nAliasPath = (aliasName) => vueI18nVersion === "8" ? `${aliasName}/dist/${aliasName}.esm.js` : `${aliasName}/dist/${installedPkg}.runtime.esm-bundler.js`;
   const esm = isBoolean(options.esm) ? options.esm : true;
   debug("esm", esm);
+  const allowDynamic = !!options.allowDynamic;
   let isProduction = false;
   let sourceMap = false;
   const vueI18nAliasName = getVueI18nAliasName();
@@ -247,6 +248,7 @@ const unplugin = createUnplugin((options = {}, meta) => {
                   inSourceMap,
                   isGlobal: globalSFCScope,
                   useClassComponent,
+                  allowDynamic,
                   bridge,
                   exportESM: esm,
                   forceStringify
@@ -406,6 +408,7 @@ const unplugin = createUnplugin((options = {}, meta) => {
               inSourceMap,
               isGlobal: globalSFCScope,
               useClassComponent,
+              allowDynamic,
               bridge,
               exportESM: esm,
               forceStringify
@@ -579,7 +582,8 @@ function getOptions(filename, isProduction, query, sourceMap, {
   isGlobal = false,
   bridge = false,
   exportESM = true,
-  useClassComponent = false
+  useClassComponent = false,
+  allowDynamic = false
 }) {
   const mode = isProduction ? "production" : "development";
   const baseOptions = {
@@ -588,6 +592,7 @@ function getOptions(filename, isProduction, query, sourceMap, {
     inSourceMap,
     forceStringify,
     useClassComponent,
+    allowDynamic,
     bridge,
     exportESM,
     env: mode,

package/lib/types.d.ts

@@ -1,6 +1,7 @@
 type SFCLangFormat = 'json' | 'json5' | 'yml' | 'yaml';
 interface PluginOptions {
     include?: string | string[];
+    allowDynamic?: boolean;
     runtimeOnly?: boolean;
     compositionOnly?: boolean;
     fullInstall?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intlify/unplugin-vue-i18n",
-  "version": "0.9.1",
+  "version": "0.9.3",
   "description": "unplugin for Vue I18n",
   "author": {
     "name": "kazuya kawaguchi",
@@ -26,7 +26,7 @@
     }
   },
   "dependencies": {
-    "@intlify/bundle-utils": "^5.0.0",
+    "@intlify/bundle-utils": "^5.3.1",
     "@intlify/shared": "next",
     "@rollup/pluginutils": "^5.0.2",
     "@vue/compiler-sfc": "^3.2.47",