@intlify/unplugin-vue-i18n 0.9.3 → 0.10.1

package/README.md

@@ -213,7 +213,7 @@ const app = createApp()
 app.use(i18n).mount('#app')
 ```
 
-Change your vite.config.ts file accordingly to import all the files from locales folder on the root. Change `'./locales/**'` to path of your locales.
+Change your vite.config.ts file accordingly to import all the files from locales folder on the root. Change `'./src/locales/**'` to path of your locales.
 ```ts
 // vite.config.ts
 import VueI18nPlugin from '@intlify/unplugin-vue-i18n/vite'
@@ -222,7 +222,7 @@ import path from 'path'
 export default defineConfig({
   plugins: [
     VueI18nPlugin({
-      include: [path.resolve(__dirname, './locales/**')],
+      include: [path.resolve(__dirname, './src/locales/**')],
     }),
   ],
 })
@@ -300,6 +300,31 @@ This plugin will automatically select and bundle `petite-vue-i18n` build accordi
   > ⚠️ 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.
 
+
+### `strictMessage`
+
+- **Type:** `boolean`
+- **Default:** `true`
+
+  Strictly checks that the locale message does not contain html tags.
+
+  If html tags are included, an error is thrown.
+
+  If you would not the error to be thrown, you can work around it by setting it to `false`, but **it means that the locale message might cause security problems with XSS**.
+
+  In that case, we recommend setting the `escapeHtml` option to `true`.
+
+
+### `escapeHtml`
+
+- **Type:** `boolean`
+- **Default:** `false`
+
+  Whether to escape html tags if they are included in the locale message.
+
+  If `strictMessage` is disabled by `false`, we recommend this option be enabled.
+
+
 ### `allowDynamic`
 
 - **Type:** `boolean`

package/lib/index.cjs

@@ -136,11 +136,24 @@ const unplugin = unplugin$1.createUnplugin((options = {}, meta) => {
   const esm = shared.isBoolean(options.esm) ? options.esm : true;
   debug("esm", esm);
   const allowDynamic = !!options.allowDynamic;
+  debug("allowDynamic", allowDynamic);
+  const strictMessage = shared.isBoolean(options.strictMessage) ? options.strictMessage : true;
+  debug("strictMessage", strictMessage);
+  const escapeHtml = !!options.escapeHtml;
+  debug("escapeHtml", escapeHtml);
   let isProduction = false;
   let sourceMap = false;
   const vueI18nAliasName = getVueI18nAliasName();
   return {
     name: "unplugin-vue-i18n",
+    /**
+     * NOTE:
+     *
+     * For vite, If we have json (including SFC's custom block),
+     * transform it first because it will be transformed into javascript code by `vite:json` plugin.
+     *
+     * For webpack, This plugin will handle with ‘post’, because vue-loader generate the request query.
+     */
     enforce: meta.framework === "vite" ? "pre" : "post",
     vite: {
       config(config, { command }) {
@@ -253,6 +266,8 @@ const unplugin = unplugin$1.createUnplugin((options = {}, meta) => {
                   isGlobal: globalSFCScope,
                   useClassComponent,
                   allowDynamic,
+                  strictMessage,
+                  escapeHtml,
                   bridge,
                   exportESM: esm,
                   forceStringify
@@ -271,6 +286,7 @@ const unplugin = unplugin$1.createUnplugin((options = {}, meta) => {
               return {
                 code: generatedCode,
                 map: sourceMap ? map : { mappings: "" }
+                // eslint-disable-line @typescript-eslint/no-explicit-any
               };
             } else {
               return result;
@@ -354,6 +370,7 @@ const unplugin = unplugin$1.createUnplugin((options = {}, meta) => {
         return asVirtualId(id, meta.framework);
       }
     },
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     async load(id) {
       debug("load", id);
       const { query } = parseVueRequest(id);
@@ -375,6 +392,8 @@ const unplugin = unplugin$1.createUnplugin((options = {}, meta) => {
           {
             forceStringify,
             bridge,
+            strictMessage,
+            escapeHtml,
             exportESM: esm,
             useClassComponent
           }
@@ -413,6 +432,8 @@ const unplugin = unplugin$1.createUnplugin((options = {}, meta) => {
               isGlobal: globalSFCScope,
               useClassComponent,
               allowDynamic,
+              strictMessage,
+              escapeHtml,
               bridge,
               exportESM: esm,
               forceStringify
@@ -431,6 +452,7 @@ const unplugin = unplugin$1.createUnplugin((options = {}, meta) => {
           return {
             code: generatedCode,
             map: sourceMap ? map : { mappings: "" }
+            // eslint-disable-line @typescript-eslint/no-explicit-any
           };
         }
       } else {
@@ -452,6 +474,8 @@ const unplugin = unplugin$1.createUnplugin((options = {}, meta) => {
               isGlobal: globalSFCScope,
               useClassComponent,
               bridge,
+              strictMessage,
+              escapeHtml,
               exportESM: esm,
               forceStringify
             }
@@ -476,6 +500,7 @@ const unplugin = unplugin$1.createUnplugin((options = {}, meta) => {
           return {
             code: generatedCode,
             map: sourceMap ? map : { mappings: "" }
+            // eslint-disable-line @typescript-eslint/no-explicit-any
           };
         }
       }
@@ -519,6 +544,8 @@ async function generateBundleResources(resources, query, isProduction, {
   isGlobal = false,
   bridge = false,
   exportESM = true,
+  strictMessage = true,
+  escapeHtml = false,
   useClassComponent = false
 }) {
   const codes = [];
@@ -533,6 +560,8 @@ async function generateBundleResources(resources, query, isProduction, {
         useClassComponent,
         bridge,
         exportESM,
+        strictMessage,
+        escapeHtml,
         forceStringify
       });
       parseOptions.type = "bare";
@@ -578,7 +607,9 @@ async function getCode(source, filename, sourceMap, query, framework = "vite") {
   }
 }
 function isCustomBlock(query) {
-  return !shared.isEmptyObject(query) && "vue" in query && (query["type"] === "custom" || query["type"] === "i18n" || query["blockType"] === "i18n");
+  return !shared.isEmptyObject(query) && "vue" in query && (query["type"] === "custom" || // for vite (@vite-plugin-vue)
+  query["type"] === "i18n" || // for webpack (vue-loader)
+  query["blockType"] === "i18n");
 }
 function getOptions(filename, isProduction, query, sourceMap, {
   inSourceMap = void 0,
@@ -587,7 +618,9 @@ function getOptions(filename, isProduction, query, sourceMap, {
   bridge = false,
   exportESM = true,
   useClassComponent = false,
-  allowDynamic = false
+  allowDynamic = false,
+  strictMessage = true,
+  escapeHtml = false
 }) {
   const mode = isProduction ? "production" : "development";
   const baseOptions = {
@@ -597,6 +630,8 @@ function getOptions(filename, isProduction, query, sourceMap, {
     forceStringify,
     useClassComponent,
     allowDynamic,
+    strictMessage,
+    escapeHtml,
     bridge,
     exportESM,
     env: mode,

package/lib/index.d.ts

@@ -1,7 +1,7 @@
 import * as _unplugin from 'unplugin';
 import { PluginOptions } from './types.js';
-export { PluginOptions, SFCLangFormat } from './types.js';
+export { SFCLangFormat } from './types.js';
 
 declare const unplugin: _unplugin.UnpluginInstance<PluginOptions, boolean>;
 
-export { unplugin as default, unplugin };
+export { PluginOptions, unplugin as default, unplugin };

package/lib/index.mjs

@@ -132,11 +132,24 @@ const unplugin = createUnplugin((options = {}, meta) => {
   const esm = isBoolean(options.esm) ? options.esm : true;
   debug("esm", esm);
   const allowDynamic = !!options.allowDynamic;
+  debug("allowDynamic", allowDynamic);
+  const strictMessage = isBoolean(options.strictMessage) ? options.strictMessage : true;
+  debug("strictMessage", strictMessage);
+  const escapeHtml = !!options.escapeHtml;
+  debug("escapeHtml", escapeHtml);
   let isProduction = false;
   let sourceMap = false;
   const vueI18nAliasName = getVueI18nAliasName();
   return {
     name: "unplugin-vue-i18n",
+    /**
+     * NOTE:
+     *
+     * For vite, If we have json (including SFC's custom block),
+     * transform it first because it will be transformed into javascript code by `vite:json` plugin.
+     *
+     * For webpack, This plugin will handle with ‘post’, because vue-loader generate the request query.
+     */
     enforce: meta.framework === "vite" ? "pre" : "post",
     vite: {
       config(config, { command }) {
@@ -249,6 +262,8 @@ const unplugin = createUnplugin((options = {}, meta) => {
                   isGlobal: globalSFCScope,
                   useClassComponent,
                   allowDynamic,
+                  strictMessage,
+                  escapeHtml,
                   bridge,
                   exportESM: esm,
                   forceStringify
@@ -267,6 +282,7 @@ const unplugin = createUnplugin((options = {}, meta) => {
               return {
                 code: generatedCode,
                 map: sourceMap ? map : { mappings: "" }
+                // eslint-disable-line @typescript-eslint/no-explicit-any
               };
             } else {
               return result;
@@ -350,6 +366,7 @@ const unplugin = createUnplugin((options = {}, meta) => {
         return asVirtualId(id, meta.framework);
       }
     },
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     async load(id) {
       debug("load", id);
       const { query } = parseVueRequest(id);
@@ -371,6 +388,8 @@ const unplugin = createUnplugin((options = {}, meta) => {
           {
             forceStringify,
             bridge,
+            strictMessage,
+            escapeHtml,
             exportESM: esm,
             useClassComponent
           }
@@ -409,6 +428,8 @@ const unplugin = createUnplugin((options = {}, meta) => {
               isGlobal: globalSFCScope,
               useClassComponent,
               allowDynamic,
+              strictMessage,
+              escapeHtml,
               bridge,
               exportESM: esm,
               forceStringify
@@ -427,6 +448,7 @@ const unplugin = createUnplugin((options = {}, meta) => {
           return {
             code: generatedCode,
             map: sourceMap ? map : { mappings: "" }
+            // eslint-disable-line @typescript-eslint/no-explicit-any
           };
         }
       } else {
@@ -448,6 +470,8 @@ const unplugin = createUnplugin((options = {}, meta) => {
               isGlobal: globalSFCScope,
               useClassComponent,
               bridge,
+              strictMessage,
+              escapeHtml,
               exportESM: esm,
               forceStringify
             }
@@ -472,6 +496,7 @@ const unplugin = createUnplugin((options = {}, meta) => {
           return {
             code: generatedCode,
             map: sourceMap ? map : { mappings: "" }
+            // eslint-disable-line @typescript-eslint/no-explicit-any
           };
         }
       }
@@ -515,6 +540,8 @@ async function generateBundleResources(resources, query, isProduction, {
   isGlobal = false,
   bridge = false,
   exportESM = true,
+  strictMessage = true,
+  escapeHtml = false,
   useClassComponent = false
 }) {
   const codes = [];
@@ -529,6 +556,8 @@ async function generateBundleResources(resources, query, isProduction, {
         useClassComponent,
         bridge,
         exportESM,
+        strictMessage,
+        escapeHtml,
         forceStringify
       });
       parseOptions.type = "bare";
@@ -574,7 +603,9 @@ async function getCode(source, filename, sourceMap, query, framework = "vite") {
   }
 }
 function isCustomBlock(query) {
-  return !isEmptyObject(query) && "vue" in query && (query["type"] === "custom" || query["type"] === "i18n" || query["blockType"] === "i18n");
+  return !isEmptyObject(query) && "vue" in query && (query["type"] === "custom" || // for vite (@vite-plugin-vue)
+  query["type"] === "i18n" || // for webpack (vue-loader)
+  query["blockType"] === "i18n");
 }
 function getOptions(filename, isProduction, query, sourceMap, {
   inSourceMap = void 0,
@@ -583,7 +614,9 @@ function getOptions(filename, isProduction, query, sourceMap, {
   bridge = false,
   exportESM = true,
   useClassComponent = false,
-  allowDynamic = false
+  allowDynamic = false,
+  strictMessage = true,
+  escapeHtml = false
 }) {
   const mode = isProduction ? "production" : "development";
   const baseOptions = {
@@ -593,6 +626,8 @@ function getOptions(filename, isProduction, query, sourceMap, {
     forceStringify,
     useClassComponent,
     allowDynamic,
+    strictMessage,
+    escapeHtml,
     bridge,
     exportESM,
     env: mode,

package/lib/types.d.ts

@@ -12,6 +12,8 @@ interface PluginOptions {
     bridge?: boolean;
     useClassComponent?: boolean;
     useVueI18nImportName?: boolean;
+    strictMessage?: boolean;
+    escapeHtml?: boolean;
 }
 
 export { PluginOptions, SFCLangFormat };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intlify/unplugin-vue-i18n",
-  "version": "0.9.3",
+  "version": "0.10.1",
   "description": "unplugin for Vue I18n",
   "author": {
     "name": "kazuya kawaguchi",
@@ -26,8 +26,8 @@
     }
   },
   "dependencies": {
-    "@intlify/bundle-utils": "^5.3.1",
-    "@intlify/shared": "next",
+    "@intlify/bundle-utils": "^5.4.0",
+    "@intlify/shared": "9.3.0-beta.17",
     "@rollup/pluginutils": "^5.0.2",
     "@vue/compiler-sfc": "^3.2.47",
     "debug": "^4.3.3",
@@ -40,8 +40,7 @@
     "unplugin": "^1.1.0"
   },
   "devDependencies": {
-    "mlly": "^1.0.0",
-    "unbuild": "^1.0.2"
+    "unbuild": "^1.1.2"
   },
   "engines": {
     "node": ">= 14.16"
@@ -67,19 +66,19 @@
   "types": "./index.d.ts",
   "exports": {
     ".": {
+      "types": "./index.d.ts",
       "require": "./lib/index.cjs",
-      "import": "./lib/index.mjs",
-      "types": "./index.d.ts"
+      "import": "./lib/index.mjs"
     },
     "./vite": {
+      "types": "./vite.d.ts",
       "require": "./lib/vite.cjs",
-      "import": "./lib/vite.mjs",
-      "types": "./vite.d.ts"
+      "import": "./lib/vite.mjs"
     },
     "./webpack": {
+      "types": "./webpack.d.ts",
       "require": "./lib/webpack.cjs",
-      "import": "./lib/webpack.mjs",
-      "types": "./webpack.d.ts"
+      "import": "./lib/webpack.mjs"
     },
     "./types": {
       "types": "./types.d.ts"