@gong-ym/ai-spec-auto 0.2.12 → 0.2.14

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.
@@ -1,9 +1,9 @@
1
1
  ---
2
2
  name: branch-code-reviewer
3
3
  description: 分支代码评审专家。将功能分支与主分支(master/main)进行代码比对分析,自动识别技术风险和业务风险,生成可视化HTML评审报告。当需要进行分支间代码评审、合并前代码检查、代码质量分析时使用。
4
- compatibility: Requires git repository with at least two branches. Works best when combined with requirement documentation for business risk analysis.
4
+ compatibility: Requires git repository with at least two branches. Supports both requirement documentation mode and project documentation mode for business risk analysis.
5
5
  metadata:
6
- version: "1.0.0"
6
+ version: "1.1.0"
7
7
  openclaw-user-invocable: "true"
8
8
  type: flexible
9
9
  category: code-review
@@ -55,20 +55,35 @@ metadata:
55
55
  - 如果用户指定了分支,使用用户指定的分支
56
56
  - 如果用户未指定,使用当前分支作为功能分支,自动检测主分支(优先 master,其次 main)
57
57
 
58
- 3. **重要**: 询问用户是否提供本次开发需求的文档:
58
+ 3. **重要**: 首先检查本次开发是否已有需求文档归档:
59
+ ```bash
60
+ # 检查 .ai-spec/ 目录下是否有本次开发的需求文档
61
+ ls .ai-spec/ | grep -E "(spec|proposal|requirement|prd)"
62
+ ```
63
+
64
+ 然后根据情况询问用户:
59
65
  ```
60
- 请提供本次开发需求的文档路径(可选),用于业务风险分析:
61
- - 需求文档类型: PRD / 用户故事 / 需求规格说明 / 其他
62
- - 文档路径: [用户输入或留空]
66
+ 请选择本次业务审查的模式:
63
67
 
64
- 如果不提供需求文档,将仅进行技术类风险分析。
68
+ 1. 需求文档模式(推荐) - 使用本次开发归档的需求文档进行审查
69
+ - 适用场景:使用 OpenSpec/Superpowers 完成的需求开发,已有需求文档归档到 .ai-spec/
70
+ - 文档路径: [.ai-spec/ 下的需求文档]
71
+
72
+ 2. 外部需求文档 - 提供本次开发的需求文档路径
73
+ - 适用场景:需求文档在其他位置(PRD、用户故事等)
74
+ - 文档路径: [用户输入]
75
+
76
+ 3. 项目说明模式 - 基于项目说明文档和 master 基线进行泛类审查
77
+ - 适用场景:重构、优化、技术债清理等无明确需求文档的场景
78
+
79
+ 请输入选项编号(1/2/3),或直接提供文档路径(默认模式1):
80
+ [用户输入]
65
81
  ```
66
82
 
67
- 4. 如果用户提供了需求文档,读取并分析:
68
- - 核心业务目标
69
- - 关键功能点
70
- - 业务约束与规则
71
- - 验收标准
83
+ 4. 根据用户选择执行:
84
+ - **模式1(归档需求文档)**: 读取 `.ai-spec/` 目录下的需求文档,分析核心业务目标、关键功能点、业务约束与规则、验收标准
85
+ - **模式2(外部需求文档)**: 读取用户提供的需求文档路径,分析核心业务目标、关键功能点、业务约束与规则、验收标准
86
+ - **模式3(项目说明)**: 读取项目说明文档(README.md/PROJECT.md等),提取项目定位、核心能力、关键业务模块、既有业务规则
72
87
 
73
88
  5. 输出确认信息:
74
89
  ```
@@ -172,13 +187,18 @@ metadata:
172
187
  - 更优的实现方式
173
188
  - 代码简化建议
174
189
 
175
- ### 第四步:业务类风险分析(如果提供了需求文档)
190
+ ### 第四步:业务类风险分析
176
191
 
177
192
  **强制输出标题**: `### 第四步:业务风险分析`
178
193
 
179
- **仅当用户提供需求文档时执行此步骤**。
194
+ **业务审查的三种模式**:
195
+ 1. **需求文档模式(推荐)**: 使用本次开发归档到 `.ai-spec/` 的需求文档进行审查
196
+ 2. **外部需求文档**: 用户提供本次开发的需求文档路径
197
+ 3. **项目说明模式**: 如果没有需求文档,读取项目说明文档(如 README.md、PROJECT.md、01-项目概述.md等),结合 master 分支的代码基线,进行泛类业务审查
180
198
 
181
- #### 4.1 需求覆盖度检查
199
+ #### 4.1 模式一:需求文档覆盖度检查(推荐模式)
200
+
201
+ **优先使用本次开发归档到 `.ai-spec/` 的需求文档**。
182
202
 
183
203
  对比代码变更与需求文档,检查:
184
204
 
@@ -187,33 +207,76 @@ metadata:
187
207
  - **业务规则**: 代码实现是否符合业务规则
188
208
  - **边界场景**: 需求文档中提到的边界场景是否都处理了
189
209
 
190
- #### 4.2 业务逻辑风险
210
+ #### 4.2 模式二:外部需求文档审查
211
+
212
+ 用户提供本次开发的需求文档路径,检查内容同模式一。
191
213
 
192
- 识别以下业务风险:
214
+ #### 4.3 模式三:项目说明与基线对比审查(通用模式)
193
215
 
194
- - **流程缺失**: 关键业务流程是否遗漏
195
- - 例如:订单创建后缺少支付流程
196
-
197
- - **状态不一致**: 业务状态流转是否正确
198
- - 例如:订单状态从"待支付"直接跳到"已完成",缺少"已支付"状态
216
+ **当没有需求文档时,执行此模式**。
199
217
 
200
- - **数据一致性**: 数据操作是否符合业务约束
201
- - 例如:库存扣减与订单创建不在同一事务
218
+ 1. **读取项目说明文档**:
219
+ - 优先读取: `README.md`、`PROJECT.md`、`01-项目概述.md`、`docs/` 目录下的项目说明
220
+ - 提取信息:
221
+ - 项目定位与核心能力
222
+ - 关键业务模块与功能
223
+ - 技术栈与架构约束
224
+ - 已有的业务规则与流程
202
225
 
203
- - **权限与合规**: 是否符合业务权限要求
204
- - 例如:未校验用户权限即可操作敏感数据
226
+ 2. **对比 master 分支基线**:
227
+ - 分析功能分支相对于 master 的变更范围
228
+ - 识别变更是否影响核心业务流程
229
+ - 检查新增代码是否与项目既有业务逻辑一致
205
230
 
206
- - **异常场景**: 业务异常场景是否处理
207
- - 例如:支付失败后的回滚逻辑
208
- - 例如:库存不足时的降级方案
231
+ 3. **泛类业务审查维度**:
232
+
233
+ - **业务流程完整性**:
234
+ - 关键业务流程是否遗漏(如:创建→审批→执行→归档)
235
+ - 新增功能是否缺少上下游衔接
236
+ - 例如:新增订单创建但缺少支付/退款流程
237
+
238
+ - **状态流转一致性**:
239
+ - 业务状态流转是否符合项目既有模式
240
+ - 是否存在状态跳跃或缺失中间态
241
+ - 例如:订单状态从"待支付"直接到"已完成",缺少"已支付"
242
+
243
+ - **数据约束与一致性**:
244
+ - 数据操作是否符合项目已有的数据约束
245
+ - 关键业务数据是否缺少校验
246
+ - 例如:金额字段缺少精度校验,库存扣减不在事务中
247
+
248
+ - **权限与合规性**:
249
+ - 是否符合项目既有的权限控制模式
250
+ - 敏感操作是否缺少权限校验
251
+ - 例如:未校验用户角色即可删除核心数据
252
+
253
+ - **异常场景处理**:
254
+ - 业务异常是否有降级方案
255
+ - 失败场景是否有补偿机制
256
+ - 例如:支付失败后无回滚逻辑,接口超时无重试
257
+
258
+ - **与既有代码的一致性**:
259
+ - 新增代码是否遵循项目既有的业务抽象
260
+ - 是否重复实现了已有的业务逻辑
261
+ - 例如:项目已有统一的审批流引擎,但新代码自己实现了一套
209
262
 
210
263
  #### 4.3 业务改进建议
211
264
 
212
- 输出具体的:
265
+ 根据审查模式输出:
266
+
267
+ **需求文档模式(模式1/2)**:
213
268
  - 缺失功能点清单
214
269
  - 业务逻辑修正建议
215
270
  - 流程补充建议
216
271
  - 风险控制建议
272
+ - 需求覆盖度评分
273
+
274
+ **项目说明模式(模式3)**:
275
+ - 与项目既有业务逻辑不一致的代码清单
276
+ - 可能缺失的业务流程环节
277
+ - 建议补充的异常处理场景
278
+ - 可复用的项目既有业务抽象
279
+ - 业务一致性评分
217
280
 
218
281
  ### 第五步:生成可视化 HTML 报告
219
282
 
@@ -272,18 +335,18 @@ metadata:
272
335
  - 示例代码
273
336
  - 关联到具体代码行
274
337
 
275
- ##### 5. 业务风险区(Business Risks) - 如果有需求文档
338
+ ##### 5. 业务风险区(Business Risks) - 如果有业务风险分析
276
339
 
277
- 业务风险分析结果:
340
+ 业务风险分析结果(需求文档模式或项目说明模式):
278
341
 
279
- - 需求覆盖度评分
280
- - 缺失功能点清单
342
+ - 需求覆盖度评分(需求文档模式) / 业务一致性评分(项目说明模式)
343
+ - 缺失功能点清单 / 与既有业务逻辑不一致的代码清单
281
344
  - 业务逻辑风险
282
345
  - 流程缺失警告
283
346
  - 状态不一致问题
284
347
  - 数据一致性问题
285
348
  - 每个业务风险关联到:
286
- - 需求文档章节
349
+ - 需求文档章节(需求文档模式) / 项目说明文档(项目说明模式)
287
350
  - 相关代码文件
288
351
  - 风险等级
289
352
  - 修复建议
@@ -361,7 +424,9 @@ metadata:
361
424
  - ✅ HTML 必须是自包含的,复制文件到任何地方都能正常打开
362
425
  - ✅ 保持代码原有的缩进和格式
363
426
  - ✅ 中文界面,评审意见使用中文
364
- - ✅ 如果提供了需求文档,必须进行业务风险分析
427
+ - ✅ 优先使用本次开发归档到 `.ai-spec/` 的需求文档进行业务审查
428
+ - ✅ 如果用户选择需求文档模式,必须进行需求覆盖度审查
429
+ - ✅ 如果用户选择项目说明模式,必须基于项目说明和 master 基线进行泛类业务审查
365
430
  - ✅ 技术风险和业务风险分开展示,但关联到相同代码
366
431
 
367
432
  ### 禁止做到:
@@ -371,7 +436,7 @@ metadata:
371
436
  - ❌ 不得忽略任何变更文件
372
437
  - ❌ 不得给出模糊的评审意见(如"代码需要优化")
373
438
  - ❌ 不得修改任何源代码文件
374
- - ❌ 不得在没有需求文档的情况下臆测业务风险
439
+ - ❌ 不得在没有项目说明文档的情况下臆测业务风险
375
440
 
376
441
  ---
377
442
 
@@ -398,25 +463,33 @@ metadata:
398
463
 
399
464
  ## 示例用法
400
465
 
401
- ### 示例 1: 仅技术风险分析
466
+ ### 示例 1: 技术 + 业务风险分析(项目说明模式)
402
467
 
403
468
  ```
404
469
  用户: 评审当前分支
405
470
 
406
471
  AI: ### 第一步:确认评审上下文
407
472
 
408
- 请提供本次开发需求的文档路径(可选),用于业务风险分析:
409
- - 如果不提供,将仅进行技术类风险分析。
473
+ 请选择本次业务审查的模式:
474
+
475
+ 1. 需求文档模式 - 提供本次开发的需求文档,对照需求审查
476
+ 2. 项目说明模式 - 基于项目说明文档和 master 基线进行泛类审查
410
477
 
478
+ 请提供需求文档路径(选1时),或直接回车使用项目说明模式(选2):
411
479
  [用户留空]
412
480
 
481
+ 已读取项目说明: README.md
482
+ - 项目定位: 风控管理系统
483
+ - 核心能力: 规则引擎、审批流、数据权限
484
+ - 关键业务模块: 规则配置、风险预警、审计日志
485
+
413
486
  ✅ 评审上下文已确认:
414
- - 功能分支: feature/user-management
487
+ - 功能分支: feature/rule-optimization
415
488
  - 主分支: main
416
- - 需求文档: 未提供
417
- - 评审范围: 仅技术风险
489
+ - 审查模式: 项目说明模式
490
+ - 评审范围: 技术风险 + 业务风险
418
491
 
419
- [继续执行技术风险分析...]
492
+ [继续执行技术 + 业务风险分析...]
420
493
  ```
421
494
 
422
495
  ### 示例 2: 技术 + 业务风险分析
@@ -456,4 +529,5 @@ AI: ### 第一步:确认评审上下文
456
529
 
457
530
  ## 版本历史
458
531
 
532
+ - **v1.1.0** (2026-06-26): 支持双模式业务审查(需求文档模式 + 项目说明模式),新增泛类业务审查维度
459
533
  - **v1.0.0** (2026-06-22): 初始版本,支持技术风险分析、业务风险分析、可视化 HTML 报告生成
package/.qoder/README.md CHANGED
@@ -1,114 +1,114 @@
1
- # Qoder IDE 适配说明
2
-
3
- ## 概述
4
-
5
- `ai-spec-auto` 现已支持 **Qoder IDE**。Qoder 是一款面向 AI 辅助开发的智能 IDE,提供强大的代码理解和生成能力。
6
-
7
- ## 安装 Qoder 适配
8
-
9
- ### 方式 1: 默认安装(包含 Qoder)
10
-
11
- ```bash
12
- npx @engineered/ai-spec-auto@latest init . --ide all
13
- ```
14
-
15
- ### 方式 2: 仅安装 Qoder
16
-
17
- ```bash
18
- npx @engineered/ai-spec-auto@latest init . --ide qoder
19
- ```
20
-
21
- ### 方式 3: 组合安装
22
-
23
- ```bash
24
- # Qoder + Cursor
25
- npx @engineered/ai-spec-auto@latest init . --ide qoder,cursor
26
-
27
- # Qoder + Claude Code
28
- npx @engineered/ai-spec-auto@latest init . --ide qoder,claude
29
- ```
30
-
31
- ## 安装后的目录结构
32
-
33
- ```
34
- .your-project/
35
- ├── .qoder/
36
- │ ├── rules/ → 链接到 .agents/rules/
37
- │ ├── skills/ → 链接到 .agents/skills/
38
- │ └── commands/ → 协议命令模板
39
- │ ├── spec-start.md
40
- │ ├── spec-continue.md
41
- │ ├── spec-update.md
42
- │ ├── spec-status.md
43
- │ └── spec-stop.md
44
- ├── .agents/ # 规范源
45
- │ ├── rules/
46
- │ └── skills/
47
- └── .ai-spec/ # 运行态数据
48
- ```
49
-
50
- ## 可用命令
51
-
52
- 安装完成后,在 Qoder 中可以使用以下协议命令:
53
-
54
- | 命令 | 用途 |
55
- |------|------|
56
- | `/spec-start` | 新建一个需求交付 run |
57
- | `/spec-continue` | 继续或恢复当前 run |
58
- | `/spec-update` | 增量补充需求、修正方向 |
59
- | `/spec-status` | 查看当前阶段、门禁和下一步 |
60
- | `/spec-stop` | 暂停当前 run |
61
-
62
- ## 配置示例
63
-
64
- ### MCP 配置(可选)
65
-
66
- 如果 Qoder 支持 MCP(Model Context Protocol),可以创建 `.qoder/mcp.json`:
67
-
68
- ```json
69
- {
70
- "mcpServers": {
71
- "ai-spec-auto": {
72
- "command": "npx",
73
- "args": ["@engineered/ai-spec-auto@latest"]
74
- }
75
- }
76
- }
77
- ```
78
-
79
- ## 更新 Qoder 适配
80
-
81
- ```bash
82
- # 更新所有 IDE 适配
83
- npx @engineered/ai-spec-auto@latest update .
84
-
85
- # 仅更新 Qoder
86
- npx @engineered/ai-spec-auto@latest update . --ide qoder
87
- ```
88
-
89
- ## 检查安装
90
-
91
- ```bash
92
- npx @engineered/ai-spec-auto@latest check .
93
- ```
94
-
95
- 检查输出中应该包含:
96
- ```
97
- ✅ .qoder/rules 链接有效
98
- ✅ .qoder/skills (N 个链接)
99
- ✅ 协议命令可用
100
- ```
101
-
102
- ## 卸载 Qoder 适配
103
-
104
- ```bash
105
- npx @engineered/ai-spec-auto@latest uninstall .
106
- ```
107
-
108
- 这将移除 `.qoder/` 目录及其中的所有链接和命令模板。
109
-
110
- ## 技术支持
111
-
112
- - 项目仓库: https://github.com/Colouful/engineered-spec
113
- - 问题反馈: https://github.com/Colouful/engineered-spec/issues
114
- - 文档索引: docs/README.md
1
+ # Qoder IDE 适配说明
2
+
3
+ ## 概述
4
+
5
+ `ai-spec-auto` 现已支持 **Qoder IDE**。Qoder 是一款面向 AI 辅助开发的智能 IDE,提供强大的代码理解和生成能力。
6
+
7
+ ## 安装 Qoder 适配
8
+
9
+ ### 方式 1: 默认安装(包含 Qoder)
10
+
11
+ ```bash
12
+ npx @engineered/ai-spec-auto@latest init . --ide all
13
+ ```
14
+
15
+ ### 方式 2: 仅安装 Qoder
16
+
17
+ ```bash
18
+ npx @engineered/ai-spec-auto@latest init . --ide qoder
19
+ ```
20
+
21
+ ### 方式 3: 组合安装
22
+
23
+ ```bash
24
+ # Qoder + Cursor
25
+ npx @engineered/ai-spec-auto@latest init . --ide qoder,cursor
26
+
27
+ # Qoder + Claude Code
28
+ npx @engineered/ai-spec-auto@latest init . --ide qoder,claude
29
+ ```
30
+
31
+ ## 安装后的目录结构
32
+
33
+ ```
34
+ .your-project/
35
+ ├── .qoder/
36
+ │ ├── rules/ → 链接到 .agents/rules/
37
+ │ ├── skills/ → 链接到 .agents/skills/
38
+ │ └── commands/ → 协议命令模板
39
+ │ ├── spec-start.md
40
+ │ ├── spec-continue.md
41
+ │ ├── spec-update.md
42
+ │ ├── spec-status.md
43
+ │ └── spec-stop.md
44
+ ├── .agents/ # 规范源
45
+ │ ├── rules/
46
+ │ └── skills/
47
+ └── .ai-spec/ # 运行态数据
48
+ ```
49
+
50
+ ## 可用命令
51
+
52
+ 安装完成后,在 Qoder 中可以使用以下协议命令:
53
+
54
+ | 命令 | 用途 |
55
+ |------|------|
56
+ | `/spec-start` | 新建一个需求交付 run |
57
+ | `/spec-continue` | 继续或恢复当前 run |
58
+ | `/spec-update` | 增量补充需求、修正方向 |
59
+ | `/spec-status` | 查看当前阶段、门禁和下一步 |
60
+ | `/spec-stop` | 暂停当前 run |
61
+
62
+ ## 配置示例
63
+
64
+ ### MCP 配置(可选)
65
+
66
+ 如果 Qoder 支持 MCP(Model Context Protocol),可以创建 `.qoder/mcp.json`:
67
+
68
+ ```json
69
+ {
70
+ "mcpServers": {
71
+ "ai-spec-auto": {
72
+ "command": "npx",
73
+ "args": ["@engineered/ai-spec-auto@latest"]
74
+ }
75
+ }
76
+ }
77
+ ```
78
+
79
+ ## 更新 Qoder 适配
80
+
81
+ ```bash
82
+ # 更新所有 IDE 适配
83
+ npx @engineered/ai-spec-auto@latest update .
84
+
85
+ # 仅更新 Qoder
86
+ npx @engineered/ai-spec-auto@latest update . --ide qoder
87
+ ```
88
+
89
+ ## 检查安装
90
+
91
+ ```bash
92
+ npx @engineered/ai-spec-auto@latest check .
93
+ ```
94
+
95
+ 检查输出中应该包含:
96
+ ```
97
+ ✅ .qoder/rules 链接有效
98
+ ✅ .qoder/skills (N 个链接)
99
+ ✅ 协议命令可用
100
+ ```
101
+
102
+ ## 卸载 Qoder 适配
103
+
104
+ ```bash
105
+ npx @engineered/ai-spec-auto@latest uninstall .
106
+ ```
107
+
108
+ 这将移除 `.qoder/` 目录及其中的所有链接和命令模板。
109
+
110
+ ## 技术支持
111
+
112
+ - 项目仓库: https://github.com/gong-chick/engineered-spec
113
+ - 问题反馈: https://github.com/gong-chick/engineered-spec/issues
114
+ - 文档索引: docs/README.md
package/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2026 Colouful
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2026 gong-chick
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.