auto-cr-rules 2.0.64 → 2.0.71

package/README.md

@@ -43,6 +43,9 @@ 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.
 - `--output <text|json>`: Choose between human-friendly text logs or structured JSON results (defaults to `text`).
+- `--config <path>`: Point to a `.autocrrc.json` or `.autocrrc.js` file to enable/disable rules.
+- `--ignore-path <path>`: Point to a `.autocrignore.json` or `.autocrignore.js` file to exclude files/directories from scanning.
+- `--tsconfig <path>`: Use a custom `tsconfig.json` (defaults to `<cwd>/tsconfig.json`).
 - `--help`: Display the full command reference.
 
 Sample output:
@@ -108,6 +111,45 @@ npx auto-cr-cmd --output json -- ./src | jq
 }
 ```
 
+## Configuration (.autocrrc)
+
+- Place `.autocrrc.json` or `.autocrrc.js` in your repo root (search order as listed). Use `--config <path>` to point elsewhere.
+- `rules` accepts `off | warning | error | optimizing | true/false | 0/1/2`; unspecified rules keep their default severity.
+
+```jsonc
+// .autocrrc.json
+{
+  "rules": {
+    "no-deep-relative-imports": "error",
+    "no-swallowed-errors": "off"
+  }
+}
+```
+
+### Ignore paths (.autocrignore)
+
+- Place `.autocrignore.json` or `.autocrignore.js` in repo root (search order as listed), or pass `--ignore-path <file>`.
+- Supports glob patterns (picomatch) via JSON/JS arrays (`{ ignore: [...] }`).
+
+```js
+// .autocrignore.js
+module.exports = {
+  ignore: ['node_modules', 'dist/**', '**/*.test.ts', 'public/**']
+}
+```
+
+```json
+// .autocrignore.json
+{
+  "ignore": [
+    "node_modules",
+    "dist/**",
+    "**/*.test.ts",
+    "public/**"
+  ]
+}
+```
+
 ## Writing Custom Rules
 
 The CLI consumes rules from the `auto-cr-rules` package by default, and you can extend it with your own logic.

package/README.zh-CN.md

@@ -43,6 +43,9 @@ 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`：查看完整命令说明。
 
 示例输出：
@@ -108,6 +111,55 @@ npx auto-cr-cmd --output json -- ./src | jq
 }
 ```
 
+## 配置（.autocrrc）
+
+- 在仓库根目录放置 `.autocrrc.json` 或 `.autocrrc.js`（按此顺序查找）；如需放在其他位置，可通过 `--config <path>` 指定。
+- `rules` 支持的值：`off | warning | error | optimizing | true/false | 0/1/2`，未写明的规则沿用默认严重级别。
+
+```jsonc
+// .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`。
+
+```js
+// .autocrignore.js
+module.exports = {
+  ignore: ['node_modules', 'dist/**', '**/*.test.ts', 'public/**']
+}
+```
+
+```json
+// .autocrignore.json
+{
+  "ignore": [
+    "node_modules",
+    "dist/**",
+    "**/*.test.ts",
+    "public/**"
+  ]
+}
+```
+
+```js
+// .autocrrc.js
+module.exports = {
+  rules: {
+    'no-swallowed-errors': 'warning', // 覆盖严重级别
+    'no-deep-relative-imports': true  // 保持规则默认严重级别
+  }
+}
+```
+
 ## 编写自定义规则
 
 CLI 默认使用 `auto-cr-rules` 包提供的规则，你也可以扩展自己的逻辑。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "auto-cr-rules",
-  "version": "2.0.64",
+  "version": "2.0.71",
   "description": "Extensible static analysis rule set for the auto-cr automated code review toolkit",
   "main": "dist/index.js",
   "types": "dist/types/index.d.ts",