@intlify/unplugin-vue-i18n 1.3.0 → 1.5.0

package/README.md

@@ -225,6 +225,8 @@ export default defineConfig({
   ],
 })
 ```
+unplugin-vue-i18n will automatically merge locale files into `@intlify/unplugin-vue-i18n/messages`. This allows locales to be split across multiple files, for example `src/locales/fruits/en.json` and `src/locales/vegetables/en.json`.
+
 ### Types
 
 If you want type definition of `@intlify/unplugin-vue-i18n/messages`, add `unplugin-vue-i18n/messages` to `compilerOptions.types` of your tsconfig:
@@ -377,6 +379,16 @@ This option works with vue-i18n v9.3 and later.
 > ⚠️ NOTE: 
 If you enable this option, **you should check  resources in your application are pre-compiled with this plugin.** If you will be loading resources dynamically from the back-end via the API, enabling this option do not work because there is not message compiler.
 
+### `ssr`
+
+- **Type:** `boolean`
+- **Default:** `false`
+
+  Whether to bundle vue-i18n module for SSR at build time
+
+  > ⚠️ NOTE: 
+  This option works with vue-i18n v9.4 and later.
+
 ### `runtimeOnly`
 
 - **Type:** `boolean`

package/lib/index.cjs

@@ -141,6 +141,8 @@ const unplugin = unplugin$1.createUnplugin((options = {}, meta) => {
   debug("compositionOnly", compositionOnly);
   const fullInstall = installedPkg === "vue-i18n" ? shared.isBoolean(options.fullInstall) ? options.fullInstall : true : false;
   debug("fullInstall", fullInstall);
+  const ssrBuild = !!options.ssr;
+  debug("ssr", ssrBuild);
   const useVueI18nImportName = options.useVueI18nImportName;
   if (useVueI18nImportName != null) {
     warn(`'useVueI18nImportName' option is experimental`);
@@ -148,7 +150,9 @@ const unplugin = unplugin$1.createUnplugin((options = {}, meta) => {
   debug("useVueI18nImportName", useVueI18nImportName);
   const getVueI18nAliasName = () => vueI18nVersion === "9" || vueI18nVersion === "8" ? "vue-i18n" : vueI18nVersion === "unknown" && installedPkg === "petite-vue-i18n" && shared.isBoolean(useVueI18nImportName) && useVueI18nImportName ? "vue-i18n" : installedPkg;
   const getVueI18nBridgeAliasPath = () => `vue-i18n-bridge/dist/vue-i18n-bridge.runtime.esm-bundler.js`;
-  const getVueI18nAliasPath = (aliasName) => vueI18nVersion === "8" ? `${aliasName}/dist/${aliasName}.esm.js` : `${aliasName}/dist/${installedPkg}.runtime.esm-bundler.js`;
+  const getVueI18nAliasPath = (aliasName, { ssr = false, runtimeOnly: runtimeOnly2 = false }) => {
+    return vueI18nVersion === "8" ? `${aliasName}/dist/${aliasName}.esm.js` : `${aliasName}/dist/${installedPkg}${runtimeOnly2 ? ".runtime" : ""}.${!ssr ? "esm-bundler.js" : "node.mjs"}`;
+  };
   const esm = shared.isBoolean(options.esm) ? options.esm : true;
   debug("esm", esm);
   const allowDynamic = !!options.allowDynamic;
@@ -177,12 +181,15 @@ const unplugin = unplugin$1.createUnplugin((options = {}, meta) => {
           config.resolve,
           meta.framework
         );
-        if (command === "build" && runtimeOnly) {
+        if (command === "build") {
           debug(`vue-i18n alias name: ${vueI18nAliasName}`);
           if (shared.isArray(config.resolve.alias)) {
             config.resolve.alias.push({
               find: vueI18nAliasName,
-              replacement: getVueI18nAliasPath(vueI18nAliasName)
+              replacement: getVueI18nAliasPath(vueI18nAliasName, {
+                ssr: ssrBuild,
+                runtimeOnly
+              })
             });
             if (installedVueI18nBridge) {
               config.resolve.alias.push({
@@ -191,14 +198,21 @@ const unplugin = unplugin$1.createUnplugin((options = {}, meta) => {
               });
             }
           } else if (shared.isObject(config.resolve.alias)) {
-            config.resolve.alias[vueI18nAliasName] = getVueI18nAliasPath(vueI18nAliasName);
+            config.resolve.alias[vueI18nAliasName] = getVueI18nAliasPath(vueI18nAliasName, {
+              ssr: ssrBuild,
+              runtimeOnly
+            });
             if (installedVueI18nBridge) {
               config.resolve.alias["vue-i18n-bridge"] = getVueI18nBridgeAliasPath();
             }
           }
           debug(
             `set ${vueI18nAliasName} runtime only: ${getVueI18nAliasPath(
-              vueI18nAliasName
+              vueI18nAliasName,
+              {
+                ssr: ssrBuild,
+                runtimeOnly
+              }
             )}`
           );
           if (installedVueI18nBridge) {
@@ -341,15 +355,19 @@ const unplugin = unplugin$1.createUnplugin((options = {}, meta) => {
         compiler.options.resolve,
         meta.framework
       );
-      if (isProduction && runtimeOnly) {
-        compiler.options.resolve.alias[vueI18nAliasName] = getVueI18nAliasPath(vueI18nAliasName);
+      if (isProduction) {
+        compiler.options.resolve.alias[vueI18nAliasName] = getVueI18nAliasPath(vueI18nAliasName, {
+          ssr: ssrBuild,
+          runtimeOnly
+        });
         if (installedVueI18nBridge) {
           compiler.options.resolve.alias["vue-i18n-bridge"] = getVueI18nBridgeAliasPath();
         }
         debug(
-          `set ${vueI18nAliasName} runtime only: ${getVueI18nAliasPath(
-            vueI18nAliasName
-          )}`
+          `set ${vueI18nAliasName}: ${getVueI18nAliasPath(vueI18nAliasName, {
+            ssr: ssrBuild,
+            runtimeOnly
+          })}`
         );
         if (installedVueI18nBridge) {
           debug(
@@ -611,10 +629,29 @@ async function generateBundleResources(resources, query, isProduction, {
       codes.push(`${JSON.stringify(name)}: ${code}`);
     }
   }
-  return `export default {
-  ${codes.join(`,
-`)}
-}`;
+  return `const isObject = (item) => item && typeof item === 'object' && !Array.isArray(item);
+
+const mergeDeep = (target, ...sources) => {
+  if (!sources.length) return target;
+  const source = sources.shift();
+
+  if (isObject(target) && isObject(source)) {
+    for (const key in source) {
+      if (isObject(source[key])) {
+        if (!target[key]) Object.assign(target, { [key]: {} });
+        mergeDeep(target[key], source[key]);
+      } else {
+        Object.assign(target, { [key]: source[key] });
+      }
+    }
+  }
+
+  return mergeDeep(target, ...sources);
+}
+
+export default mergeDeep({},
+  ${codes.map((code) => `{${code}}`).join(",\n")}
+);`;
 }
 async function getCode(source, filename, sourceMap, query, framework = "vite") {
   const { index, issuerPath } = query;

package/lib/index.mjs

@@ -129,6 +129,8 @@ const unplugin = createUnplugin((options = {}, meta) => {
   debug("compositionOnly", compositionOnly);
   const fullInstall = installedPkg === "vue-i18n" ? isBoolean(options.fullInstall) ? options.fullInstall : true : false;
   debug("fullInstall", fullInstall);
+  const ssrBuild = !!options.ssr;
+  debug("ssr", ssrBuild);
   const useVueI18nImportName = options.useVueI18nImportName;
   if (useVueI18nImportName != null) {
     warn(`'useVueI18nImportName' option is experimental`);
@@ -136,7 +138,9 @@ const unplugin = createUnplugin((options = {}, meta) => {
   debug("useVueI18nImportName", useVueI18nImportName);
   const getVueI18nAliasName = () => vueI18nVersion === "9" || vueI18nVersion === "8" ? "vue-i18n" : vueI18nVersion === "unknown" && installedPkg === "petite-vue-i18n" && isBoolean(useVueI18nImportName) && useVueI18nImportName ? "vue-i18n" : installedPkg;
   const getVueI18nBridgeAliasPath = () => `vue-i18n-bridge/dist/vue-i18n-bridge.runtime.esm-bundler.js`;
-  const getVueI18nAliasPath = (aliasName) => vueI18nVersion === "8" ? `${aliasName}/dist/${aliasName}.esm.js` : `${aliasName}/dist/${installedPkg}.runtime.esm-bundler.js`;
+  const getVueI18nAliasPath = (aliasName, { ssr = false, runtimeOnly: runtimeOnly2 = false }) => {
+    return vueI18nVersion === "8" ? `${aliasName}/dist/${aliasName}.esm.js` : `${aliasName}/dist/${installedPkg}${runtimeOnly2 ? ".runtime" : ""}.${!ssr ? "esm-bundler.js" : "node.mjs"}`;
+  };
   const esm = isBoolean(options.esm) ? options.esm : true;
   debug("esm", esm);
   const allowDynamic = !!options.allowDynamic;
@@ -165,12 +169,15 @@ const unplugin = createUnplugin((options = {}, meta) => {
           config.resolve,
           meta.framework
         );
-        if (command === "build" && runtimeOnly) {
+        if (command === "build") {
           debug(`vue-i18n alias name: ${vueI18nAliasName}`);
           if (isArray(config.resolve.alias)) {
             config.resolve.alias.push({
               find: vueI18nAliasName,
-              replacement: getVueI18nAliasPath(vueI18nAliasName)
+              replacement: getVueI18nAliasPath(vueI18nAliasName, {
+                ssr: ssrBuild,
+                runtimeOnly
+              })
             });
             if (installedVueI18nBridge) {
               config.resolve.alias.push({
@@ -179,14 +186,21 @@ const unplugin = createUnplugin((options = {}, meta) => {
               });
             }
           } else if (isObject(config.resolve.alias)) {
-            config.resolve.alias[vueI18nAliasName] = getVueI18nAliasPath(vueI18nAliasName);
+            config.resolve.alias[vueI18nAliasName] = getVueI18nAliasPath(vueI18nAliasName, {
+              ssr: ssrBuild,
+              runtimeOnly
+            });
             if (installedVueI18nBridge) {
               config.resolve.alias["vue-i18n-bridge"] = getVueI18nBridgeAliasPath();
             }
           }
           debug(
             `set ${vueI18nAliasName} runtime only: ${getVueI18nAliasPath(
-              vueI18nAliasName
+              vueI18nAliasName,
+              {
+                ssr: ssrBuild,
+                runtimeOnly
+              }
             )}`
           );
           if (installedVueI18nBridge) {
@@ -329,15 +343,19 @@ const unplugin = createUnplugin((options = {}, meta) => {
         compiler.options.resolve,
         meta.framework
       );
-      if (isProduction && runtimeOnly) {
-        compiler.options.resolve.alias[vueI18nAliasName] = getVueI18nAliasPath(vueI18nAliasName);
+      if (isProduction) {
+        compiler.options.resolve.alias[vueI18nAliasName] = getVueI18nAliasPath(vueI18nAliasName, {
+          ssr: ssrBuild,
+          runtimeOnly
+        });
         if (installedVueI18nBridge) {
           compiler.options.resolve.alias["vue-i18n-bridge"] = getVueI18nBridgeAliasPath();
         }
         debug(
-          `set ${vueI18nAliasName} runtime only: ${getVueI18nAliasPath(
-            vueI18nAliasName
-          )}`
+          `set ${vueI18nAliasName}: ${getVueI18nAliasPath(vueI18nAliasName, {
+            ssr: ssrBuild,
+            runtimeOnly
+          })}`
         );
         if (installedVueI18nBridge) {
           debug(
@@ -599,10 +617,29 @@ async function generateBundleResources(resources, query, isProduction, {
       codes.push(`${JSON.stringify(name)}: ${code}`);
     }
   }
-  return `export default {
-  ${codes.join(`,
-`)}
-}`;
+  return `const isObject = (item) => item && typeof item === 'object' && !Array.isArray(item);
+
+const mergeDeep = (target, ...sources) => {
+  if (!sources.length) return target;
+  const source = sources.shift();
+
+  if (isObject(target) && isObject(source)) {
+    for (const key in source) {
+      if (isObject(source[key])) {
+        if (!target[key]) Object.assign(target, { [key]: {} });
+        mergeDeep(target[key], source[key]);
+      } else {
+        Object.assign(target, { [key]: source[key] });
+      }
+    }
+  }
+
+  return mergeDeep(target, ...sources);
+}
+
+export default mergeDeep({},
+  ${codes.map((code) => `{${code}}`).join(",\n")}
+);`;
 }
 async function getCode(source, filename, sourceMap, query, framework = "vite") {
   const { index, issuerPath } = query;

package/lib/types.d.cts

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

package/lib/types.d.mts

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

package/lib/types.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intlify/unplugin-vue-i18n",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "description": "unplugin for Vue I18n",
   "author": {
     "name": "kazuya kawaguchi",