vue-i18n-extract-plugin 1.0.54 → 1.0.56

package/README.md

@@ -48,6 +48,7 @@ extractI18n(options)
 ```javascript
 const defaultOptions = {
   translateKey: "$t", // 提取的函数的名称
+  JSXElement: "Trans", // 提取的函数的 JSX 元素名称 默认为 Trans, 如：<Trans id="aaa" defaultMsg="xxx" />
   rewrite: false, // 是否将提取到的内容转换为id后重写入源文件
   extractFromText: true, // 是否允许从纯文本节点中提取翻译内容
   autoImportI18n: true, // 是否自动导入 i18n 模块
@@ -62,6 +63,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/index.js

@@ -16,6 +16,7 @@ const {
   relativeCWDPath,
   getLangJsonPath,
   shouldExtract,
+  registerLangMatch,
   trimEmptyLine,
   padEmptyLine,
   excludeDirectives,
@@ -58,6 +59,7 @@ module.exports = {
   extractFunctionName,
   relativeCWDPath,
   shouldExtract,
+  registerLangMatch,
   trimEmptyLine,
   padEmptyLine,
   excludeDirectives,

package/lib/options.js

@@ -2,6 +2,7 @@ const { GoogleTranslator } = require("./translators");
 
 const defaultOptions = {
   translateKey: "$t", // 提取的函数的名称
+  JSXElement: "Trans", // 提取的函数的 JSX 元素名称 默认为 Trans, 如：<Trans id="aaa" defaultMsg="xxx" />
   rewrite: false, // 是否将提取到的内容转换为id后重写入源文件
   extractFromText: true, // 是否允许从纯文本节点中提取翻译内容
   autoImportI18n: true, // 是否自动导入 i18n 模块
@@ -16,6 +17,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/utils.js

@@ -157,10 +157,18 @@ function sleep(ms) {
 }
 
 function shouldExtract(str, langKey) {
-  if (REGEX_MAP[langKey]) {
-    return REGEX_MAP[langKey].test(str);
+  const regex = REGEX_MAP[langKey] || REGEX_MAP[translateLangKeyEnum.ZH];
+  if (regex instanceof RegExp) {
+    return regex.test(str);
   }
-  return REGEX_MAP[translateLangKeyEnum.ZH].test(str);
+  if (typeof regex === "function") {
+    return regex(str);
+  }
+  return false;
+}
+
+function registerLangMatch(langKey, regex) {
+  REGEX_MAP[langKey] = regex;
 }
 
 function trimEmptyLine(str) {
@@ -178,13 +186,15 @@ const translateLangKeyEnum = {
   KO: "ko",
   RU: "ru"
 };
+
 const REGEX_MAP = {
-  [translateLangKeyEnum.ZH]: /[\u4e00-\u9fff]/,
+  [translateLangKeyEnum.ZH]: /[\u4e00-\u9fff]/, // 简中/繁中
   [translateLangKeyEnum.EN]: /[a-zA-Z]/,
   [translateLangKeyEnum.JA]: /[\u3040-\u309F\u30A0-\u30FF\u4E00-\u9FFF]/, // 日语假名和汉字
   [translateLangKeyEnum.KO]: /[\uAC00-\uD7A3]/, // 韩语字母
   [translateLangKeyEnum.RU]: /[йцукенгшщзхъфывапролджэячсмитьбюё .-]{1,}/ // 俄语字母
 };
+
 const excludeDirectives = [
   "model",
   "slot",
@@ -195,6 +205,7 @@ const excludeDirectives = [
   "once",
   "memo"
 ];
+
 const EXCLUDED_CALL = [
   "$deepScan",
   "console.log",
@@ -227,6 +238,7 @@ module.exports = {
   fixFolderPath,
   sleep,
   shouldExtract,
+  registerLangMatch,
   trimEmptyLine,
   padEmptyLine,
   excludeDirectives,

package/lib/visitors.js

@@ -1,6 +1,6 @@
 const t = require("@babel/types");
 const {
-  generateId,
+  generateId: _generateId,
   extractFunctionName,
   EXCLUDED_CALL,
   shouldExtract
@@ -28,6 +28,22 @@ function isVNodeCall(path, nodeName) {
   );
 }
 
+function isJSXElement(path, nodeName) {
+  const jsxElement = path.findParent(p => p.isJSXOpeningElement());
+
+  if (
+    jsxElement &&
+    t.isJSXIdentifier(jsxElement.node.name, { name: nodeName })
+  ) {
+    const jsxAttr = path.findParent(p => p.isJSXAttribute());
+    const attrName = jsxAttr.node.name.name;
+    if (attrName === "defaultMsg" || attrName === "values") {
+      return true;
+    }
+  }
+  return false;
+}
+
 function getPropKey(propNode) {
   if (t.isIdentifier(propNode.key)) {
     return propNode.key.name;
@@ -113,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];
 
@@ -137,7 +160,7 @@ function createI18nVisitor(option, i18nMap) {
         return;
       }
 
-      const hashed = generateId(keyText);
+      const hashed = generateId(keyText, option);
 
       if (i18nMap) {
         i18nMap[hashed] = keyText;
@@ -158,6 +181,11 @@ function createI18nVisitor(option, i18nMap) {
         return;
       }
 
+      // 跳过<Trans defaultMsg="你好，{name}" values={{name: '世界'} /> defaultMsg和values属性的转换
+      if (isJSXElement(path, option.JSXElement)) {
+        return;
+      }
+
       // 获取真实调用函数
       const extractFnName = extractFunctionName(path);
 
@@ -187,7 +215,7 @@ function createI18nVisitor(option, i18nMap) {
         return;
       }
 
-      const hashed = generateId(value);
+      const hashed = generateId(value, option);
 
       if (i18nMap) {
         i18nMap[hashed] = value;
@@ -267,7 +295,7 @@ function createI18nVisitor(option, i18nMap) {
 
       if (option.extractFromText === false) return;
 
-      const hashed = generateId(value);
+      const hashed = generateId(value, option);
 
       if (i18nMap) {
         i18nMap[hashed] = value;
@@ -288,7 +316,7 @@ function createI18nVisitor(option, i18nMap) {
         return;
       }
 
-      const hashed = generateId(text);
+      const hashed = generateId(text, option);
 
       if (i18nMap) {
         i18nMap[hashed] = text;
@@ -316,7 +344,7 @@ function createI18nVisitor(option, i18nMap) {
           return;
         }
 
-        const hashed = generateId(value);
+        const hashed = generateId(value, option);
 
         if (i18nMap) {
           i18nMap[hashed] = value;
@@ -330,6 +358,77 @@ function createI18nVisitor(option, i18nMap) {
           )
         );
       }
+    },
+    JSXElement(path) {
+      // <Trans id="aaa" defaultMsg="xxx" />
+      const openingElement = path.node.openingElement;
+      if (
+        !t.isJSXIdentifier(openingElement.name) ||
+        openingElement.name.name !== option.JSXElement
+      ) {
+        return;
+      }
+
+      let idAttr = null;
+      let idValue = null;
+      let defaultMsgValue = null;
+
+      // 遍历属性，查找 id 和 defaultMsg
+      openingElement.attributes.forEach(attr => {
+        if (!t.isJSXAttribute(attr) || !t.isJSXIdentifier(attr.name)) return;
+
+        if (attr.name.name === "id") {
+          idAttr = attr;
+          if (attr.value && t.isStringLiteral(attr.value)) {
+            idValue = attr.value.value;
+          }
+        }
+
+        if (attr.name.name === "defaultMsg") {
+          if (attr.value && t.isStringLiteral(attr.value)) {
+            defaultMsgValue = attr.value.value;
+          }
+        }
+      });
+
+      // 计算 id，如果未提供，则使用 defaultMsg 的哈希值
+      if (!idValue && defaultMsgValue) {
+        idValue = generateId(defaultMsgValue, option);
+
+        if (i18nMap) {
+          i18nMap[idValue] = defaultMsgValue;
+        }
+      }
+
+      // 有id并且有defaultMsg的情况
+      if (idValue && defaultMsgValue) {
+        if (i18nMap) {
+          i18nMap[idValue] = defaultMsgValue;
+        }
+      }
+
+      if (idValue) {
+        // 添加或更新 id 属性
+        if (idAttr) {
+          idAttr.value = t.stringLiteral(idValue);
+        } else {
+          openingElement.attributes.push(
+            t.jsxAttribute(t.jsxIdentifier("id"), t.stringLiteral(idValue))
+          );
+        }
+      }
+
+      if (!option.keepRaw) {
+        // 移除 defaultMsg
+        openingElement.attributes = openingElement.attributes.filter(
+          attr =>
+            !(
+              t.isJSXAttribute(attr) &&
+              t.isJSXIdentifier(attr.name) &&
+              attr.name.name === "defaultMsg"
+            )
+        );
+      }
     }
   };
 }

package/package.json

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

package/types/index.d.ts

@@ -16,6 +16,7 @@ export {
   relativeCWDPath,
   getLangJsonPath,
   shouldExtract,
+  registerLangMatch,
   trimEmptyLine,
   padEmptyLine,
   excludeDirectives,

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/utils.d.ts

@@ -15,6 +15,7 @@ export function resolveFilterPath(pathStr: string): string;
 export function fixFolderPath(pathStr: string | RegExp): string;
 export function sleep(ms: number): Promise<void>;
 export function shouldExtract(str: string, langKey: LangKey): boolean;
+export function registerLangMatch(langKey: LangKey, regex: RegExp | ((str: string) => boolean)): void;
 export function trimEmptyLine(str: string): string;
 export function padEmptyLine(str: string): string;
 export const excludeDirectives: string[];