@intlify/unplugin-vue-i18n 5.0.0-beta.3 → 5.0.0-beta.5

package/README.md

@@ -583,6 +583,53 @@ If do you will use this option, you need to enable `jitCompilation` option.
   > [!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`
+
+- **Type**: `function`
+- **Default:** `undefined`
+
+  This hook allows a user to modify the `<i18n>` block before the plugin generates the translations. The hook is passed the source of the `<ii8n>` block as a `string` after the SFC is read from disk.
+
+  **Plugin**
+  ```javascript
+  function transformI18nBlock(source) {
+    // transformation logic
+  }
+
+  // Plugin
+  vueI18n({
+    transformI18nBlock
+  })
+  ```
+
+  **Before**
+  ```html
+  <i18n>
+  [
+      'slug-one',
+      'slug-two'
+  ]
+  <i18n>
+  ```
+
+  **After**
+  ```html
+  <i18n>
+  {
+      'en': {
+        'slug-one': 'foo',
+        'slug-two': 'bar'
+      },
+      ja: {
+        'slug-one': 'foo',
+        'slug-two': 'bar'
+      }
+  }
+  </i18n>
+  ```
+  > [!IMPORTANT]
+  The function **must** return a string or the build will fail.
+
 ## 📜 Changelog
 
 Details changes for each release are documented in the [CHANGELOG.md](https://github.com/intlify/bundle-tools/blob/main/packages/unplugin-vue-i18n/CHANGELOG.md)

package/lib/index.cjs

@@ -182,6 +182,7 @@ function resolveOptions(options, installedPkgInfo) {
   const escapeHtml = !!options.escapeHtml;
   const optimizeTranslationDirective = shared.isString(options.optimizeTranslationDirective) || shared.isArray(options.optimizeTranslationDirective) ? options.optimizeTranslationDirective : !!options.optimizeTranslationDirective;
   const translationIdentifiers = /* @__PURE__ */ new Map();
+  const transformI18nBlock = typeof options.transformI18nBlock === "function" ? options.transformI18nBlock : null;
   return {
     include,
     exclude,
@@ -198,7 +199,8 @@ function resolveOptions(options, installedPkgInfo) {
     strictMessage,
     escapeHtml,
     optimizeTranslationDirective,
-    translationIdentifiers
+    translationIdentifiers,
+    transformI18nBlock
   };
 }
 
@@ -284,7 +286,8 @@ function resourcePlugin({
   ssrBuild,
   strictMessage,
   allowDynamic,
-  escapeHtml
+  escapeHtml,
+  transformI18nBlock
 }, meta, installedPkgInfo) {
   const filter = pluginutils.createFilter(include, exclude);
   const getVueI18nAliasPath = ({ ssr = false, runtimeOnly: runtimeOnly2 = false }) => {
@@ -566,7 +569,7 @@ function resourcePlugin({
             }
           );
           debug$2("parseOptions", parseOptions);
-          const source = await getCode(
+          let source = await getCode(
             code,
             filename,
             sourceMap,
@@ -574,6 +577,14 @@ function resourcePlugin({
             getSfcParser(),
             meta.framework
           );
+          if (typeof transformI18nBlock === "function") {
+            const modifiedSource = transformI18nBlock(source);
+            if (modifiedSource && typeof modifiedSource === "string") {
+              source = modifiedSource;
+            } else {
+              warn("transformI18nBlock should return a string");
+            }
+          }
           const { code: generatedCode, map } = generate(source, parseOptions);
           debug$2("generated code", generatedCode);
           debug$2("sourcemap", map, sourceMap);
@@ -627,7 +638,8 @@ async function generateBundleResources(resources, isProduction, {
   onlyLocales = [],
   strictMessage = true,
   escapeHtml = false,
-  jit = true
+  jit = true,
+  transformI18nBlock = void 0
 }) {
   const codes = [];
   for (const res of resources) {
@@ -642,7 +654,8 @@ async function generateBundleResources(resources, isProduction, {
         onlyLocales,
         strictMessage,
         escapeHtml,
-        forceStringify
+        forceStringify,
+        transformI18nBlock
       });
       parseOptions.type = "bare";
       const { code } = generate(source, parseOptions);
@@ -714,7 +727,8 @@ function getOptions(filename, isProduction, query, sourceMap, {
   allowDynamic = false,
   strictMessage = true,
   escapeHtml = false,
-  jit = true
+  jit = true,
+  transformI18nBlock = null
 }) {
   const mode = isProduction ? "production" : "development";
   const baseOptions = {
@@ -728,6 +742,7 @@ function getOptions(filename, isProduction, query, sourceMap, {
     jit,
     onlyLocales,
     env: mode,
+    transformI18nBlock,
     onWarn: (msg) => {
       warn(`${filename} ${msg}`);
     },
@@ -1039,7 +1054,7 @@ function resolveIdentifier(localVariables, returnVariable) {
 
 const debug = createDebug__default(resolveNamespace("root"));
 const installedPkgInfo = checkInstallPackage(debug);
-const unplugin = unplugin$1.createUnplugin((options = {}, meta) => {
+const unpluginFactory = (options = {}, meta) => {
   debug("meta framework", meta.framework);
   if (!["vite", "webpack"].includes(meta.framework)) {
     raiseError(`This plugin is supported 'vite' and 'webpack' only`);
@@ -1058,7 +1073,9 @@ We are waiting for your Pull Request \u{1F642}.`
     plugins.push(directivePlugin(resolvedOptions));
   }
   return plugins;
-});
+};
+const unplugin = /* @__PURE__ */ unplugin$1.createUnplugin(unpluginFactory);
 
 exports.default = unplugin;
 exports.unplugin = unplugin;
+exports.unpluginFactory = unpluginFactory;

package/lib/index.d.cts

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

package/lib/index.d.mts

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

package/lib/index.d.ts

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

package/lib/index.mjs

@@ -167,6 +167,7 @@ function resolveOptions(options, installedPkgInfo) {
   const escapeHtml = !!options.escapeHtml;
   const optimizeTranslationDirective = isString(options.optimizeTranslationDirective) || isArray(options.optimizeTranslationDirective) ? options.optimizeTranslationDirective : !!options.optimizeTranslationDirective;
   const translationIdentifiers = /* @__PURE__ */ new Map();
+  const transformI18nBlock = typeof options.transformI18nBlock === "function" ? options.transformI18nBlock : null;
   return {
     include,
     exclude,
@@ -183,7 +184,8 @@ function resolveOptions(options, installedPkgInfo) {
     strictMessage,
     escapeHtml,
     optimizeTranslationDirective,
-    translationIdentifiers
+    translationIdentifiers,
+    transformI18nBlock
   };
 }
 
@@ -269,7 +271,8 @@ function resourcePlugin({
   ssrBuild,
   strictMessage,
   allowDynamic,
-  escapeHtml
+  escapeHtml,
+  transformI18nBlock
 }, meta, installedPkgInfo) {
   const filter = createFilter(include, exclude);
   const getVueI18nAliasPath = ({ ssr = false, runtimeOnly: runtimeOnly2 = false }) => {
@@ -551,7 +554,7 @@ function resourcePlugin({
             }
           );
           debug$2("parseOptions", parseOptions);
-          const source = await getCode(
+          let source = await getCode(
             code,
             filename,
             sourceMap,
@@ -559,6 +562,14 @@ function resourcePlugin({
             getSfcParser(),
             meta.framework
           );
+          if (typeof transformI18nBlock === "function") {
+            const modifiedSource = transformI18nBlock(source);
+            if (modifiedSource && typeof modifiedSource === "string") {
+              source = modifiedSource;
+            } else {
+              warn("transformI18nBlock should return a string");
+            }
+          }
           const { code: generatedCode, map } = generate(source, parseOptions);
           debug$2("generated code", generatedCode);
           debug$2("sourcemap", map, sourceMap);
@@ -612,7 +623,8 @@ async function generateBundleResources(resources, isProduction, {
   onlyLocales = [],
   strictMessage = true,
   escapeHtml = false,
-  jit = true
+  jit = true,
+  transformI18nBlock = void 0
 }) {
   const codes = [];
   for (const res of resources) {
@@ -627,7 +639,8 @@ async function generateBundleResources(resources, isProduction, {
         onlyLocales,
         strictMessage,
         escapeHtml,
-        forceStringify
+        forceStringify,
+        transformI18nBlock
       });
       parseOptions.type = "bare";
       const { code } = generate(source, parseOptions);
@@ -699,7 +712,8 @@ function getOptions(filename, isProduction, query, sourceMap, {
   allowDynamic = false,
   strictMessage = true,
   escapeHtml = false,
-  jit = true
+  jit = true,
+  transformI18nBlock = null
 }) {
   const mode = isProduction ? "production" : "development";
   const baseOptions = {
@@ -713,6 +727,7 @@ function getOptions(filename, isProduction, query, sourceMap, {
     jit,
     onlyLocales,
     env: mode,
+    transformI18nBlock,
     onWarn: (msg) => {
       warn(`${filename} ${msg}`);
     },
@@ -1024,7 +1039,7 @@ function resolveIdentifier(localVariables, returnVariable) {
 
 const debug = createDebug(resolveNamespace("root"));
 const installedPkgInfo = checkInstallPackage(debug);
-const unplugin = createUnplugin((options = {}, meta) => {
+const unpluginFactory = (options = {}, meta) => {
   debug("meta framework", meta.framework);
   if (!["vite", "webpack"].includes(meta.framework)) {
     raiseError(`This plugin is supported 'vite' and 'webpack' only`);
@@ -1043,6 +1058,7 @@ We are waiting for your Pull Request \u{1F642}.`
     plugins.push(directivePlugin(resolvedOptions));
   }
   return plugins;
-});
+};
+const unplugin = /* @__PURE__ */ createUnplugin(unpluginFactory);
 
-export { unplugin as default, unplugin };
+export { unplugin as default, unplugin, unpluginFactory };

package/lib/types.d.cts

@@ -14,6 +14,7 @@ interface PluginOptions {
     strictMessage?: boolean;
     escapeHtml?: boolean;
     optimizeTranslationDirective?: boolean | string | string[];
+    transformI18nBlock?: (src: string | Buffer) => string;
 }
 
 export type { PluginOptions, SFCLangFormat };

package/lib/types.d.mts

@@ -14,6 +14,7 @@ interface PluginOptions {
     strictMessage?: boolean;
     escapeHtml?: boolean;
     optimizeTranslationDirective?: boolean | string | string[];
+    transformI18nBlock?: (src: string | Buffer) => string;
 }
 
 export type { PluginOptions, SFCLangFormat };

package/lib/types.d.ts

@@ -14,6 +14,7 @@ interface PluginOptions {
     strictMessage?: boolean;
     escapeHtml?: boolean;
     optimizeTranslationDirective?: boolean | string | string[];
+    transformI18nBlock?: (src: string | Buffer) => string;
 }
 
 export type { PluginOptions, SFCLangFormat };

package/lib/vite.cjs

@@ -1,7 +1,7 @@
 'use strict';
 
+const unplugin = require('unplugin');
 const index = require('./index.cjs');
-require('unplugin');
 require('debug');
 require('picocolors');
 require('node:path');
@@ -19,6 +19,6 @@ require('@typescript-eslint/scope-manager');
 require('@typescript-eslint/typescript-estree');
 require('@eslint-community/eslint-utils');
 
-const vite = index.unplugin.vite;
+const vite = unplugin.createVitePlugin(index.unpluginFactory);
 
 module.exports = vite;

package/lib/vite.d.cts

@@ -1,6 +1,6 @@
-import * as vite from 'vite';
+import { UnpluginInstance } from 'unplugin';
 import { PluginOptions } from './types.cjs';
 
-declare const _default: (options: PluginOptions) => vite.Plugin | vite.Plugin[];
+declare const vite: UnpluginInstance<PluginOptions | undefined, boolean>['vite'];
 
-export { _default as default };
+export { vite as default };

package/lib/vite.d.mts

@@ -1,6 +1,6 @@
-import * as vite from 'vite';
+import { UnpluginInstance } from 'unplugin';
 import { PluginOptions } from './types.mjs';
 
-declare const _default: (options: PluginOptions) => vite.Plugin | vite.Plugin[];
+declare const vite: UnpluginInstance<PluginOptions | undefined, boolean>['vite'];
 
-export { _default as default };
+export { vite as default };

package/lib/vite.d.ts

@@ -1,6 +1,6 @@
-import * as vite from 'vite';
+import { UnpluginInstance } from 'unplugin';
 import { PluginOptions } from './types.js';
 
-declare const _default: (options: PluginOptions) => vite.Plugin | vite.Plugin[];
+declare const vite: UnpluginInstance<PluginOptions | undefined, boolean>['vite'];
 
-export { _default as default };
+export { vite as default };

package/lib/vite.mjs

@@ -1,5 +1,5 @@
-import { unplugin } from './index.mjs';
-import 'unplugin';
+import { createVitePlugin } from 'unplugin';
+import { unpluginFactory } from './index.mjs';
 import 'debug';
 import 'picocolors';
 import 'node:path';
@@ -17,6 +17,6 @@ import '@typescript-eslint/scope-manager';
 import '@typescript-eslint/typescript-estree';
 import '@eslint-community/eslint-utils';
 
-const vite = unplugin.vite;
+const vite = createVitePlugin(unpluginFactory);
 
 export { vite as default };

package/lib/webpack.cjs

@@ -1,7 +1,7 @@
 'use strict';
 
+const unplugin = require('unplugin');
 const index = require('./index.cjs');
-require('unplugin');
 require('debug');
 require('picocolors');
 require('node:path');
@@ -19,6 +19,6 @@ require('@typescript-eslint/scope-manager');
 require('@typescript-eslint/typescript-estree');
 require('@eslint-community/eslint-utils');
 
-const webpack = index.unplugin.webpack;
+const webpack = unplugin.createWebpackPlugin(index.unpluginFactory);
 
 module.exports = webpack;

package/lib/webpack.d.cts

@@ -1,6 +1,6 @@
-import * as webpack from 'webpack';
+import { UnpluginInstance } from 'unplugin';
 import { PluginOptions } from './types.cjs';
 
-declare const _default: (options: PluginOptions) => webpack.WebpackPluginInstance;
+declare const webpack: UnpluginInstance<PluginOptions | undefined, boolean>['webpack'];
 
-export { _default as default };
+export { webpack as default };

package/lib/webpack.d.mts

@@ -1,6 +1,6 @@
-import * as webpack from 'webpack';
+import { UnpluginInstance } from 'unplugin';
 import { PluginOptions } from './types.mjs';
 
-declare const _default: (options: PluginOptions) => webpack.WebpackPluginInstance;
+declare const webpack: UnpluginInstance<PluginOptions | undefined, boolean>['webpack'];
 
-export { _default as default };
+export { webpack as default };

package/lib/webpack.d.ts

@@ -1,6 +1,6 @@
-import * as webpack from 'webpack';
+import { UnpluginInstance } from 'unplugin';
 import { PluginOptions } from './types.js';
 
-declare const _default: (options: PluginOptions) => webpack.WebpackPluginInstance;
+declare const webpack: UnpluginInstance<PluginOptions | undefined, boolean>['webpack'];
 
-export { _default as default };
+export { webpack as default };

package/lib/webpack.mjs

@@ -1,5 +1,5 @@
-import { unplugin } from './index.mjs';
-import 'unplugin';
+import { createWebpackPlugin } from 'unplugin';
+import { unpluginFactory } from './index.mjs';
 import 'debug';
 import 'picocolors';
 import 'node:path';
@@ -17,6 +17,6 @@ import '@typescript-eslint/scope-manager';
 import '@typescript-eslint/typescript-estree';
 import '@eslint-community/eslint-utils';
 
-const webpack = unplugin.webpack;
+const webpack = createWebpackPlugin(unpluginFactory);
 
 export { webpack as default };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intlify/unplugin-vue-i18n",
-  "version": "5.0.0-beta.3",
+  "version": "5.0.0-beta.5",
   "description": "unplugin for Vue I18n",
   "author": {
     "name": "kazuya kawaguchi",