vue-i18n-extract-plugin 1.0.55 → 1.0.57

package/README.md

@@ -55,6 +55,7 @@ const defaultOptions = {
   autoTranslate: true, // 提取完成后是否自动翻译
   cleanTranslate: true, // 是否清理无用的翻译内容
   keepRaw: false, // 开启后只做转换不生成hash值，即："测试" -> $t("测试"), 开启rewrite时生效
+  keepDefaultMsg: false, // 保留默认消息，即："测试" -> $t("hashedKey", "测试")
   enabled: true, // 是否启用插件
   outputJsonFileInPlugin: true, // 是否在插件中输出 JSON 文件
   outputJsonFileDebounceTimeInPlugin: 2000, // 输出 JSON 文件的防抖时间
@@ -63,6 +64,7 @@ const defaultOptions = {
   includePath: ['src/'], // 包含路径的数组
   excludedPath: [], // 排除路径的数组 refer to https://github.com/mrmlnc/fast-glob?tab=readme-ov-file#how-to-exclude-directory-from-reading
   allowedExtensions: [".vue", ".tsx", ".ts", ".jsx", ".js"], // 允许提取的文件扩展名
+  generateId: null, // 自定义生成 key 的函数
   fromLang: 'zh-cn', // 源语言, 目前支持提取的语言有：zh-cn(zh-tw), en, ja, ko, ru
   translateLangKeys: ["zh-tw", "en"], // 需要翻译为的语言键
   i18nPkgImportPath: "@/i18n", // i18n语言包导入路径

package/lib/options.js

@@ -9,6 +9,7 @@ const defaultOptions = {
   autoTranslate: true, // 提取完成后是否自动翻译
   cleanTranslate: true, // 是否清理无用的翻译内容
   keepRaw: false, // 开启后只做转换不生成hash值，即："测试" -> $t("测试"), 开启rewrite时生效
+  keepDefaultMsg: false, // 保留默认消息，即："测试" -> $t("hashedKey", "测试")
   enabled: true, // 是否启用插件
   outputJsonFileInPlugin: true, // 是否在插件中输出 JSON 文件
   outputJsonFileDebounceTimeInPlugin: 2000, // 输出 JSON 文件的防抖时间
@@ -17,6 +18,7 @@ const defaultOptions = {
   includePath: ["src/"], // 包含路径的数组
   excludedPath: [], // 排除路径的数组
   allowedExtensions: [".vue", ".tsx", ".ts", ".jsx", ".js"], // 允许提取的文件扩展名
+  generateId: null, // 自定义生成 key 的函数
   fromLang: "zh-cn", // 源语言, 目前支持提取的语言有：zh-cn(zh-tw), en, ja, ko, ru
   translateLangKeys: ["zh-tw", "en"], // 需要翻译为的语言键
   i18nPkgImportPath: "@/i18n", // i18n语言包导入路径

package/lib/visitors.js

@@ -1,6 +1,6 @@
 const t = require("@babel/types");
 const {
-  generateId,
+  generateId: _generateId,
   extractFunctionName,
   EXCLUDED_CALL,
   shouldExtract
@@ -129,6 +129,13 @@ function generateText(rawText, hashedText, options) {
   return hashedText;
 }
 
+function generateId(rawText, options) {
+  if (typeof options.generateId === "function") {
+    return options.generateId(rawText);
+  }
+  return _generateId(rawText);
+}
+
 function createI18nVisitor(option, i18nMap) {
   const excludedCall = [...option.excludedCall, ...EXCLUDED_CALL];
 
@@ -153,7 +160,7 @@ function createI18nVisitor(option, i18nMap) {
         return;
       }
 
-      const hashed = generateId(keyText);
+      const hashed = generateId(keyText, option);
 
       if (i18nMap) {
         i18nMap[hashed] = keyText;
@@ -161,6 +168,10 @@ function createI18nVisitor(option, i18nMap) {
 
       const newArg = t.stringLiteral(generateText(keyText, hashed, option));
       path.node.arguments[0] = newArg;
+
+      if (option.keepDefaultMsg) {
+        path.node.arguments.push(t.stringLiteral(keyText));
+      }
     },
 
     StringLiteral(path) {
@@ -208,7 +219,7 @@ function createI18nVisitor(option, i18nMap) {
         return;
       }
 
-      const hashed = generateId(value);
+      const hashed = generateId(value, option);
 
       if (i18nMap) {
         i18nMap[hashed] = value;
@@ -220,7 +231,10 @@ function createI18nVisitor(option, i18nMap) {
           t.identifier("_ctx"),
           t.identifier(option.translateKey)
         ),
-        [t.stringLiteral(generateText(value, hashed, option))]
+        [
+          t.stringLiteral(generateText(value, hashed, option)),
+          option.keepDefaultMsg ? t.stringLiteral(value) : null
+        ].filter(Boolean)
       );
 
       // 判断是否createTextVNode或MemberExpression（如 Vue.createTextVNode）
@@ -246,9 +260,13 @@ function createI18nVisitor(option, i18nMap) {
         const hasCreateVNode = transformDirectiveIfNeeded(path, parentPath);
         if (!hasCreateVNode) {
           // 生成 $t("hashed")
-          callExpression = t.callExpression(t.identifier(option.translateKey), [
-            t.stringLiteral(generateText(value, hashed, option))
-          ]);
+          callExpression = t.callExpression(
+            t.identifier(option.translateKey),
+            [
+              t.stringLiteral(generateText(value, hashed, option)),
+              option.keepDefaultMsg ? t.stringLiteral(value) : null
+            ].filter(Boolean)
+          );
         }
       }
 
@@ -288,14 +306,17 @@ function createI18nVisitor(option, i18nMap) {
 
       if (option.extractFromText === false) return;
 
-      const hashed = generateId(value);
+      const hashed = generateId(value, option);
 
       if (i18nMap) {
         i18nMap[hashed] = value;
       }
 
       // 替换为字符类型翻译节点
-      const tCallExpression = `${option.translateKey}('${generateText(value, hashed, option)}')`;
+      const tCallExpression = option.keepDefaultMsg
+        ? `${option.translateKey}('${generateText(value, hashed, option)}', ${JSON.stringify(value)})`
+        : `${option.translateKey}('${generateText(value, hashed, option)}')`;
+
       node.value.raw = node.value.cooked = `\${${tCallExpression}}`;
     },
     JSXText(path) {
@@ -309,7 +330,7 @@ function createI18nVisitor(option, i18nMap) {
         return;
       }
 
-      const hashed = generateId(text);
+      const hashed = generateId(text, option);
 
       if (i18nMap) {
         i18nMap[hashed] = text;
@@ -318,9 +339,13 @@ function createI18nVisitor(option, i18nMap) {
       // 替换为表达式 {$t("hashed")}
       path.replaceWith(
         t.jsxExpressionContainer(
-          t.callExpression(t.identifier(option.translateKey), [
-            t.stringLiteral(generateText(text, hashed, option))
-          ])
+          t.callExpression(
+            t.identifier(option.translateKey),
+            [
+              t.stringLiteral(generateText(text, hashed, option)),
+              option.keepDefaultMsg ? t.stringLiteral(text) : null
+            ].filter(Boolean)
+          )
         )
       );
     },
@@ -337,7 +362,7 @@ function createI18nVisitor(option, i18nMap) {
           return;
         }
 
-        const hashed = generateId(value);
+        const hashed = generateId(value, option);
 
         if (i18nMap) {
           i18nMap[hashed] = value;
@@ -345,9 +370,13 @@ function createI18nVisitor(option, i18nMap) {
 
         path.replaceWith(
           t.jsxExpressionContainer(
-            t.callExpression(t.identifier(option.translateKey), [
-              t.stringLiteral(generateText(value, hashed, option))
-            ])
+            t.callExpression(
+              t.identifier(option.translateKey),
+              [
+                t.stringLiteral(generateText(value, hashed, option)),
+                option.keepDefaultMsg ? t.stringLiteral(value) : null
+              ].filter(Boolean)
+            )
           )
         );
       }
@@ -386,7 +415,7 @@ function createI18nVisitor(option, i18nMap) {
 
       // 计算 id，如果未提供，则使用 defaultMsg 的哈希值
       if (!idValue && defaultMsgValue) {
-        idValue = generateId(defaultMsgValue);
+        idValue = generateId(defaultMsgValue, option);
 
         if (i18nMap) {
           i18nMap[idValue] = defaultMsgValue;
@@ -411,7 +440,7 @@ function createI18nVisitor(option, i18nMap) {
         }
       }
 
-      if (!option.keepRaw) {
+      if (!option.keepDefaultMsg && !option.keepRaw) {
         // 移除 defaultMsg
         openingElement.attributes = openingElement.attributes.filter(
           attr =>

package/lib/vite-plugin-i18n.js

@@ -1,15 +1,52 @@
+const { createFilter } = require("@rollup/pluginutils");
 const { transformAsync } = require("@babel/core");
 const { createI18nPlugin } = require("./visitors");
-const { relativeCWDPath, checkAgainstRegexArray } = require("./utils");
+const {
+  relativeCWDPath,
+  resolveFilterPath,
+  fixFolderPath
+} = require("./utils");
 const { defaultOptions } = require("./options");
 const { globalI18nMap, handleFinalI18nMap } = require("./extract");
 
+function createFilterFn(option) {
+  const {
+    i18nPkgImportPath: importPath,
+    allowedExtensions: extensions,
+    includePath,
+    excludedPath
+  } = option;
+
+  return createFilter(
+    extensions
+      .map(ext => includePath.map(p => `${fixFolderPath(p)}**/*${ext}`))
+      .flat(),
+    [
+      "node_modules/**",
+      importPath.endsWith("/")
+        ? [
+            resolveFilterPath(importPath + "index.ts"),
+            resolveFilterPath(importPath + "index.js")
+          ]
+        : [
+            resolveFilterPath(importPath + "/index.ts"),
+            resolveFilterPath(importPath + "/index.js"),
+            resolveFilterPath(importPath + ".ts"),
+            resolveFilterPath(importPath + ".js")
+          ],
+      excludedPath.map(resolveFilterPath)
+    ].flat()
+  );
+}
+
 function vitePluginI18n(option) {
   option = { ...defaultOptions, ...option };
 
   let config;
   let timer;
 
+  const filter = createFilterFn(option);
+
   return {
     name: "vite-plugin-i18n-hash",
     enforce: "post",
@@ -41,39 +78,24 @@ function vitePluginI18n(option) {
       config = resolvedConfig;
     },
     async transform(code, path) {
-      if (!option.enabled) return;
+      if (!option.enabled || !filter(path)) return;
 
-      if (option.allowedExtensions.some(ext => path.endsWith(ext))) {
-        if (
-          option.includePath?.length &&
-          !checkAgainstRegexArray(path, option.includePath)
-        ) {
-          return code;
-        }
-        if (
-          option.excludedPath?.length &&
-          checkAgainstRegexArray(path, option.excludedPath)
-        ) {
-          return code;
-        }
-
-        return transformAsync(code, {
-          configFile: false,
-          plugins: [createI18nPlugin(option, globalI18nMap)]
+      return transformAsync(code, {
+        configFile: false,
+        plugins: [createI18nPlugin(option, globalI18nMap)]
+      })
+        .then(result => {
+          if (option.outputJsonFileInPlugin && config?.command === "serve") {
+            clearTimeout(timer);
+            timer = setTimeout(() => {
+              handleFinalI18nMap(globalI18nMap, option, true);
+            }, option.outputJsonFileDebounceTimeInPlugin);
+          }
+          return result?.code;
         })
-          .then(result => {
-            if (option.outputJsonFileInPlugin && config?.command === "serve") {
-              clearTimeout(timer);
-              timer = setTimeout(() => {
-                handleFinalI18nMap(globalI18nMap, option, true);
-              }, option.outputJsonFileDebounceTimeInPlugin);
-            }
-            return result?.code;
-          })
-          .catch(e => {
-            console.error(e);
-          });
-      }
+        .catch(e => {
+          console.error(e);
+        });
     },
     buildEnd() {},
     closeBundle() {
@@ -83,6 +105,8 @@ function vitePluginI18n(option) {
   };
 }
 
+exports.createFilterFn = createFilterFn;
+
 module.exports = vitePluginI18n;
 
 /* import { defineConfig } from 'vite'

package/lib/vite-plugin-import-i18n.js

@@ -1,45 +1,24 @@
-const { createFilter } = require("@rollup/pluginutils");
 const { i18nImportTransform } = require("./import-i18n-transform");
+const { createFilterFn } = require("./vite-plugin-i18n");
 const { defaultOptions } = require("./options");
-const { resolveFilterPath, fixFolderPath } = require("./utils");
 
-function vitePluginImportI18n(options) {
-  const {
-    translateKey: importName,
-    i18nPkgImportPath: importPath,
-    allowedExtensions: extensions,
-    includePath,
-    excludedPath,
-    enabled
-  } = { ...defaultOptions, ...options };
+function vitePluginImportI18n(option) {
+  option = { ...defaultOptions, ...option };
 
-  const filter = createFilter(
-    extensions
-      .map(ext => includePath.map(p => `${fixFolderPath(p)}**/*${ext}`))
-      .flat(),
-    [
-      "node_modules/**",
-      importPath.endsWith("/")
-        ? [
-            resolveFilterPath(importPath + "index.ts"),
-            resolveFilterPath(importPath + "index.js")
-          ]
-        : [
-            resolveFilterPath(importPath + "/index.ts"),
-            resolveFilterPath(importPath + "/index.js"),
-            resolveFilterPath(importPath + ".ts"),
-            resolveFilterPath(importPath + ".js")
-          ],
-      excludedPath.map(resolveFilterPath)
-    ].flat()
-  );
+  const filter = createFilterFn(option);
 
   return {
     name: "vite-plugin-import-i18n",
     enforce: "pre",
     async transform(code, path) {
-      if (!enabled || !filter(path)) return;
-      return i18nImportTransform(code, path, importName, importPath);
+      if (!option.enabled || !filter(path)) return;
+
+      return i18nImportTransform(
+        code,
+        path,
+        option.translateKey,
+        option.i18nPkgImportPath
+      );
     }
   };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vue-i18n-extract-plugin",
-  "version": "1.0.55",
+  "version": "1.0.57",
   "main": "lib/index.js",
   "types": "types/index.d.ts",
   "bin": {

package/types/options.d.ts

@@ -19,6 +19,7 @@ export interface I18nOptions {
   translateLangKeys: LangKey[]
   i18nPkgImportPath: string
   outputPath: string
+  generateId: ((text: string) => string) | null | undefined
   customGenLangFileName: (langKey: LangKey) => LangKey
   customTranslatedText: (text: string, toLang: LangKey) => string,
 //   translator: new GoogleTranslator({

package/types/vite-plugin-i18n.d.ts

@@ -1,4 +1,6 @@
 import { Plugin } from 'vite';
 import { I18nOptions } from './options';
 
+export function createFilterFn(option: Partial<I18nOptions>): (id: string) => boolean;
+
 export default function vitePluginI18n(option?: Partial<I18nOptions>): Plugin