🎯 auto-cr-cmd 是一个基于 SWC 静态分析的高速自动化代码审查 CLI，专为 JavaScript / TypeScript 团队设计，可在合并前快速发现风险代码。

🔧 auto-cr-rules 提供可扩展的静态分析规则集与 SDK，帮你零成本定制企业级代码审查策略。

📘 Prefer English? Read the English README.

特性亮点（自动化代码审查 & 静态代码分析）

• 内置规则库：默认集成 SWC AST 静态分析规则，例如 no-deep-relative-imports。
• 可扩展 SDK：auto-cr-rules 暴露 defineRule、helpers.imports 等工具，降低编写 TypeScript / JavaScript 自定义规则的复杂度。
• 工作区管理：使用 pnpm workspace 同时管理 CLI 与规则包，一次构建即可验证完整流程。
• 发布友好：内置版本递增脚本与 npm 发布命令，保持两个包的版本同步。

包概览（auto-cr-cmd & auto-cr-rules）

• auto-cr-cmd：基于 SWC 的极速命令行工具，聚焦自动化代码审查、CI 集成与静态代码扫描。
• auto-cr-rules：面向开发者的规则 SDK，支持多标签分类、国际化提示与团队定制规则发布。

快速开始

npx auto-cr-cmd --language zh [需要扫描的代码目录]

常用参数：

• --language <zh|en>：切换 CLI 输出语言（默认为自动检测）。
• --rule-dir <directory>：加载额外的自定义规则目录或包。
• --output <text|json>：选择输出格式，text 为友好的终端日志，json 用于集成脚本（默认为 text）。
• --config <path>：指定 .autocrrc.json 或 .autocrrc.js 配置文件路径，用于开启/关闭规则。
• --ignore-path <path>：指定 .autocrignore.json 或 .autocrignore.js 忽略文件路径，用于排除扫描。
• --tsconfig <path>：指定自定义 tsconfig.json 路径（默认读取 <cwd>/tsconfig.json）。
• --help：查看完整命令说明。

示例输出：

 WARN  [12:52:48] ⚠️ [基础规则]：no-deep-relative-imports 
  
    文件位置: .../dashboard.ts:2
    错误描述: 导入路径 "../../../../shared/deep/utils"，不能超过最大层级2
    错误代码: ../../../../shared/deep/utils
    优化建议: 使用别名路径（如 @shared/deep/utils）； 或在上层聚合导出，避免过深相对路径。

 WARN  [12:52:48] ⚠️ [未定义]：no-index-import

    文件位置: .../dashboard.ts:3
    错误描述: 禁止直接导入 ../../consts/index，请改用具体文件

✔  代码扫描完成，本次共扫描3个文件，其中0个文件存在错误，1个文件存在警告，0个文件存在优化建议！

JSON 输出示例：

npx auto-cr-cmd --output json -- ./src | jq

{
  "summary": {
    "scannedFiles": 2,
    "filesWithErrors": 1,
    "filesWithWarnings": 0,
    "filesWithOptimizing": 1,
    "violationTotals": {
      "total": 3,
      "error": 2,
      "warning": 0,
      "optimizing": 1
    }
  },
  "files": [
    {
      "filePath": "/workspace/src/example.ts",
      "severityCounts": {
        "error": 2,
        "warning": 0,
        "optimizing": 1
      },
      "totalViolations": 3,
      "errorViolations": 2,
      "violations": [
        {
          "tag": "imports",
          "ruleName": "no-deep-relative-imports",
          "severity": "error",
          "message": "避免从 src/components/button 进行深层相对导入",
          "line": 13
        }
      ]
    }
  ],
  "notifications": []
}

配置（.autocrrc）

• 在仓库根目录放置 .autocrrc.json 或 .autocrrc.js（按此顺序查找）；如需放在其他位置，可通过 --config <path> 指定。
• rules 支持的值：off | warning | error | optimizing | true/false | 0/1/2，未写明的规则沿用默认严重级别。

// .autocrrc.json
{
  "rules": {
    "no-deep-relative-imports": "error",
    "no-swallowed-errors": "off"
  }
}

忽略文件（.autocrignore）

• 在仓库根目录放置 .autocrignore.json 或 .autocrignore.js（按此顺序查找），或通过 --ignore-path <file> 指定自定义路径。
• 仅支持 JSON/JS 写法，基于 picomatch 的 glob 模式，数组键为 ignore。

// .autocrignore.js
module.exports = {
  ignore: ['node_modules', 'dist/**', '**/*.test.ts', 'public/**']
}

// .autocrignore.json
{
  "ignore": [
    "node_modules",
    "dist/**",
    "**/*.test.ts",
    "public/**"
  ]
}

// .autocrrc.js
module.exports = {
  rules: {
    'no-swallowed-errors': 'warning', // 覆盖严重级别
    'no-deep-relative-imports': true  // 保持规则默认严重级别
  }
}

编写自定义规则

CLI 默认使用 auto-cr-rules 包提供的规则，你也可以扩展自己的逻辑。

1. 准备目录

mkdir custom-rules

目录内放置可被 Node.js 执行的 .js / .cjs / .mjs 文件。

2. 安装 SDK

pnpm add auto-cr-rules

3. 编写规则

// custom-rules/no-index-import.js
const { defineRule } = require('auto-cr-rules')

module.exports = defineRule('no-index-import', ({ helpers, language }) => {
  for (const ref of helpers.imports) {
    if (ref.value.endsWith('/index')) {
      const message =
        language === 'zh'
          ? `禁止直接导入 ${ref.value}，请改用具体文件`
          : `Import ${ref.value} is not allowed. Import the concrete file instead.`

      helpers.reportViolation(message, ref.span)
    }
  }
})

RuleContext 提供：

• helpers.imports：统一收集的 import / require / 动态导入引用。
• helpers.isRelativePath、helpers.relativeDepth：常见路径判断工具。
• helpers.reportViolation(message, span?)：统一的问题上报接口。
• language 与 reporter：可获取当前语言和底层 Reporter API。

也可以一次导出多个规则：

const { defineRule } = require('auto-cr-rules')

const ruleA = defineRule('rule-a', (context) => { /* ... */ })
const ruleB = defineRule('rule-b', (context) => { /* ... */ })

module.exports = { rules: [ruleA, ruleB] }

4. 运行

cd examples
npx auto-cr-cmd -l en -r ./custom-rules/rules -- ./custom-rules/demo

项目结构

packages/
  auto-cr-rules/   # 规则 SDK 与内置规则（createRuleContext、defineRule 等）
  auto-cr-cmd/     # CLI 入口、Reporter、I18n、命令行逻辑
scripts/
  bump-version.mjs # 统一递增两个包的版本号
examples/
  custom-rules     # 自定义规则
  src              # 触发基础规则的例子

核心脚本：

• pnpm run version [major|minor|patch]：统一更新两个包的版本号（默认 patch）。
• pnpm run publish：依次执行版本递增、构建与两个包的 npm 发布。

参与贡献

欢迎通过 Issue 或 Pull Request 贡献代码。请先阅读：

• 行为准则
• 贡献指南

社区与支持

• 问题反馈：Issue Tracker
• 讨论社区：Community Discussions

Auto CR © [2025] [dengfengwang]。许可协议： MIT License