auto-cr-cmd 2.0.11 → 2.0.13

package/README.md

@@ -0,0 +1,150 @@
+<p align="center">
+  <a href="https://github.com/wangweiwei/auto-cr">
+    <img src="https://github.com/wangweiwei/auto-cr/blob/main/assets/images/image.png?raw=true" alt="auto-cr logo" width="60" />
+  </a>
+</p>
+
+<h1 align="center">Automated Code Review CLI ⚡️</h1>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/auto-cr-cmd"><img alt="NPM Version" src="https://img.shields.io/npm/v/auto-cr-cmd.svg?style=flat"/></a>
+  <a href="https://www.npmjs.com/package/auto-cr-cmd"><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/auto-cr-cmd.svg?style=flat"/></a>
+  <a href="./LICENSE"><img alt="MIT License" src="https://img.shields.io/github/license/wangweiwei/auto-cr"/></a>
+  <a href="https://github.com/wangweiwei/auto-cr/stargazers"><img alt="GitHub Stars" src="https://img.shields.io/github/stars/wangweiwei/auto-cr" /></a>
+</p>
+
+> 🎯 auto-cr-cmd is a high-speed automated code review CLI powered by SWC static analysis, built for JavaScript / TypeScript teams to surface risky code before it merges.
+>
+> 🔧 auto-cr-rules provides an extensible static analysis rule set and SDK so you can tailor enterprise-grade review policies with minimal effort.
+
+📘 Prefer Chinese? Read the [Chinese README](https://github.com/wangweiwei/auto-cr/blob/main/README.zh-CN.md).
+
+
+## Feature Highlights (Automated Code Review & Static Analysis)
+
+- **Built-in Rule Library**: Ships with SWC AST static analysis rules out of the box, such as `no-deep-relative-imports`.
+- **Extensible SDK**: `auto-cr-rules` exposes helpers like `defineRule` and `helpers.imports`, reducing the friction of authoring custom TypeScript / JavaScript rules.
+- **Workspace Friendly**: Manage both the CLI and rule package via pnpm workspaces and validate the full pipeline with a single build.
+- **Publishing Toolkit**: Version bump scripts and npm publish commands keep both packages in sync.
+
+## Package Overview (auto-cr-cmd & auto-cr-rules)
+
+- **auto-cr-cmd**: A lightning-fast SWC-based CLI focused on automated reviews, CI integration, and static code scanning.
+- **auto-cr-rules**: A developer-facing rule SDK with tag-based grouping, internationalized messaging, and support for publishing team-specific rules.
+
+## Quick Start
+
+```bash
+npx auto-cr-cmd --language en [path-to-your-code]
+```
+
+Common flags:
+
+- `--language <zh|en>`: Switch CLI output language (defaults to auto-detection).
+- `--rule-dir <directory>`: Load additional custom rules from a directory or package.
+- `--help`: Display the full command reference.
+
+Sample output:
+
+```text
+ℹ️ Scanning directory: ./src
+ℹ️ Scanning file: ./src/main.ts
+ℹ️ [Base Rules]
+✔ auto-cr scan complete
+```
+
+## Writing Custom Rules
+
+The CLI consumes rules from the `auto-cr-rules` package by default, and you can extend it with your own logic.
+
+### 1. Prepare a Directory
+
+```bash
+mkdir custom-rules
+```
+
+Place Node.js-compatible `.js` / `.cjs` / `.mjs` files inside the directory.
+
+### 2. Install the SDK
+
+```bash
+pnpm add auto-cr-rules
+```
+
+### 3. Implement a Rule
+
+```js
+// 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` offers:
+
+- `helpers.imports`: Normalized `import` / `require` / dynamic import references.
+- `helpers.isRelativePath`, `helpers.relativeDepth`: Common path utilities.
+- `helpers.reportViolation(message, span?)`: Unified reporting API.
+- `language` and `reporter`: Access the active language and low-level reporter APIs.
+
+You can export multiple rules at once:
+
+```js
+const { defineRule } = require('auto-cr-rules')
+
+const ruleA = defineRule('rule-a', (context) => { /* ... */ })
+const ruleB = defineRule('rule-b', (context) => { /* ... */ })
+
+module.exports = { rules: [ruleA, ruleB] }
+```
+
+### 4. Run It
+
+```bash
+npx auto-cr-cmd --language en --rule-dir ./examples/custom-rules -- ./examples/src
+```
+
+## Project Layout
+
+```text
+packages/
+  auto-cr-rules/   # Rule SDK and built-in rules (createRuleContext, defineRule, etc.)
+  auto-cr-cmd/     # CLI entry point, reporter, i18n, and command handling
+scripts/
+  bump-version.mjs # Keep both package versions aligned
+examples/
+  custom-rules     # Custom rule samples
+  src              # Example that triggers the base rule
+```
+
+Essential scripts:
+
+- `pnpm run version [major|minor|patch]`: Bump both packages together (defaults to patch).
+- `pnpm run publish`: Run version bump, build, and publish for both packages sequentially.
+
+## Contributing
+
+We welcome contributions through Issues or Pull Requests. Please read:
+
+- [Code of Conduct](./CODE_OF_CONDUCT.md)
+- [Contributing Guide](./CONTRIBUTING.md)
+
+## Community & Support
+
+- Issues: [Issue Tracker](https://github.com/wangweiwei/auto-cr/issues)
+- Discussions: [Community Discussions](https://github.com/wangweiwei/auto-cr/wiki)
+
+---
+
+Auto CR © [2025] [dengfengwang]. Licensed under the [MIT License](./LICENSE)

package/dist/README.md

@@ -0,0 +1,150 @@
+<p align="center">
+  <a href="https://github.com/wangweiwei/auto-cr">
+    <img src="https://github.com/wangweiwei/auto-cr/blob/main/assets/images/image.png?raw=true" alt="auto-cr logo" width="60" />
+  </a>
+</p>
+
+<h1 align="center">Automated Code Review CLI ⚡️</h1>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/auto-cr-cmd"><img alt="NPM Version" src="https://img.shields.io/npm/v/auto-cr-cmd.svg?style=flat"/></a>
+  <a href="https://www.npmjs.com/package/auto-cr-cmd"><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/auto-cr-cmd.svg?style=flat"/></a>
+  <a href="./LICENSE"><img alt="MIT License" src="https://img.shields.io/github/license/wangweiwei/auto-cr"/></a>
+  <a href="https://github.com/wangweiwei/auto-cr/stargazers"><img alt="GitHub Stars" src="https://img.shields.io/github/stars/wangweiwei/auto-cr" /></a>
+</p>
+
+> 🎯 auto-cr-cmd is a high-speed automated code review CLI powered by SWC static analysis, built for JavaScript / TypeScript teams to surface risky code before it merges.
+>
+> 🔧 auto-cr-rules provides an extensible static analysis rule set and SDK so you can tailor enterprise-grade review policies with minimal effort.
+
+📘 Prefer Chinese? Read the [Chinese README](https://github.com/wangweiwei/auto-cr/blob/main/README.zh-CN.md).
+
+
+## Feature Highlights (Automated Code Review & Static Analysis)
+
+- **Built-in Rule Library**: Ships with SWC AST static analysis rules out of the box, such as `no-deep-relative-imports`.
+- **Extensible SDK**: `auto-cr-rules` exposes helpers like `defineRule` and `helpers.imports`, reducing the friction of authoring custom TypeScript / JavaScript rules.
+- **Workspace Friendly**: Manage both the CLI and rule package via pnpm workspaces and validate the full pipeline with a single build.
+- **Publishing Toolkit**: Version bump scripts and npm publish commands keep both packages in sync.
+
+## Package Overview (auto-cr-cmd & auto-cr-rules)
+
+- **auto-cr-cmd**: A lightning-fast SWC-based CLI focused on automated reviews, CI integration, and static code scanning.
+- **auto-cr-rules**: A developer-facing rule SDK with tag-based grouping, internationalized messaging, and support for publishing team-specific rules.
+
+## Quick Start
+
+```bash
+npx auto-cr-cmd --language en [path-to-your-code]
+```
+
+Common flags:
+
+- `--language <zh|en>`: Switch CLI output language (defaults to auto-detection).
+- `--rule-dir <directory>`: Load additional custom rules from a directory or package.
+- `--help`: Display the full command reference.
+
+Sample output:
+
+```text
+ℹ️ Scanning directory: ./src
+ℹ️ Scanning file: ./src/main.ts
+ℹ️ [Base Rules]
+✔ auto-cr scan complete
+```
+
+## Writing Custom Rules
+
+The CLI consumes rules from the `auto-cr-rules` package by default, and you can extend it with your own logic.
+
+### 1. Prepare a Directory
+
+```bash
+mkdir custom-rules
+```
+
+Place Node.js-compatible `.js` / `.cjs` / `.mjs` files inside the directory.
+
+### 2. Install the SDK
+
+```bash
+pnpm add auto-cr-rules
+```
+
+### 3. Implement a Rule
+
+```js
+// 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` offers:
+
+- `helpers.imports`: Normalized `import` / `require` / dynamic import references.
+- `helpers.isRelativePath`, `helpers.relativeDepth`: Common path utilities.
+- `helpers.reportViolation(message, span?)`: Unified reporting API.
+- `language` and `reporter`: Access the active language and low-level reporter APIs.
+
+You can export multiple rules at once:
+
+```js
+const { defineRule } = require('auto-cr-rules')
+
+const ruleA = defineRule('rule-a', (context) => { /* ... */ })
+const ruleB = defineRule('rule-b', (context) => { /* ... */ })
+
+module.exports = { rules: [ruleA, ruleB] }
+```
+
+### 4. Run It
+
+```bash
+npx auto-cr-cmd --language en --rule-dir ./examples/custom-rules -- ./examples/src
+```
+
+## Project Layout
+
+```text
+packages/
+  auto-cr-rules/   # Rule SDK and built-in rules (createRuleContext, defineRule, etc.)
+  auto-cr-cmd/     # CLI entry point, reporter, i18n, and command handling
+scripts/
+  bump-version.mjs # Keep both package versions aligned
+examples/
+  custom-rules     # Custom rule samples
+  src              # Example that triggers the base rule
+```
+
+Essential scripts:
+
+- `pnpm run version [major|minor|patch]`: Bump both packages together (defaults to patch).
+- `pnpm run publish`: Run version bump, build, and publish for both packages sequentially.
+
+## Contributing
+
+We welcome contributions through Issues or Pull Requests. Please read:
+
+- [Code of Conduct](./CODE_OF_CONDUCT.md)
+- [Contributing Guide](./CONTRIBUTING.md)
+
+## Community & Support
+
+- Issues: [Issue Tracker](https://github.com/wangweiwei/auto-cr/issues)
+- Discussions: [Community Discussions](https://github.com/wangweiwei/auto-cr/wiki)
+
+---
+
+Auto CR © [2025] [dengfengwang]. Licensed under the [MIT License](./LICENSE)

package/dist/README.zh-CN.md

@@ -0,0 +1,151 @@
+<p align="center">
+  <a href="https://github.com/wangweiwei/auto-cr">
+    <img src="https://github.com/wangweiwei/auto-cr/blob/main/assets/images/image.png?raw=true" alt="auto-cr logo" width="60" />
+  </a>
+</p>
+
+<h1 align="center">自动化代码审查 CLI ⚡️</h1>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/auto-cr-cmd"><img alt="NPM Version" src="https://img.shields.io/npm/v/auto-cr-cmd.svg?style=flat"/></a>
+  <a href="https://www.npmjs.com/package/auto-cr-cmd"><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/auto-cr-cmd.svg?style=flat"/></a>
+  <a href="./LICENSE"><img alt="MIT License" src="https://img.shields.io/github/license/wangweiwei/auto-cr"/></a>
+  <a href="https://github.com/wangweiwei/auto-cr/stargazers"><img alt="GitHub Stars" src="https://img.shields.io/github/stars/wangweiwei/auto-cr" /></a>
+</p>
+
+> 🎯 auto-cr-cmd 是一个基于 SWC 静态分析的高速自动化代码审查 CLI，专为 JavaScript / TypeScript 团队设计，可在合并前快速发现风险代码。
+
+> 🔧 auto-cr-rules 提供可扩展的静态分析规则集与 SDK，帮你零成本定制企业级代码审查策略。
+
+📘 Prefer English? Read the [English README](https://github.com/wangweiwei/auto-cr/blob/main/README.md).
+
+
+## 特性亮点（自动化代码审查 & 静态代码分析）
+
+- **内置规则库**：默认集成 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，支持多标签分类、国际化提示与团队定制规则发布。
+
+## 快速开始
+
+```bash
+npx auto-cr-cmd --language zh [需要扫描的代码目录]
+```
+
+常用参数：
+
+- `--language <zh|en>`：切换 CLI 输出语言（默认为自动检测）。
+- `--rule-dir <directory>`：加载额外的自定义规则目录或包。
+- `--help`：查看完整命令说明。
+
+示例输出：
+
+```text
+ℹ️ 扫描目录: ./src
+ℹ️ 扫描文件: ./src/main.ts
+ℹ️ [基础规则]   
+✔ auto-cr 代码扫描完成
+```
+
+## 编写自定义规则
+
+CLI 默认使用 `auto-cr-rules` 包提供的规则，你也可以扩展自己的逻辑。
+
+### 1. 准备目录
+
+```bash
+mkdir custom-rules
+```
+
+目录内放置可被 Node.js 执行的 `.js` / `.cjs` / `.mjs` 文件。
+
+### 2. 安装 SDK
+
+```bash
+pnpm add auto-cr-rules
+```
+
+### 3. 编写规则
+
+```js
+// 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。
+
+也可以一次导出多个规则：
+
+```js
+const { defineRule } = require('auto-cr-rules')
+
+const ruleA = defineRule('rule-a', (context) => { /* ... */ })
+const ruleB = defineRule('rule-b', (context) => { /* ... */ })
+
+module.exports = { rules: [ruleA, ruleB] }
+```
+
+### 4. 运行
+
+```bash
+pnpm run build
+npx auto-cr-cmd --language zh --rule-dir ./examples/custom-rules -- ./examples/src
+```
+
+## 项目结构
+
+```text
+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 贡献代码。请先阅读：
+
+- [行为准则](./CODE_OF_CONDUCT.md)
+- [贡献指南](./CONTRIBUTING.md)
+
+## 社区与支持
+
+- 问题反馈：[Issue Tracker](https://github.com/wangweiwei/auto-cr/issues)
+- 讨论社区：[Community Discussions](https://github.com/wangweiwei/auto-cr/wiki)
+
+---
+
+Auto CR © [2025] [dengfengwang]。许可协议： [MIT License](./LICENSE)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "auto-cr-cmd",
-  "version": "2.0.11",
+  "version": "2.0.13",
   "description": "Fast automated code review CLI powered by SWC-based static analysis",
   "main": "./dist/index.js",
   "types": "./dist/types/index.d.ts",
@@ -11,16 +11,15 @@
     "dist"
   ],
   "scripts": {
-    "prebuild": "node ../../scripts/readme-sync.mjs copy auto-cr-cmd",
     "build": "tsc --build tsconfig.json",
     "build:force": "tsc --build tsconfig.json --force",
-    "prebuild:force": "npm run prebuild",
+    "postbuild": "node ../../scripts/readme-sync.mjs copy auto-cr-cmd",
+    "postbuild:force": "node ../../scripts/readme-sync.mjs copy auto-cr-cmd",
     "dev": "tsc --watch",
     "start": "node dist/index.js",
     "cli": "ts-node src/index.ts",
     "prepublishOnly": "pnpm run build",
     "release": "pnpm run build && npm publish --access public",
-    "postrelease": "node ../../scripts/readme-sync.mjs clean auto-cr-cmd",
     "format": "prettier --write src"
   },
   "keywords": [
@@ -39,7 +38,7 @@
   "dependencies": {
     "@swc/core": "^1.13.20",
     "@swc/wasm": "^1.13.20",
-    "auto-cr-rules": "^2.0.11",
+    "auto-cr-rules": "^2.0.13",
     "commander": "^14.0.0",
     "consola": "^3.4.2"
   },