feima-shortcuts 0.3.0-beta.5 → 0.3.0-beta.7

package/bin/feima.js

@@ -3,7 +3,9 @@ const inquirer = require("inquirer");
 const { Command } = require('commander')
 const feima = require("../src/generate");
 
-const checkLocale  = require('../src/scripts/check-locale')
+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()
@@ -19,6 +21,20 @@ program
     checkLocale.run();
   })
 
+program
+  .command('check-i18n-default')
+  .description('检查未设置默认值的 t')
+  .action(() => {
+    checkI18nDefault.run();
+  })
+
+  program
+  .command('check-i18n-views')
+  .description('检查已使用未创建的 key')
+  .action(() => {
+    checkI18nViews.run();
+  })
+
 
 const run = () => {
   console.log(`🚀 当前版本：v${version}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "feima-shortcuts",
-  "version": "0.3.0-beta.5",
+  "version": "0.3.0-beta.7",
   "description": "快捷指令",
   "main": "index.js",
   "directories": {

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,171 @@
+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(),
+  viewsDir: 'src/views',
+  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') {
+      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'],
+  })
+}
+
+/* ---------------- core ---------------- */
+
+function run(userOptions = {}) {
+  // ✅ 保证 options 永远有值
+  const options = { ...DEFAULT_OPTIONS, ...userOptions }
+  const { cwd, viewsDir, silent } = options
+
+  const absViewsDir = path.join(cwd, viewsDir)
+
+  if (!fs.existsSync(absViewsDir)) {
+    if (!silent) {
+      console.warn(`⚠️ views 目录不存在：${viewsDir}`)
+    }
+    return {
+      success: true,
+      missingKeys: [],
+      noLocaleUsage: [],
+      scannedFiles: 0,
+    }
+  }
+
+  const files = glob.sync('**/*.{vue,ts,tsx}', {
+    cwd: absViewsDir,
+    absolute: true,
+  })
+
+  const missingKeys = []
+  const noLocaleUsage = []
+
+  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
+
+    const ast = parseCode(scriptCode)
+
+    let usedLocale = false
+    const usedKeys = []
+
+    traverse(ast, {
+      ImportDeclaration(p) {
+        if (p.node.source.value === './locale') {
+          usedLocale = true
+        }
+      },
+
+      CallExpression(p) {
+        const callee = p.node.callee
+        if (
+          (callee.type === 'Identifier' && callee.name === 't') ||
+          (callee.type === 'Identifier' && callee.name === '$t')
+        ) {
+          const arg = p.node.arguments[0]
+          if (arg && arg.type === 'StringLiteral') {
+            usedKeys.push(arg.value)
+          }
+        }
+      },
+    })
+
+    if (!usedKeys.length) continue
+
+    const localePath = path.join(path.dirname(file), 'locale.ts')
+    const localeKeys = loadLocaleKeys(localePath)
+
+    if (!usedLocale || !localeKeys) {
+      noLocaleUsage.push({
+        file: path.relative(cwd, file),
+        keys: usedKeys,
+      })
+      continue
+    }
+
+    for (const key of usedKeys) {
+      if (!localeKeys.includes(key)) {
+        missingKeys.push({
+          file: path.relative(cwd, file),
+          key,
+        })
+      }
+    }
+  }
+
+  /* ---------------- output ---------------- */
+
+  if (!silent) {
+    if (missingKeys.length) {
+      console.error('\n❌ 缺失的国际化 key：')
+      missingKeys.forEach(i =>
+        console.error(`  ${i.file}  →  ${i.key}`)
+      )
+    }
+
+    if (noLocaleUsage.length) {
+      console.warn('\n⚠️ 使用了 t/$t 但未使用 ./locale：')
+      noLocaleUsage.forEach(i =>
+        console.warn(`  ${i.file}`)
+      )
+    }
+
+    if (!missingKeys.length && !noLocaleUsage.length) {
+      console.log('✅ views 国际化检查通过')
+    }
+  }
+
+  return {
+    success: missingKeys.length === 0,
+    missingKeys,
+    noLocaleUsage,
+    scannedFiles: files.length,
+    options, // 🔍 调试/日志时很有用
+  }
+}
+
+/* ---------------- exports ---------------- */
+
+exports.run = run