@chaoswise/intl 3.1.0 → 3.1.1

package/bin/chaoswise-intl.js

@@ -4,8 +4,9 @@ const runUpdate = require('./scripts/update');
 const runInitConfig = require('./scripts/initConfig');
 const runAddLocale = require('./scripts/addLocale');
 const runNoZhCn = require('./scripts/nozhcn');
+const runVerify = require('./scripts/verify');
 
-const SCRIPTS = ['intl', 'collect', 'update', 'nozhcn', 'addLocale', 'init'];
+const SCRIPTS = ['intl', 'collect', 'update', 'nozhcn', 'addLocale', 'init', 'verify'];
 
 const args = process.argv.slice(2);
 
@@ -24,6 +25,14 @@ if (script === 'update') {
 if (script === 'addLocale') {
   runAddLocale();
 }
+// verify: 检测代码中所有 intl.get('id') 是否都在 relationKey.json 或本地 locale 文件中
+// Usage:
+//   chaoswise-intl verify          → 发现孤立 id 时 exit(1)（CI 门禁）
+//   chaoswise-intl verify --warn   → 仅警告，不 exit(1)
+if (script === 'verify') {
+  const exitOnMissing = !args.includes('--warn');
+  runVerify({ exitOnMissing });
+}
 // nozhcn: detect (and optionally fix) Chinese characters in source files
 // Usage:
 //   chaoswise-intl nozhcn           → check mode  (CI gate, exit 1 on findings)

package/bin/scripts/util/makeVisitorUpdate.js

@@ -9,11 +9,14 @@ module.exports = function f(
   const { replaceWords, downloadIds, defaultKeyWordMap } = returns;
 
   // XXX: [TRICKY] 防止中文转码为 unicode
+  // NOTE: recast 的 StringLiteral 打印分支直接使用 node.value（nodeStr），
+  // 不像 @babel/generator 那样读取 extra.raw，所以必须把真实 id 写入 node.value。
   function hackValue(value, id) {
-    return Object.assign(t.StringLiteral(value), {
+    const finalId = id || value;
+    return Object.assign(t.StringLiteral(finalId), {
       extra: {
-        raw: `'${id}'`, // id
-        rawValue: value, // 临时id
+        raw: `'${finalId}'`,
+        rawValue: finalId,
       },
     });
   }

package/bin/scripts/verify.js

@@ -0,0 +1,104 @@
+const fs = require('fs');
+const path = require('path');
+const glob = require('glob');
+
+const getConf = require('./conf');
+const { targetOutputFiles } = require('./util/getTargetFiles');
+const transformAst = require('./util/transformAst');
+const log = require('./util/log');
+const file = require('./util/file');
+
+/**
+ * verify: 检测当前工程输出文件中所有 intl.get('id') 的 id
+ *   - pending  : 临时 key，存在于 relationKey.json（尚未执行 update 替换）
+ *   - ok       : 已在本地 locale 文件中找到
+ *   - missing  : 两处均找不到，属于"孤立 id"，运行时将无法解析
+ *
+ * 用法：
+ *   chaoswise-intl verify          → 发现 missing 时 exit(1)（CI 门禁）
+ *   chaoswise-intl verify --warn   → 仅警告，不 exit(1)
+ */
+async function verify({ exitOnMissing = true } = {}) {
+  log.info('词条 id 校验中...');
+
+  const conf = getConf();
+  const files = targetOutputFiles(conf);
+
+  if (!files.length) {
+    log.warn('未找到需要扫描的文件，请检查 output 配置');
+    return;
+  }
+
+  // ── Step 1: 收集代码中所有原始 id（传入空对象，不触发替换也不写文件）──────
+  const info = transformAst('update', files, conf, {});
+  const allIds = [...new Set(info.downloadIds.filter(Boolean))];
+
+  if (!allIds.length) {
+    log.success('未发现任何国际化 id，无需校验');
+    return;
+  }
+
+  // ── Step 2: 从 relationKey.json 获取待替换的临时 key 集合 ───────────────
+  const relationKey = file.readJson('relationKey.json') || {};
+  const pendingKeySet = new Set(Object.keys(relationKey));
+
+  // ── Step 3: 从本地 locale 文件获取已下载的合法 id 集合 ────────────────────
+  const rootPath = process.cwd();
+  const localeDir = path.resolve(rootPath, conf.localeOutput, 'locales');
+  const localeFiles = glob.sync(`${localeDir}/*.json`);
+  const localIdSet = new Set();
+  localeFiles.forEach((f) => {
+    try {
+      const json = JSON.parse(fs.readFileSync(f, 'utf-8'));
+      Object.keys(json).forEach((k) => localIdSet.add(k));
+    } catch (e) {
+      log.error(`读取 locale 文件失败：${f}`);
+    }
+  });
+
+  // ── Step 4: 分类统计 ──────────────────────────────────────────────────────
+  const pending = [];
+  const missing = [];
+  const ok = [];
+
+  for (const id of allIds) {
+    if (pendingKeySet.has(id)) {
+      pending.push({ tempKey: id, realId: relationKey[id] });
+    } else if (localIdSet.has(id)) {
+      ok.push(id);
+    } else {
+      missing.push(id);
+    }
+  }
+
+  // ── Step 5: 输出结果 ──────────────────────────────────────────────────────
+  console.log('');
+  log.info(`扫描到 ${allIds.length} 个唯一 id（文件数：${files.length}）`);
+
+  if (ok.length) {
+    log.success(`✓ ${ok.length} 个 id 已在本地 locale 文件中覆盖`);
+  }
+
+  if (pending.length) {
+    log.warnToLog(`⚠ ${pending.length} 个临时 key 尚未执行 update 替换：`);
+    pending.forEach(({ tempKey, realId }) => {
+      log.warnToLog(`    ${tempKey}  →  ${realId}`);
+    });
+  }
+
+  if (missing.length) {
+    log.error(`✗ ${missing.length} 个 id 在 relationKey.json 和本地 locale 文件中均不存在（孤立 id）：`);
+    missing.forEach((id) => log.error(`    ${id}`));
+    console.log('');
+    log.error('提示：孤立 id 可能是未上传到国际化平台、未执行 update 拉取，或已在平台删除的词条');
+
+    if (exitOnMissing) {
+      process.exit(1);
+    }
+  } else {
+    console.log('');
+    log.success('★★★ 所有词条 id 均已覆盖，校验通过 ★★★');
+  }
+}
+
+module.exports = verify;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chaoswise/intl",
-  "version": "3.1.0",
+  "version": "3.1.1",
   "author": "cloudwiser",
   "description": "intl",
   "main": "lib/index.js",