vue-i18n-extract-plugin 1.0.65 → 1.0.67

package/.github/workflows/deploy.yml

@@ -0,0 +1,24 @@
+name: Publish to NPM
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 22
+          registry-url: "https://registry.npmjs.org"
+
+      - name: Publish package to NPM 📦
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/README.md

@@ -64,7 +64,7 @@ const defaultOptions = {
   excludedCall: [], // 排除的调用函数名称数组，目前已内置的函数请参阅：https://github.com/semdy/vue-i18n-extract-plugin/blob/main/lib/utils.js#L189
   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"], // 允许提取的文件扩展名
+  allowedExtensions: [".vue", ".nvue", ".uvue", ".tsx", ".ts", ".jsx", ".js"], // 允许提取的文件扩展名
   fromLang: 'zh-cn', // 源语言, 目前支持提取的语言有：zh-cn(zh-tw), en, ja, ko, ru
   translateLangKeys: ["zh-tw", "en"], // 需要翻译为的语言键
   i18nPkgImportPath: "@/i18n", // i18n语言包导入路径

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

@@ -11,13 +11,14 @@ module.exports = function () {
           i18nPkgImportPath: importPath,
           JSXElement,
           jsx,
-          enabled
+          enabled,
+          autoImportI18n
         } = {
           ...defaultOptions,
           ...state.opts
         };
 
-        if (!enabled) return;
+        if (!enabled || !autoImportI18n) return;
 
         const ast = path.parentPath?.node || path.node;
         const importNames = jsx ? [importName, JSXElement] : [importName];

package/lib/extract.js

@@ -23,7 +23,8 @@ const {
   padEmptyLine,
   isEmptyObject,
   getLangJsonPath,
-  readJsonWithDefault
+  readJsonWithDefault,
+  isVueLike
 } = require("./utils");
 const { defaultOptions } = require("./options");
 const { autoTranslate, cleanTranslate, cleanI18nMap } = require("./translate");
@@ -545,7 +546,7 @@ async function extractI18n(options) {
     if (!content.trim()) continue;
 
     try {
-      if (file.endsWith(".vue")) {
+      if (isVueLike(file)) {
         const vueContent = processVueFile(content, options);
         changed = vueContent.changed;
         code = vueContent.code;

package/lib/import-i18n-transform.js

@@ -2,6 +2,7 @@ const parser = require("@babel/parser");
 const traverse = require("@babel/traverse").default;
 const generate = require("@babel/generator").default;
 const t = require("@babel/types");
+const { isVueLike } = require("./utils");
 
 function i18nImportAstTransform(ast, importName, importPath) {
   let hasI18nImport = false;
@@ -19,12 +20,15 @@ function i18nImportAstTransform(ast, importName, importPath) {
 
       const sourcePath = path.node.source.value;
 
-      const importedElsewhere = path.node.specifiers.some(spec => {
-        return (
+      // 判断是否有 import { $t } from '@/i18n' 或 import $t from '@/i18n'
+      const existImport = path.node.specifiers.some(
+        spec =>
           (t.isImportSpecifier(spec) || t.isImportDefaultSpecifier(spec)) &&
           spec.local.name === importName
-        );
-      });
+      );
+
+      // 判断是否是其它路径导入了 $t
+      const importedElsewhere = sourcePath !== importPath && existImport;
 
       if (importedElsewhere) {
         conflictDefined = true;
@@ -32,12 +36,17 @@ function i18nImportAstTransform(ast, importName, importPath) {
         return;
       }
 
+      // 检查是否已经导入目标路径
       if (sourcePath === importPath) {
+        hasI18nImport = true;
+
+        if (existImport) return;
+
+        // 添加 $t 到已有的 import
         path.node.specifiers.push(
           t.importSpecifier(t.identifier(importName), t.identifier(importName))
         );
 
-        hasI18nImport = true;
         needTransform = true;
       }
     },
@@ -81,6 +90,8 @@ function i18nImportAstTransform(ast, importName, importPath) {
     } else {
       ast.program.body.unshift(importNode);
     }
+
+    needTransform = true;
   }
 
   return {
@@ -99,7 +110,7 @@ async function i18nImportTransform(code, path, importNames, importPath) {
       plugins: [
         "typescript",
         "jsx",
-        path.endsWith(".vue") ? "topLevelAwait" : null
+        isVueLike(path) ? "topLevelAwait" : null
       ].filter(Boolean)
     });
 
@@ -117,7 +128,7 @@ async function i18nImportTransform(code, path, importNames, importPath) {
     // 只有当需要修改时才重新生成代码
     if (transformNeeded) {
       const { code: newScript } = generate(ast);
-      return path.endsWith(".vue")
+      return isVueLike(path)
         ? code.replace(scriptContent, newScript)
         : newScript;
     }
@@ -129,7 +140,7 @@ async function i18nImportTransform(code, path, importNames, importPath) {
 }
 
 function extractScriptContent(code, path) {
-  if (!path.endsWith(".vue")) return code;
+  if (!isVueLike(path)) return code;
   const scriptMatch = code.match(/<script\b[^>]*>([\s\S]*?)<\/script>/);
   return scriptMatch?.[1] || "";
 }

package/lib/options.js

@@ -18,7 +18,7 @@ const defaultOptions = {
   excludedCall: [], // 排除的调用函数名称数组
   includePath: ["src/"], // 包含路径的数组
   excludedPath: [], // 排除路径的数组
-  allowedExtensions: [".vue", ".tsx", ".ts", ".jsx", ".js"], // 允许提取的文件扩展名
+  allowedExtensions: [".vue", ".nvue", ".uvue", ".tsx", ".ts", ".jsx", ".js"], // 允许提取的文件扩展名
   fromLang: "zh-cn", // 源语言, 目前支持提取的语言有：zh-cn(zh-tw), en, ja, ko, ru
   translateLangKeys: ["zh-tw", "en"], // 需要翻译为的语言键
   i18nPkgImportPath: "@/i18n", // i18n语言包导入路径

package/lib/utils.js

@@ -46,6 +46,10 @@ function isEmptyObject(obj) {
   return Object.keys(obj).length === 0;
 }
 
+function isVueLike(filePath) {
+  return /\.(vue|nvue|uvue)$/.test(filePath);
+}
+
 function checkAgainstRegexArray(value, regexArray = []) {
   for (let i = 0; i < regexArray.length; i++) {
     const regex =
@@ -259,6 +263,7 @@ module.exports = {
   generateId,
   parseArg,
   isEmptyObject,
+  isVueLike,
   checkAgainstRegexArray,
   extractFunctionName,
   relativeCWDPath,

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

@@ -11,7 +11,7 @@ function vitePluginImportI18n(option) {
     name: "vite-plugin-import-i18n",
     enforce: "pre",
     async transform(code, path) {
-      if (!option.enabled || !filter(path)) return;
+      if (!option.enabled || !option.autoImportI18n || !filter(path)) return;
 
       return i18nImportTransform(
         code,

package/package.json

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

package/types/index.d.ts

@@ -11,6 +11,8 @@ export {
   hashKey,
   generateId,
   parseArg,
+  isEmptyObject,
+  isVueLike,
   checkAgainstRegexArray,
   extractFunctionName,
   relativeCWDPath,

package/types/options.d.ts

@@ -1,6 +1,6 @@
 import { Translator } from './translators';
 
-export type LangKey = "zh-cn" | 'zh-tw' | 'en' | 'ja' | 'ko' | 'ru' | string
+export type LangKey = "zh-cn" | 'zh-tw' | 'en' | 'ja' | 'ko' | 'ru' | string;
 
 export interface I18nOptions {
   translateKey: string

package/types/utils.d.ts

@@ -5,6 +5,7 @@ export function hashKey(str: string): string;
 export function generateId(text: string, length?: number): string;
 export function parseArg(arg: string): any;
 export function isEmptyObject(obj: Record<string, any>): boolean;
+export function isVueLike(filePath: string): boolean;
 export function checkAgainstRegexArray(value: string, regexArray?: (string | RegExp)[]): boolean;
 export function extractFunctionName(path: NodePath): string;
 export function relativeCWDPath(subPath: string): string;