@chaoswise/intl 3.0.0 → 3.1.0

package/bin/chaoswise-intl.js

@@ -3,29 +3,37 @@ const runCollect = require('./scripts/collect');
 const runUpdate = require('./scripts/update');
 const runInitConfig = require('./scripts/initConfig');
 const runAddLocale = require('./scripts/addLocale');
+const runNoZhCn = require('./scripts/nozhcn');
 
-// 可执行的指令
-const SCRIPTS = ['intl', 'collect', 'update'];
+const SCRIPTS = ['intl', 'collect', 'update', 'nozhcn', 'addLocale', 'init'];
 
 const args = process.argv.slice(2);
 
-const scriptIndex = args.findIndex(arg => {
-  const script = SCRIPTS.filter(script => arg === script)[0];
-  return arg === script;
-});
-
+const scriptIndex = args.findIndex(arg => SCRIPTS.includes(arg));
 const script = scriptIndex === -1 ? args[0] : args[scriptIndex];
 
-if(script === 'init') {
+if (script === 'init') {
   runInitConfig();
 }
-if(script === 'collect') {
+if (script === 'collect') {
   runCollect();
 }
-if(script === 'update') {
+if (script === 'update') {
   runUpdate();
 }
-// 收集全部语种
-if(script === 'addLocale') {
+if (script === 'addLocale') {
   runAddLocale();
 }
+// nozhcn: detect (and optionally fix) Chinese characters in source files
+// Usage:
+//   chaoswise-intl nozhcn           → check mode  (CI gate, exit 1 on findings)
+//   chaoswise-intl nozhcn check     → same as above
+//   chaoswise-intl nozhcn fix       → auto-fix comments, report remaining issues
+//   chaoswise-intl nozhcn report    → non-blocking scan, output JSON report
+if (script === 'nozhcn') {
+  // The sub-mode is the argument after 'nozhcn', default to 'check'
+  const modeArg = args[scriptIndex + 1];
+  const validModes = ['check', 'fix', 'report'];
+  const mode = validModes.includes(modeArg) ? modeArg : 'check';
+  runNoZhCn(mode);
+}

package/bin/scripts/conf/default.js

@@ -94,7 +94,55 @@ module.exports = function (excludes = []) {
 
     // 国际化平台地址
     baseURL: 'http://10.0.1.133:18000',
-  };
+
+    // ─────────────────────────────────────────────────────────────────
+    // nozhcn (No Chinese) 专属配置
+    // ─────────────────────────────────────────────────────────────────
+
+    // 需要检测的中文类型，可按需删减:
+    //   'comment'    - 注释（可自动修复）
+    //   'string'     - 字符串字面量
+    //   'template'   - 模板字符串
+    //   'jsx'        - JSX 文本内容
+    //   'identifier' - 标识符名称（极少出现，需手动修复）
+    noZhCnCheckTypes: ['comment', 'string', 'template', 'jsx'],
+
+    // 注释中文修复策略（fix 模式生效）:
+    //   'clean'  - 仅删除中文字符，保留非中文内容；若注释全为中文则整条删除
+    //   'remove' - 含中文的注释整条全部删除
+    noZhCnCommentStrategy: 'clean',
+
+    // 报告文件输出路径（null 表示不输出报告文件，report 模式默认使用此路径）
+    noZhCnReportFile: null,
+
+    // nozhcn 专属文件排除规则（叠加到主 exclude 之上）
+    noZhCnExclude: [],
+
+    // 是否忽略 intl.get('key').d('中文') 中 .d() 内的默认中文值
+    // 说明：collect 脚本会将中文字符串替换为 intl.get('key').d('原始中文')
+    //       .d() 中的中文是有意保留的回退值，开启此选项可跳过这类误报
+    noZhCnIgnoreI18nDefault: true,
+
+    // fix 模式下，将 .d('中文') 替换为指定语言的翻译文本。
+    // 值为语言包文件名（不含 .json），对应 localeOutput/locales/{lang}.json。
+    // 例如：'en_US' → 读取 src/public/locales/en_US.json 中对应 key 的翻译
+    // null 表示不执行此替换（保持现有 .d() 内容不变）
+    noZhCnDefaultLang: null,
+    // 是否扫描项目中的独立 .svg 文件（默认关闭，按需开启）
+    // SVG 文件无法用 Babel AST 解析，采用正则扫描
+    noZhCnIncludeSvg: false,
+
+    // SVG 元数据元素（<title>、<desc>、<metadata>）的修复策略（fix 模式生效）:
+    //   'remove' - 删除整个元素
+    //   'empty'  - 保留元素但清空内容：<title>搜索</title> → <title></title>
+    noZhCnSvgMetadataStrategy: 'remove',
+
+    // SVG 属性中文修复策略（fix 模式生效）:
+    //   'clean'  - 删除属性值中的中文字符（及 CJK 标点），清理后为空则移除整个属性；
+    //              若修改了 id 属性，同步更新 SVG 内部引用（url(#…), href）
+    //   'remove' - 移除包含中文的属性
+    //   false    - 不自动修复属性中的中文
+    noZhCnSvgAttrStrategy: 'clean',  };
 
   excludes.forEach((key) => delete config[key]);
 

package/bin/scripts/nozhcn.js

@@ -0,0 +1,440 @@
+/**
+ * nozhcn.js  ─  No Chinese Characters
+ *
+ * Orchestrates scanning and (optionally) fixing Chinese characters in
+ * all source files covered by the intl configuration.
+ *
+ * Modes
+ * ─────
+ *   check   (default) Scan every file. Print findings. Exit with code 1 if
+ *                     any Chinese is found — suitable for CI/CD gate use.
+ *
+ *   fix               Scan → auto-fix comments + .d() defaults + SVG →
+ *                     single re-scan → print remaining findings.
+ *                     Exit with code 1 if unfixable findings remain.
+ *
+ *   report            Like check but writes a structured JSON report file
+ *                     even when findings exist. Does NOT exit with code 1
+ *                     (non-blocking, good for dashboards / tracking).
+ */
+
+const fs = require('fs');
+const path = require('path');
+const glob = require('glob');
+const chalk = require('chalk');
+const getConf = require('./conf');
+const { targetEntryFiles } = require('./util/getTargetFiles');
+const findZhCnInFile = require('./util/findZhCnInFile');
+const fixZhCnInFile = require('./util/fixZhCnInFile');
+const fixI18nDefaultInFile = require('./util/fixI18nDefaultInFile');
+const findZhCnInSvgFile = require('./util/findZhCnInSvgFile');
+const fixZhCnInSvgFile = require('./util/fixZhCnInSvgFile');
+const log = require('./util/log');
+const file = require('./util/file');
+
+// ─── Display labels ──────────────────────────────────────────────────────────
+
+const TYPE_LABEL = {
+  comment:    'Comment   ',
+  string:     'String    ',
+  template:   'Template  ',
+  jsx:        'JSX Text  ',
+  'jsx-svg':  'JSX SVG   ',
+  identifier: 'Identifier',
+  'svg-comment':  'SVG Comment ',
+  'svg-metadata': 'SVG Metadata',
+  'svg-text':     'SVG Text    ',
+  'svg-attr':     'SVG Attr    ',
+};
+
+const TYPE_COLOR = {
+  comment:        chalk.gray,
+  string:         chalk.yellow,
+  template:       chalk.yellow,
+  jsx:            chalk.cyan,
+  'jsx-svg':      chalk.magenta,
+  identifier:     chalk.red,
+  'svg-comment':  chalk.gray,
+  'svg-metadata': chalk.gray,
+  'svg-text':     chalk.magenta,
+  'svg-attr':     chalk.magenta,
+};
+
+// Types that can be auto-fixed by nozhcn fix
+// Note: 'svg-attr' is conditionally fixable when noZhCnSvgAttrStrategy is set
+const AUTO_FIXABLE_TYPES = new Set(['comment', 'svg-comment', 'svg-metadata', 'svg-attr']);
+
+// Types that `collect` script can handle
+const COLLECT_TYPES = new Set(['string', 'template', 'jsx']);
+
+// Types that need SVG-specific manual handling
+const SVG_MANUAL_TYPES = new Set(['jsx-svg', 'svg-text']);
+
+// ─── Output helpers ──────────────────────────────────────────────────────────
+
+function printHeader(msg) {
+  console.log(chalk.bold.blue(`\n[nozhcn] ${msg}`));
+}
+
+function printDivider() {
+  console.log(chalk.dim('─'.repeat(72)));
+}
+
+/**
+ * Print all findings grouped by file path.
+ * @param {Finding[]} findings
+ */
+function printFindings(findings) {
+  if (!findings.length) {
+    log.success('[nozhcn] No Chinese characters found.');
+    return;
+  }
+
+  // Group by filePath
+  const byFile = new Map();
+  findings.forEach((f) => {
+    if (!byFile.has(f.filePath)) byFile.set(f.filePath, []);
+    byFile.get(f.filePath).push(f);
+  });
+
+  printDivider();
+  byFile.forEach((items, fp) => {
+    // Show relative path from cwd for readability
+    const rel = path.relative(process.cwd(), fp);
+    console.log(chalk.underline(`\n  ${rel}`));
+
+    items.forEach((item) => {
+      const lineStr = String(item.line || '?').padStart(6);
+      const typeLabel = (TYPE_COLOR[item.type] || chalk.white)(
+        `[${TYPE_LABEL[item.type] || item.type}]`
+      );
+      // Truncate long content to 80 chars for terminal readability
+      const content = (item.content || '').replace(/\n/g, '\\n').slice(0, 80);
+      console.log(`  Line ${lineStr}  ${typeLabel}  ${content}`);
+    });
+  });
+  printDivider();
+}
+
+/**
+ * Print a summary of findings by type.
+ * @param {Finding[]} findings
+ * @param {'check'|'fix'|'report'} mode
+ * @param {number} autoFixedCount   - number of auto-fixed comment findings
+ * @param {number} i18nDefaultFixed - number of auto-fixed .d() default values
+ */
+function printSummary(findings, mode, autoFixedCount, i18nDefaultFixed) {
+  if (!findings.length && autoFixedCount === 0 && i18nDefaultFixed === 0) {
+    log.success('[nozhcn] ✓ All clean — no Chinese characters detected.');
+    return;
+  }
+
+  // Count by type
+  const counts = {};
+  findings.forEach((f) => {
+    counts[f.type] = (counts[f.type] || 0) + 1;
+  });
+
+  const total = findings.length;
+
+  if (mode === 'fix' && autoFixedCount > 0) {
+    log.success(`[nozhcn] Auto-fixed ${autoFixedCount} comment(s).`);
+  }
+  if (mode === 'fix' && i18nDefaultFixed > 0) {
+    log.success(`[nozhcn] Replaced ${i18nDefaultFixed} .d() default value(s) with translations.`);
+  }
+
+  if (total > 0) {
+    const countStr = Object.entries(counts)
+      .map(([t, n]) => `${n} ${t}`)
+      .join(', ');
+    log.warnToLog(`[nozhcn] ${total} Chinese occurrence(s) remaining: ${countStr}`);
+
+    const collectNeeded = findings.some((f) => COLLECT_TYPES.has(f.type));
+    if (collectNeeded) {
+      console.log(
+        chalk.dim(
+          "  Tip: Run 'npm run intl-collect' (or: chaoswise-intl collect) to internationalize string/template/jsx occurrences."
+        )
+      );
+    }
+
+    const svgManualNeeded = findings.some((f) => SVG_MANUAL_TYPES.has(f.type));
+    if (svgManualNeeded) {
+      console.log(
+        chalk.dim(
+          '  Tip: SVG text/attribute occurrences require manual handling.\n' +
+          '       For standalone .svg files, run fix to clean comments/metadata;\n' +
+          '       for <text> content, consider replacing with a JS-driven label.'
+        )
+      );
+    }
+
+    const identifierFound = findings.some((f) => f.type === 'identifier');
+    if (identifierFound) {
+      console.log(
+        chalk.dim('  Tip: Identifier occurrences require manual renaming.')
+      );
+    }
+  } else if (mode === 'fix') {
+    log.success('[nozhcn] ✓ All auto-fixable Chinese occurrences have been fixed.');
+  }
+}
+
+// ─── Main entry ──────────────────────────────────────────────────────────────
+
+/**
+ * @param {'check'|'fix'|'report'} mode
+ */
+module.exports = function noZhCn(mode) {
+  mode = mode || 'check';
+
+  printHeader(`Scanning for Chinese characters... (mode: ${mode})`);
+
+  const conf = getConf();
+  const {
+    noZhCnCheckTypes = ['comment', 'string', 'template', 'jsx'],
+    noZhCnCommentStrategy = 'clean',
+    noZhCnReportFile = null,
+    noZhCnExclude = [],
+    noZhCnIgnoreI18nDefault = true,
+    noZhCnDefaultLang = null,
+    noZhCnIncludeSvg = false,
+    noZhCnSvgMetadataStrategy = 'remove',
+    noZhCnSvgAttrStrategy = 'clean',
+    localeOutput = 'src/public',
+    primaryRegx,
+    babelPresets,
+    babelPlugins,
+    i18nObject,
+    i18nMethod,
+    i18nDefaultFunctionKey,
+    ignoreComponents = ['svg', 'style'],
+  } = conf;
+
+  // Merge nozhcn-specific excludes into the main exclude list
+  const mergedConf = {
+    ...conf,
+    exclude: [...(conf.exclude || []), ...(noZhCnExclude || [])],
+  };
+
+  const files = targetEntryFiles(mergedConf);
+
+  if (!files.length) {
+    log.warnToLog('[nozhcn] No files found to scan. Please check your `entry` config.');
+    return;
+  }
+
+  log.info(`[nozhcn] ${files.length} file(s) to scan (types: ${noZhCnCheckTypes.join(', ')})`);
+
+  // Shared scan options
+  const scanOpts = {
+    checkTypes: noZhCnCheckTypes,
+    babelPresets,
+    babelPlugins,
+    primaryRegx,
+    i18nObject,
+    i18nMethod,
+    i18nDefaultFunctionKey,
+    ignoreI18nDefault: noZhCnIgnoreI18nDefault,
+    ignoreComponents,
+  };
+
+  // ── Phase 1: Initial scan ─────────────────────────────────────────────────
+
+  let allFindings = [];
+  const errorFiles = [];
+
+  files.forEach(({ filePath }) => {
+    const result = findZhCnInFile(filePath, scanOpts);
+    if (result.error) {
+      errorFiles.push({ filePath, error: result.error });
+    }
+    allFindings = allFindings.concat(result.findings);
+  });
+
+  if (errorFiles.length) {
+    log.warnToLog(`[nozhcn] ${errorFiles.length} file(s) failed to parse:`);
+    errorFiles.forEach(({ filePath: fp, error }) => {
+      const rel = path.relative(process.cwd(), fp);
+      console.log(chalk.dim(`  ${rel}: ${error}`));
+    });
+  }
+
+  // ── Phase 1b: SVG file scan (opt-in) ────────────────────────────────────
+
+  let svgFiles = [];
+  if (noZhCnIncludeSvg) {
+    const entryDirs = [].concat(mergedConf.entry || ['src']);
+    const excludePatterns = mergedConf.exclude || [];
+    entryDirs.forEach((dir) => {
+      const matched = glob.sync(`${dir}/**/*.svg`, { ignore: excludePatterns });
+      svgFiles = svgFiles.concat(matched);
+    });
+
+    log.info(`[nozhcn] ${svgFiles.length} SVG file(s) to scan`);
+
+    svgFiles.forEach((fp) => {
+      const result = findZhCnInSvgFile(fp);
+      if (result.error) {
+        errorFiles.push({ filePath: fp, error: result.error });
+      }
+      allFindings = allFindings.concat(result.findings);
+    });
+  }
+
+  // ── Phase 2: Auto-fix (fix mode only) ────────────────────────────────────
+  //
+  // All fix sub-phases (2 / 2b / 2c) run first WITHOUT intermediate re-scans.
+  // A single final re-scan at the end produces accurate remaining findings.
+  // This avoids up to 3 redundant full-project AST parses on large codebases.
+
+  let autoFixedCount = 0;
+  let i18nDefaultFixed = 0;
+  const i18nDefaultMissing = []; // { key, chinese } entries with no translation found
+  let svgFixedCount = 0;
+
+  if (mode === 'fix') {
+    let anyFixApplied = false;
+    // ── Phase 2a: Fix comments in JS/TS files ─────────────────────────────
+    const commentByFile = new Map();
+    allFindings.forEach((f) => {
+      if (f.type !== 'comment') return;
+      if (!commentByFile.has(f.filePath)) commentByFile.set(f.filePath, []);
+      commentByFile.get(f.filePath).push(f);
+    });
+
+    commentByFile.forEach((findings, fp) => {
+      autoFixedCount += fixZhCnInFile(fp, findings, noZhCnCommentStrategy);
+    });
+    if (autoFixedCount > 0) anyFixApplied = true;
+
+    // ── Phase 2b: Replace .d('Chinese') with translations ─────────────────
+    if (noZhCnDefaultLang) {
+      const localePath = path.resolve(
+        process.cwd(),
+        localeOutput,
+        'locales',
+        `${noZhCnDefaultLang}.json`
+      );
+
+      if (!fs.existsSync(localePath)) {
+        log.warnToLog(
+          `[nozhcn] noZhCnDefaultLang='${noZhCnDefaultLang}' is set but locale file does not exist: ${localePath}\n` +
+            `  Run 'npm run intl-update' (or: chaoswise-intl update) first to generate locale files.`
+        );
+      } else {
+        let localeMap;
+        try {
+          localeMap = JSON.parse(fs.readFileSync(localePath, 'utf8'));
+        } catch (err) {
+          log.error(`[nozhcn] Failed to parse locale file: ${localePath} — ${err.message}`);
+        }
+
+        if (localeMap) {
+          const fixOpts = { i18nObject, i18nMethod, i18nDefaultFunctionKey, babelPresets, babelPlugins };
+          // Collect JS/TS file paths from initial findings (exclude svg-* types)
+          const filesToFix = new Set(
+            allFindings.filter((f) => !f.type.startsWith('svg-')).map((f) => f.filePath)
+          );
+          filesToFix.forEach((fp) => {
+            const result = fixI18nDefaultInFile(fp, localeMap, fixOpts);
+            i18nDefaultFixed += result.fixed;
+            i18nDefaultMissing.push(...result.missing.map((m) => ({ ...m, filePath: fp })));
+          });
+          if (i18nDefaultFixed > 0) anyFixApplied = true;
+
+          if (i18nDefaultMissing.length) {
+            log.warnToLog(
+              `[nozhcn] ${i18nDefaultMissing.length} .d() default value(s) have no '${noZhCnDefaultLang}' translation yet:`
+            );
+            i18nDefaultMissing.slice(0, 10).forEach(({ filePath: fp, key, chinese }) => {
+              const rel = path.relative(process.cwd(), fp);
+              console.log(chalk.dim(`  ${rel}  key=${key}  zh='${chinese}'`));
+            });
+            if (i18nDefaultMissing.length > 10) {
+              console.log(chalk.dim(`  ... and ${i18nDefaultMissing.length - 10} more`));
+            }
+          }
+        }
+      }
+    }
+
+    // ── Phase 2c: Fix SVG files ───────────────────────────────────────────
+    if (noZhCnIncludeSvg && svgFiles.length) {
+      const svgByFile = new Map();
+      allFindings.forEach((f) => {
+        if (!f.type.startsWith('svg-')) return;
+        if (!svgByFile.has(f.filePath)) svgByFile.set(f.filePath, []);
+        svgByFile.get(f.filePath).push(f);
+      });
+
+      svgByFile.forEach((findings, fp) => {
+        const result = fixZhCnInSvgFile(fp, findings, {
+          commentStrategy: noZhCnCommentStrategy,
+          metadataStrategy: noZhCnSvgMetadataStrategy,
+          attrStrategy: noZhCnSvgAttrStrategy,
+        });
+        svgFixedCount += result.fixed;
+      });
+      if (svgFixedCount > 0) anyFixApplied = true;
+    }
+
+    // ── Single final re-scan after all fixes ──────────────────────────────
+    if (anyFixApplied) {
+      allFindings = [];
+      files.forEach(({ filePath }) => {
+        const result = findZhCnInFile(filePath, scanOpts);
+        allFindings = allFindings.concat(result.findings);
+      });
+      if (noZhCnIncludeSvg && svgFiles.length) {
+        svgFiles.forEach((fp) => {
+          const result = findZhCnInSvgFile(fp);
+          allFindings = allFindings.concat(result.findings);
+        });
+      }
+    }
+  }
+
+  // ── Phase 3: Output ───────────────────────────────────────────────────────
+
+  printFindings(allFindings);
+  printSummary(allFindings, mode, autoFixedCount + svgFixedCount, i18nDefaultFixed);
+
+  // Write JSON report if configured
+  const reportPath = noZhCnReportFile || (mode === 'report' ? 'nozhcn-report.json' : null);
+  if (reportPath) {
+    // Build summary counts
+    const summary = {};
+    allFindings.forEach((f) => {
+      summary[f.type] = (summary[f.type] || 0) + 1;
+    });
+
+    const report = {
+      timestamp: new Date().toISOString(),
+      mode,
+      total: allFindings.length,
+      autoFixed: autoFixedCount,
+      i18nDefaultFixed,
+      i18nDefaultMissingCount: i18nDefaultMissing.length,
+      summary,
+      findings: allFindings.map((f) => ({
+        filePath: path.relative(process.cwd(), f.filePath),
+        type: f.type,
+        line: f.line,
+        col: f.col,
+        content: f.content,
+      })),
+    };
+
+    file.write(reportPath, JSON.stringify(report, null, 2));
+    log.info(`[nozhcn] Report written to: ${reportPath}`);
+  }
+
+  // ── Phase 4: Exit code ────────────────────────────────────────────────────
+
+  // 'report' mode is non-blocking (used for dashboards / tracking)
+  if (mode !== 'report' && allFindings.length > 0) {
+    process.exit(1);
+  }
+};

package/bin/scripts/util/babelOptions.js

@@ -0,0 +1,49 @@
+/**
+ * babelOptions.js
+ *
+ * Shared Babel transform options used by all AST-based scan/fix utilities.
+ * Matches the superset-of-JS/TS/JSX/TSX syntax configuration from transformAst.js.
+ */
+
+const pluginSyntaxJSX = require('@babel/plugin-syntax-jsx');
+const pluginSyntaxProposalOptionalChaining = require('@babel/plugin-proposal-optional-chaining');
+const pluginSyntaxClassProperties = require('@babel/plugin-syntax-class-properties');
+const pluginSyntaxDecorators = require('@babel/plugin-syntax-decorators');
+const pluginSyntaxObjectRestSpread = require('@babel/plugin-syntax-object-rest-spread');
+const pluginSyntaxAsyncGenerators = require('@babel/plugin-syntax-async-generators');
+const pluginSyntaxDoExpressions = require('@babel/plugin-syntax-do-expressions');
+const pluginSyntaxDynamicImport = require('@babel/plugin-syntax-dynamic-import');
+const pluginSyntaxFunctionBind = require('@babel/plugin-syntax-function-bind');
+const pluginExportDefaultFrom = require('@babel/plugin-proposal-export-default-from');
+const presetTypescript = require('@babel/preset-typescript').default;
+
+/**
+ * @param {Array} [babelPresets]
+ * @param {Array} [babelPlugins]
+ * @returns {import('@babel/core').TransformOptions}
+ */
+module.exports = function buildTransformOptions(babelPresets, babelPlugins) {
+  return {
+    sourceType: 'module',
+    ast: true,
+    configFile: false,
+    parserOpts: { tokens: true },
+    presets: [
+      ...(babelPresets || []),
+      [presetTypescript, { isTSX: true, allExtensions: true }],
+    ],
+    plugins: [
+      pluginSyntaxJSX,
+      pluginSyntaxProposalOptionalChaining,
+      pluginSyntaxClassProperties,
+      [pluginSyntaxDecorators, { decoratorsBeforeExport: true }],
+      pluginSyntaxObjectRestSpread,
+      pluginSyntaxAsyncGenerators,
+      pluginSyntaxDoExpressions,
+      pluginSyntaxDynamicImport,
+      pluginSyntaxFunctionBind,
+      pluginExportDefaultFrom,
+      ...(babelPlugins || []),
+    ],
+  };
+};