feima-shortcuts 0.3.0-beta.0 → 0.3.0-beta.10

package/bin/feima.js

@@ -2,6 +2,10 @@
 const inquirer = require("inquirer");
 const { Command } = require('commander')
 const feima = require("../src/generate");
+
+const checkLocale = require('../src/scripts/check-locale')
+const checkI18nDefault = require('../src/scripts/check-i18n-default')
+const checkI18nViews = require('../src/scripts/check-i18n-views')
 const { version } = require("../package.json"); // 读取 package.json 中的版本号
 
 const program = new Command()
@@ -14,7 +18,21 @@ program
   .command('check-locale')
   .description('检查未使用的 locale')
   .action(() => {
-    require('../src/scripts/check-locale')
+    checkLocale.run();
+  })
+
+program
+  .command('check-i18n-default')
+  .description('检查未设置默认值的 t')
+  .action(() => {
+    checkI18nDefault.run();
+  })
+
+  program
+  .command('check-i18n-views')
+  .description('检查已使用未创建的 key')
+  .action(() => {
+    checkI18nViews.run()
   })
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "feima-shortcuts",
-  "version": "0.3.0-beta.0",
+  "version": "0.3.0-beta.10",
   "description": "快捷指令",
   "main": "index.js",
   "directories": {
@@ -15,11 +15,16 @@
   "author": "1198810568@qq.com",
   "license": "ISC",
   "dependencies": {
+    "@babel/parser": "^7.28.5",
+    "@babel/traverse": "^7.28.5",
+    "@vue/compiler-sfc": "^3.5.26",
     "chalk": "^4.1.0",
     "commander": "^5.1.0",
     "download-git-repo": "^3.0.2",
     "fs-extra": "^9.0.1",
+    "glob": "^13.0.0",
     "inquirer": "^7.3.0",
+    "typescript": "^5.9.3",
     "uuid": "^9.0.0"
   },
   "packageManager": "pnpm@10.6.3+sha512.bb45e34d50a9a76e858a95837301bfb6bd6d35aea2c5d52094fa497a467c43f5c440103ce2511e9e0a2f89c3d6071baac3358fc68ac6fb75e2ceb3d2736065e6"

package/src/scripts/check-i18n-default/index.js

@@ -0,0 +1,99 @@
+#!/usr/bin/env node
+
+/**
+ * i18n 默认值检查脚本
+ *
+ * 规则：
+ * - 扫描 src/components、src/views
+ * - 支持 t / $t
+ * - 识别是否存在默认值（第二个参数）
+ * - 汇总缺失默认值的 key
+ */
+
+const fs = require('fs')
+const path = require('path')
+const glob = require('glob')
+
+const ROOT = process.cwd()
+const SCAN_DIRS = ['src/components', 'src/views']
+const FILE_EXT = '{ts,js,tsx,jsx,vue}'
+
+// 匹配：t('xxx') / t("xxx", "默认值")
+const I18N_REG = /\b(\$?t)\s*\(\s*(['"])([^'"]+)\2\s*(?:,\s*(['"])([^'"]*)\4)?\s*\)/g
+
+/** 结果结构 */
+const resultMap = new Map()
+const missingList = []
+
+function scanFile(filePath) {
+  const code = fs.readFileSync(filePath, 'utf-8')
+  let match
+
+  while ((match = I18N_REG.exec(code))) {
+    const [, fn, , key, , defaultValue] = match
+
+    if (!resultMap.has(key)) {
+      resultMap.set(key, {
+        key,
+        defaultValue: defaultValue || '',
+        locations: [],
+      })
+    }
+
+    const record = resultMap.get(key)
+    record.locations.push({
+      file: path.relative(ROOT, filePath),
+      fn,
+    })
+
+    // 有一次缺失默认值就标记
+    if (!defaultValue) {
+      missingList.push({
+        key,
+        file: path.relative(ROOT, filePath),
+      })
+    }
+  }
+}
+
+function run() {
+  SCAN_DIRS.forEach((dir) => {
+    const absDir = path.join(ROOT, dir)
+    if (!fs.existsSync(absDir)) return
+
+    const files = glob.sync(`${absDir}/**/*.${FILE_EXT}`, {
+      nodir: true,
+    })
+
+    files.forEach(scanFile)
+  })
+
+  console.log('\n📦 i18n 使用统计\n')
+
+  console.log(`共发现 key 数量：${resultMap.size}`)
+  console.log(`缺失默认值使用次数：${missingList.length}\n`)
+
+  if (missingList.length) {
+    console.log('❌ 以下 key 缺失默认值：\n')
+
+    const uniq = new Map()
+    missingList.forEach((i) => {
+      if (!uniq.has(i.key)) uniq.set(i.key, [])
+      uniq.get(i.key).push(i.file)
+    })
+
+    uniq.forEach((files, key) => {
+      console.log(`- ${key}`)
+      files.forEach((f) => {
+        console.log(`   ↳ ${f}`)
+      })
+    })
+
+    console.log('\n⚠️ 请为以上 key 补充默认值')
+    process.exitCode = 1
+  } else {
+    console.log('✅ 所有 i18n key 均设置了默认值')
+  }
+}
+
+exports.run = run

package/src/scripts/check-i18n-views/index.js

@@ -0,0 +1,238 @@
+const fs = require('fs')
+const path = require('path')
+const glob = require('glob')
+const { parse } = require('@vue/compiler-sfc')
+const babelParser = require('@babel/parser')
+const traverse = require('@babel/traverse').default
+
+/* ---------------- defaults ---------------- */
+
+const DEFAULT_OPTIONS = {
+  cwd: process.cwd(),
+  scanDirs: ['src/views', 'src/components'],
+  silent: false,
+}
+
+/* ---------------- utils ---------------- */
+
+function flattenLocale(obj, prefix = '') {
+  let res = []
+  for (const k in obj) {
+    const key = prefix ? `${prefix}.${k}` : k
+    if (typeof obj[k] === 'object' && obj[k] !== null) {
+      res = res.concat(flattenLocale(obj[k], key))
+    } else {
+      res.push(key)
+    }
+  }
+  return res
+}
+
+function loadLocaleKeys(localePath) {
+  if (!fs.existsSync(localePath)) return null
+  const mod = require(localePath)
+  const localeObj = mod.default || mod
+  return flattenLocale(localeObj)
+}
+
+function parseCode(code) {
+  return babelParser.parse(code, {
+    sourceType: 'module',
+    plugins: ['typescript', 'jsx'],
+  })
+}
+
+/**
+ * 从当前文件目录开始，向上查找最近的 locale.ts
+ * 直到到达 componentsRoot 为止
+ */
+function findNearestLocale(fileDir, componentsRoot) {
+  let current = fileDir
+
+  while (current.startsWith(componentsRoot)) {
+    const localePath = path.join(current, 'locale.ts')
+    if (fs.existsSync(localePath)) {
+      return localePath
+    }
+    const parent = path.dirname(current)
+    if (parent === current) break
+    current = parent
+  }
+
+  return null
+}
+
+/* ---------------- core ---------------- */
+
+function run(userOptions = {}) {
+  const options = { ...DEFAULT_OPTIONS, ...userOptions }
+  const { cwd, scanDirs, silent } = options
+
+  let files = []
+
+  for (const dir of scanDirs) {
+    const absDir = path.join(cwd, dir)
+    if (!fs.existsSync(absDir)) {
+      if (!silent) {
+        console.warn(`⚠️ 目录不存在：${dir}`)
+      }
+      continue
+    }
+
+    files.push(
+      ...glob.sync('**/*.{vue,ts,tsx}', {
+        cwd: absDir,
+        absolute: true,
+      })
+    )
+  }
+
+  const missingKeys = []
+  const noLocaleUsage = []
+
+  const componentsRoot = path.join(cwd, 'src/components')
+  const viewsRoot = path.join(cwd, 'src/views')
+
+  for (const file of files) {
+    const content = fs.readFileSync(file, 'utf-8')
+
+    let scriptCode = content
+
+    if (file.endsWith('.vue')) {
+      const { descriptor } = parse(content)
+      scriptCode =
+        descriptor.scriptSetup?.content ||
+        descriptor.script?.content ||
+        ''
+    }
+
+    if (!scriptCode) continue
+
+    let ast
+    try {
+      ast = parseCode(scriptCode)
+    } catch {
+      continue
+    }
+
+    const usedKeys = []
+    let importedLocale = false
+
+    traverse(ast, {
+      ImportDeclaration(p) {
+        if (p.node.source.value === './locale') {
+          importedLocale = true
+        }
+      },
+
+      CallExpression(p) {
+        const callee = p.node.callee
+        if (
+          (callee.type === 'Identifier' && (callee.name === 't' || callee.name === '$t'))
+        ) {
+          const keyArg = p.node.arguments[0]
+          const defaultArg = p.node.arguments[1]
+          if (keyArg && keyArg.type === 'StringLiteral') {
+            usedKeys.push({
+              key: keyArg.value,
+              defaultValue:
+                defaultArg && defaultArg.type === 'StringLiteral'
+                  ? defaultArg.value
+                  : null,
+            })
+          }
+        }
+      },
+    })
+
+    if (!usedKeys.length) continue
+
+    const fileDir = path.dirname(file)
+
+    /* ---------- views 逻辑 ---------- */
+    if (file.startsWith(viewsRoot)) {
+      const localePath = path.join(fileDir, 'locale.ts')
+      const localeKeys = loadLocaleKeys(localePath)
+
+      if (!importedLocale || !localeKeys) {
+        noLocaleUsage.push({
+          file: path.relative(cwd, file),
+          keys: usedKeys.map(i => i.key),
+        })
+        continue
+      }
+
+      for (const { key, defaultValue } of usedKeys) {
+        if (!localeKeys.includes(key)) {
+          missingKeys.push({
+            file: path.relative(cwd, file),
+            key,
+            defaultValue,
+          })
+        }
+      }
+
+      continue
+    }
+
+    /* ---------- components 逻辑 ---------- */
+    if (file.startsWith(componentsRoot)) {
+      const localePath = findNearestLocale(fileDir, componentsRoot)
+      const localeKeys = localePath && loadLocaleKeys(localePath)
+
+      if (!localeKeys) {
+        noLocaleUsage.push({
+          file: path.relative(cwd, file),
+          keys: usedKeys.map(i => i.key),
+        })
+        continue
+      }
+
+      for (const { key, defaultValue } of usedKeys) {
+        if (!localeKeys.includes(key)) {
+          missingKeys.push({
+            file: path.relative(cwd, file),
+            key,
+            defaultValue,
+          })
+        }
+      }
+    }
+  }
+
+  /* ---------------- output ---------------- */
+
+  if (!silent) {
+    if (missingKeys.length) {
+      console.error('\n❌ 缺失的国际化 key：')
+      missingKeys.forEach(i =>
+        console.error(
+          `  ${i.file}  →  ${i.key}${i.defaultValue ? ` （默认值: ${i.defaultValue}）` : ''}`
+        )
+      )
+    }
+
+    if (noLocaleUsage.length) {
+      console.warn('\n⚠️ 使用了 $t / t 但未找到 locale.ts：')
+      noLocaleUsage.forEach(i =>
+        console.warn(`  ${i.file}`)
+      )
+    }
+
+    if (!missingKeys.length && !noLocaleUsage.length) {
+      console.log('✅ 国际化检查通过（views + components）')
+    }
+  }
+
+  return {
+    success: missingKeys.length === 0,
+    missingKeys,
+    noLocaleUsage,
+    scannedFiles: files.length,
+    options,
+  }
+}
+
+/* ---------------- exports ---------------- */
+
+exports.run = run

package/src/scripts/check-locale/index.js

@@ -4,7 +4,8 @@ const path = require('path')
 const glob = require('glob')
 const ts = require('typescript')
 
-/* 工具函数，保持你原逻辑 */
+/* ================= 工具函数 ================= */
+
 function flattenLocale(obj, prefix = '') {
   let res = []
   for (const k in obj) {
@@ -38,11 +39,19 @@ function loadLocaleKeys(localePath) {
   return obj ? flattenLocale(obj) : []
 }
 
+/**
+ * 提取使用到的 locale key
+ * 兼容：
+ *   t('a.b.c')
+ *   t('a.b.c', 'fallback')
+ */
 function extractUsedKeys(code) {
-  const reg = /t\s*\(\s*['"`]([^'"`]+)['"`]\s*\)/g
+  const reg = /t\s*\(\s*['"`]([^'"`]+)['"`]\s*(?:,|\))/g
   const set = new Set()
   let m
-  while ((m = reg.exec(code))) set.add(m[1])
+  while ((m = reg.exec(code))) {
+    set.add(m[1])
+  }
   return set
 }
 
@@ -77,7 +86,8 @@ function detectUseLocale(code) {
   }
 }
 
-/* 页面 locale 检测 */
+/* ================= 页面 locale 检测 ================= */
+
 function checkPageLocale(pageDir) {
   const localePath = path.join(pageDir, 'locale.ts')
   const indexVue = path.join(pageDir, 'index.vue')
@@ -121,7 +131,8 @@ function checkPageLocale(pageDir) {
   return false
 }
 
-/* 组件 locale 检测 */
+/* ================= 组件 locale 检测 ================= */
+
 function checkComponentLocale(componentDir) {
   const localePath = path.join(componentDir, 'locale.ts')
   if (!fs.existsSync(localePath)) return false
@@ -184,7 +195,7 @@ function checkComponentLocale(componentDir) {
   return hasError
 }
 
-/* 主入口 */
+/* ================= 主入口 ================= */
 
 function run() {
   const root = path.resolve(process.cwd(), 'src/views')
@@ -203,15 +214,11 @@ function run() {
   })
 
   if (hasError) {
-    console.log('\n❗ locale 治理未通过')
+    console.log('\n❗ locale 检查未通过')
     process.exit(1)
   } else {
-    console.log('\n✅ locale 治理通过')
+    console.log('\n✅ locale 检查通过')
   }
 }
 
-if (require.main === module) {
-  run()
-}
-
-module.exports = run
+exports.run = run