@spaceflow/review 3.0.0 → 4.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +10 -0
- package/README.md +136 -25
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,15 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [3.0.0](https://github.com/Lydanne/spaceflow/compare/@spaceflow/review@2.0.0...@spaceflow/review@3.0.0) (2026-04-13)
|
|
4
|
+
|
|
5
|
+
### 代码重构
|
|
6
|
+
|
|
7
|
+
* **review:** 规则级 includes 优先于文件级 includes,与 severity 优先级保持一致 ([1b03415](https://github.com/Lydanne/spaceflow/commit/1b0341587f4fcf6913b072a1b4731c8eb92114a2))
|
|
8
|
+
|
|
9
|
+
### 其他修改
|
|
10
|
+
|
|
11
|
+
* **review-summary:** released version 2.0.0 [no ci] ([4dbf0dd](https://github.com/Lydanne/spaceflow/commit/4dbf0dd37be9137e9b1a38163300be00b2ae851a))
|
|
12
|
+
|
|
3
13
|
## [2.0.0](https://github.com/Lydanne/spaceflow/compare/@spaceflow/review@1.0.0...@spaceflow/review@2.0.0) (2026-04-13)
|
|
4
14
|
|
|
5
15
|
### 代码重构
|
package/README.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
[](https://www.npmjs.com/package/@spaceflow/review)
|
|
4
4
|
[](https://opensource.org/licenses/MIT)
|
|
5
5
|
|
|
6
|
-
> Spaceflow AI 代码审查扩展，使用 LLM 对 PR 代码进行自动审查。支持 OpenAI、Claude Code、Gemini 等多种 LLM 模式。
|
|
6
|
+
> Spaceflow AI 代码审查扩展，使用 LLM 对 PR 代码进行自动审查。支持 OpenAI、Claude Code、Gemini、Open Code 等多种 LLM 模式。
|
|
7
7
|
|
|
8
8
|
## 安装
|
|
9
9
|
|
|
@@ -13,13 +13,17 @@ pnpm spaceflow install @spaceflow/review
|
|
|
13
13
|
|
|
14
14
|
## 功能特性
|
|
15
15
|
|
|
16
|
-
- **多 LLM 支持** — OpenAI、Claude Code、Gemini 可选
|
|
16
|
+
- **多 LLM 支持** — OpenAI、Claude Code、Gemini、Open Code 可选
|
|
17
17
|
- **行级评论** — 在 PR 中精确定位问题代码行
|
|
18
18
|
- **增量审查** — 多次运行时自动去重，追踪问题修复状态
|
|
19
19
|
- **删除代码分析** — 评估删除代码可能带来的风险
|
|
20
20
|
- **AI 生成 PR 描述** — 自动总结 PR 功能变更
|
|
21
21
|
- **审查规范** — 支持自定义 Markdown 格式的审查规则
|
|
22
22
|
- **远程规范引用** — 支持从远程仓库 URL 拉取审查规范
|
|
23
|
+
- **系统规则** — 不依赖 LLM 的静态检查（如单文件行数上限）
|
|
24
|
+
- **本地审查** — 审查未提交或暂存区的代码，无需 PR
|
|
25
|
+
- **MCP 工具** — 提供 `list_rules`、`get_rules_for_file` 等工具供 AI 编辑器使用
|
|
26
|
+
- **问题阻断** — 存在未解决问题时以非零退出码退出，适用于 CI 门禁
|
|
23
27
|
|
|
24
28
|
## 使用
|
|
25
29
|
|
|
@@ -38,29 +42,47 @@ spaceflow review -p 123 -l openai -vv
|
|
|
38
42
|
|
|
39
43
|
# 仅分析删除代码
|
|
40
44
|
spaceflow review -p 123 --deletion-only -l openai
|
|
45
|
+
|
|
46
|
+
# 本地审查（未提交的代码）
|
|
47
|
+
spaceflow review --local -l openai
|
|
48
|
+
|
|
49
|
+
# 仅审查暂存区代码
|
|
50
|
+
spaceflow review --local staged -l openai
|
|
51
|
+
|
|
52
|
+
# 仅刷新状态（同步 reactions、resolved 等）
|
|
53
|
+
spaceflow review --flush
|
|
54
|
+
|
|
55
|
+
# 存在 error 级别未解决问题时非零退出
|
|
56
|
+
spaceflow review -p 123 --fail-on-issues -l openai
|
|
41
57
|
```
|
|
42
58
|
|
|
43
59
|
## 命令行参数
|
|
44
60
|
|
|
45
|
-
| 参数 | 简写 | 说明
|
|
46
|
-
| --------------------------------- | ---- |
|
|
47
|
-
| `--pr-number <number>` | `-p` | PR 编号
|
|
48
|
-
| `--base <ref>` | `-b` | 基准分支/tag
|
|
49
|
-
| `--head <ref>` | | 目标分支/tag
|
|
50
|
-
| `--llm-mode <mode>` | `-l` | LLM 模式（`openai` / `claude-code` / `gemini`） |
|
|
51
|
-
| `--files <files...>` | `-f` | 仅审查指定文件
|
|
52
|
-
| `--commits <commits...>` | | 仅审查指定 commits
|
|
53
|
-
| `--includes <patterns...>` | `-i` | 文件 glob 过滤模式
|
|
54
|
-
| `--verbose [level]` | `-v` | 详细输出（1: 过程日志，2: 含提示词）
|
|
55
|
-
| `--dry-run` | `-d` | 仅打印将要执行的操作
|
|
56
|
-
| `--ci` | `-c` | 在 CI 环境中运行
|
|
57
|
-
| `--verify-fixes` | | 验证历史问题是否已修复
|
|
58
|
-
| `--no-verify-fixes` | | 禁用历史问题验证
|
|
59
|
-
| `--analyze-deletions` | | 分析删除代码影响
|
|
60
|
-
| `--deletion-only` | | 仅执行删除代码分析
|
|
61
|
-
| `--deletion-analysis-mode <mode>` | |
|
|
62
|
-
| `--generate-description` | | 使用 AI 生成 PR 功能描述
|
|
63
|
-
| `--output-format <format>` | `-o` | 输出格式（`markdown` / `terminal` / `json`）
|
|
61
|
+
| 参数 | 简写 | 说明 |
|
|
62
|
+
| --------------------------------- | ---- | ------------------------------------------------------------ |
|
|
63
|
+
| `--pr-number <number>` | `-p` | PR 编号 |
|
|
64
|
+
| `--base <ref>` | `-b` | 基准分支/tag |
|
|
65
|
+
| `--head <ref>` | | 目标分支/tag |
|
|
66
|
+
| `--llm-mode <mode>` | `-l` | LLM 模式（`openai` / `claude-code` / `gemini` / `open-code`） |
|
|
67
|
+
| `--files <files...>` | `-f` | 仅审查指定文件 |
|
|
68
|
+
| `--commits <commits...>` | | 仅审查指定 commits |
|
|
69
|
+
| `--includes <patterns...>` | `-i` | 文件 glob 过滤模式 |
|
|
70
|
+
| `--verbose [level]` | `-v` | 详细输出（1: 过程日志，2: 含提示词） |
|
|
71
|
+
| `--dry-run` | `-d` | 仅打印将要执行的操作 |
|
|
72
|
+
| `--ci` | `-c` | 在 CI 环境中运行 |
|
|
73
|
+
| `--verify-fixes` | | 验证历史问题是否已修复 |
|
|
74
|
+
| `--no-verify-fixes` | | 禁用历史问题验证 |
|
|
75
|
+
| `--analyze-deletions` | | 分析删除代码影响 |
|
|
76
|
+
| `--deletion-only` | | 仅执行删除代码分析 |
|
|
77
|
+
| `--deletion-analysis-mode <mode>` | | 删除分析 LLM 模式（`openai` / `claude-code`） |
|
|
78
|
+
| `--generate-description` | | 使用 AI 生成 PR 功能描述 |
|
|
79
|
+
| `--output-format <format>` | `-o` | 输出格式（`markdown` / `terminal` / `json`） |
|
|
80
|
+
| `--local [mode]` | | 本地审查模式（`uncommitted` / `staged`，默认 `uncommitted`） |
|
|
81
|
+
| `--no-local` | | 禁用本地模式 |
|
|
82
|
+
| `--show-all` | | 显示所有问题，不过滤非变更行的问题 |
|
|
83
|
+
| `--flush` | | 仅刷新状态（同步 reactions、resolved 等），不执行 LLM 审查 |
|
|
84
|
+
| `--event-action <action>` | | PR 事件类型（`opened` / `synchronize` / `closed` 等） |
|
|
85
|
+
| `--fail-on-issues [mode]` | | 未解决问题时非零退出（`off` / `warn` / `error` / `warn+error`，默认 `error`） |
|
|
64
86
|
|
|
65
87
|
## 配置
|
|
66
88
|
|
|
@@ -71,17 +93,72 @@ spaceflow review -p 123 --deletion-only -l openai
|
|
|
71
93
|
"review": {
|
|
72
94
|
"includes": ["*/**/*.ts", "!*/**/*.spec.*", "!*/**/*.config.*"],
|
|
73
95
|
"references": ["./references"],
|
|
96
|
+
"llmMode": "openai",
|
|
74
97
|
"generateDescription": true,
|
|
98
|
+
"autoUpdatePrTitle": false,
|
|
75
99
|
"lineComments": true,
|
|
76
100
|
"verifyFixes": true,
|
|
101
|
+
"verifyFixesConcurrency": 10,
|
|
77
102
|
"analyzeDeletions": false,
|
|
103
|
+
"deletionAnalysisMode": "openai",
|
|
104
|
+
"whenModifiedCode": ["function", "class"],
|
|
105
|
+
"rules": {
|
|
106
|
+
"no-console": "warn",
|
|
107
|
+
"no-any": "error"
|
|
108
|
+
},
|
|
78
109
|
"concurrency": 5,
|
|
79
110
|
"retries": 3,
|
|
80
|
-
"retryDelay": 1000
|
|
111
|
+
"retryDelay": 1000,
|
|
112
|
+
"invalidateChangedFiles": "invalidate",
|
|
113
|
+
"duplicateWorkflowResolved": "delete",
|
|
114
|
+
"autoApprove": false,
|
|
115
|
+
"failOnIssues": "off",
|
|
116
|
+
"systemRules": {
|
|
117
|
+
"maxLinesPerFile": [500, "warn"]
|
|
118
|
+
}
|
|
81
119
|
}
|
|
82
120
|
}
|
|
83
121
|
```
|
|
84
122
|
|
|
123
|
+
### 配置项说明
|
|
124
|
+
|
|
125
|
+
| 字段 | 类型 | 默认值 | 说明 |
|
|
126
|
+
| ---------------------------- | ---------------------------------------- | -------------- | ---------------------------------------------------------------------- |
|
|
127
|
+
| `includes` | `string[]` | — | 文件 glob 过滤模式 |
|
|
128
|
+
| `references` | `string[]` | — | 审查规范来源（本地路径或远程仓库 URL） |
|
|
129
|
+
| `llmMode` | `string` | `"openai"` | 默认 LLM 模式 |
|
|
130
|
+
| `generateDescription` | `boolean` | `false` | AI 生成 PR 功能描述 |
|
|
131
|
+
| `autoUpdatePrTitle` | `boolean` | `false` | 自动更新 PR 标题 |
|
|
132
|
+
| `lineComments` | `boolean` | `false` | 在 PR 中发布行级评论 |
|
|
133
|
+
| `verifyFixes` | `boolean` | `false` | 验证历史问题是否已修复 |
|
|
134
|
+
| `verifyFixesConcurrency` | `number` | `10` | 验证并发数 |
|
|
135
|
+
| `analyzeDeletions` | `boolean \| "ci" \| "pr" \| "terminal"` | `false` | 删除代码分析（`true`: 始终启用，`"ci"`: 仅 CI，`"pr"`: 仅 PR，`"terminal"`: 仅终端） |
|
|
136
|
+
| `deletionAnalysisMode` | `string` | `"openai"` | 删除分析 LLM 模式 |
|
|
137
|
+
| `whenModifiedCode` | `string[]` | — | 代码结构过滤（`"function"` / `"class"` / `"interface"` / `"type"` / `"method"`） |
|
|
138
|
+
| `rules` | `Record<string, "off" \| "warn" \| "error">` | — | 逐规则严重级别覆盖 |
|
|
139
|
+
| `concurrency` | `number` | `5` | LLM 并发审查数 |
|
|
140
|
+
| `retries` | `number` | `0` | 失败重试次数 |
|
|
141
|
+
| `retryDelay` | `number` | `1000` | 重试间隔（ms） |
|
|
142
|
+
| `invalidateChangedFiles` | `"invalidate" \| "keep" \| "off"` | `"invalidate"` | 变更文件历史问题处理策略 |
|
|
143
|
+
| `duplicateWorkflowResolved` | `"off" \| "skip" \| "delete"` | `"delete"` | 重复 workflow 处理策略 |
|
|
144
|
+
| `autoApprove` | `boolean` | `false` | 所有问题解决后自动提交 APPROVE review |
|
|
145
|
+
| `failOnIssues` | `"off" \| "warn" \| "error" \| "warn+error"` | `"off"` | 问题阻断模式 |
|
|
146
|
+
| `systemRules` | `object` | — | 系统规则（不依赖 LLM 的静态检查） |
|
|
147
|
+
| `systemRules.maxLinesPerFile`| `[number, "off" \| "warn" \| "error"]` | — | 单文件最大审查行数，超过时跳过 LLM 并生成系统问题 |
|
|
148
|
+
|
|
149
|
+
## MCP 工具
|
|
150
|
+
|
|
151
|
+
本扩展提供以下 MCP 工具，可在 AI 编辑器（如 Cursor、Windsurf）中使用：
|
|
152
|
+
|
|
153
|
+
| 工具名 | 说明 | 参数 |
|
|
154
|
+
| ---------------------- | ------------------------------------------ | ----------------------------------------------- |
|
|
155
|
+
| `list_rules` | 列出所有审查规则 | — |
|
|
156
|
+
| `get_rules_for_file` | 获取指定文件适用的审查规则 | `filePath`, `includeExamples?` |
|
|
157
|
+
| `get_rule_detail` | 获取单条规则的详细信息 | `ruleId` |
|
|
158
|
+
| `get_rules_from_dir` | 从指定目录加载审查规则 | `dirPath`, `includeExamples?` |
|
|
159
|
+
|
|
160
|
+
规则搜索目录包括：`review.references` 配置路径、`.claude/skills`、`.cursor/skills`、`review-specs`。
|
|
161
|
+
|
|
85
162
|
## PR 标题参数
|
|
86
163
|
|
|
87
164
|
支持在 PR 标题末尾添加参数覆盖默认配置：
|
|
@@ -109,15 +186,49 @@ jobs:
|
|
|
109
186
|
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
|
|
110
187
|
```
|
|
111
188
|
|
|
189
|
+
### CI 门禁示例
|
|
190
|
+
|
|
191
|
+
存在 `error` 级别未解决问题时阻止合并：
|
|
192
|
+
|
|
193
|
+
```yaml
|
|
194
|
+
- run: pnpm spaceflow review --ci -l openai --fail-on-issues
|
|
195
|
+
env:
|
|
196
|
+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
197
|
+
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
|
|
198
|
+
```
|
|
199
|
+
|
|
112
200
|
## 环境变量
|
|
113
201
|
|
|
202
|
+
### Git Provider
|
|
203
|
+
|
|
114
204
|
| 变量 | 说明 |
|
|
115
205
|
| ------------------- | ----------------------------- |
|
|
116
206
|
| `GITHUB_TOKEN` | GitHub API Token |
|
|
117
207
|
| `GITHUB_REPOSITORY` | 仓库名称（`owner/repo` 格式） |
|
|
118
|
-
| `
|
|
119
|
-
| `
|
|
120
|
-
| `
|
|
208
|
+
| `GITEA_TOKEN` | Gitea API Token |
|
|
209
|
+
| `GITEA_REPOSITORY` | Gitea 仓库名称 |
|
|
210
|
+
| `GITLAB_TOKEN` | GitLab API Token |
|
|
211
|
+
| `GITLAB_REPOSITORY` | GitLab 仓库名称 |
|
|
212
|
+
|
|
213
|
+
### OpenAI
|
|
214
|
+
|
|
215
|
+
| 变量 | 说明 |
|
|
216
|
+
| ----------------- | --------------- |
|
|
217
|
+
| `OPENAI_BASE_URL` | OpenAI API 地址 |
|
|
218
|
+
| `OPENAI_API_KEY` | OpenAI API Key |
|
|
219
|
+
| `OPENAI_MODEL` | OpenAI 模型名称 |
|
|
220
|
+
|
|
221
|
+
### Claude Code
|
|
222
|
+
|
|
223
|
+
| 变量 | 说明 |
|
|
224
|
+
| ------------------- | ---------------- |
|
|
225
|
+
| `ANTHROPIC_API_KEY` | Anthropic API Key |
|
|
226
|
+
|
|
227
|
+
### Gemini
|
|
228
|
+
|
|
229
|
+
| 变量 | 说明 |
|
|
230
|
+
| ------------------ | -------------- |
|
|
231
|
+
| `GEMINI_API_KEY` | Gemini API Key |
|
|
121
232
|
|
|
122
233
|
## 许可证
|
|
123
234
|
|