@localsummer/incspec 0.1.1 → 0.1.2

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/README.md CHANGED
@@ -4,6 +4,7 @@
4
4
  <p align="center">面向 AI 编程助手的增量规范驱动开发工具</p>
5
5
  <p align="center">
6
6
  <a href="https://github.com/localSummer/IncSpec"><img alt="GitHub" src="https://img.shields.io/badge/GitHub-localSummer%2FIncSpec-blue?style=flat-square&logo=github" /></a>
7
+ <a href="https://www.npmjs.com/package/@localsummer/incspec"><img alt="npm" src="https://img.shields.io/npm/v/@localsummer/incspec?style=flat-square&logo=npm" /></a>
7
8
  <a href="https://nodejs.org/"><img alt="node version" src="https://img.shields.io/node/v/@localsummer/incspec?style=flat-square" /></a>
8
9
  <a href="./LICENSE"><img alt="License: ISC" src="https://img.shields.io/badge/License-ISC-blue.svg?style=flat-square" /></a>
9
10
  </p>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@localsummer/incspec",
3
- "version": "0.1.1",
3
+ "version": "0.1.2",
4
4
  "description": "面向 AI 编程助手的增量规范驱动开发工具",
5
5
  "bin": {
6
6
  "incspec": "index.mjs"
@@ -19,7 +19,7 @@ AI 编码助手使用 IncSpec 进行增量规格驱动开发的操作指南。
19
19
  - 检查状态: `incspec status`
20
20
  - 编号引用: `[S1]` 时序步骤, `[D1]` 依赖, `[C1]` 变更
21
21
  - 增量标记: `[N1]` 新增, `[S1-Modified]` 修改, `[S1-Deleted]` 删除
22
- - 继续前验证: `incspec validate --strict`
22
+ - 验证时机: 步骤 1/4/6 完成后、归档前执行 `incspec validate`,出错时加 `--strict` 用于 CI
23
23
 
24
24
  ## 七步工作流
25
25
 
@@ -38,6 +38,8 @@ AI 编码助手使用 IncSpec 进行增量规格驱动开发的操作指南。
38
38
 
39
39
  **交付物**: Mermaid 时序图 (`[S1]`-`[Sn]`)、依赖图 (`[D1]`-`[Dn]`)、依赖摘要 (`[R1.x]`-`[R3.x]`)
40
40
 
41
+ **验证**: 完成后执行 `incspec validate` 检查基线格式(必含时序图和依赖图)
42
+
41
43
  ### 步骤 2: 收集结构化需求
42
44
 
43
45
  **命令**: `incspec collect-req` (别名: `cr`)
@@ -75,6 +77,8 @@ AI 编码助手使用 IncSpec 进行增量规格驱动开发的操作指南。
75
77
  6. 潜在风险与副作用
76
78
  7. 建议的测试用例 (至少6个)
77
79
 
80
+ **验证**: 完成后执行 `incspec validate` 检查增量格式(必含5个模块章节)
81
+
78
82
  ### 步骤 5: 应用代码变更
79
83
 
80
84
  **命令**: `incspec apply [increment-path]` (别名: `ap`)
@@ -93,12 +97,16 @@ AI 编码助手使用 IncSpec 进行增量规格驱动开发的操作指南。
93
97
 
94
98
  **处理**: 移除增量标记 → 合并新节点 → 重新编号为干净序列 → 输出新基线 v{n+1}
95
99
 
100
+ **验证**: 完成后执行 `incspec validate` 检查新基线完整性
101
+
96
102
  ### 步骤 7: 归档工作流产出
97
103
 
98
104
  **命令**: `incspec archive [--yes] [<file>] [--keep]`
99
105
 
100
106
  **目的**: 将已完成的工作流产出归档到 `incspec/archives/YYYY-MM/{module}/`
101
107
 
108
+ **验证**: 归档前执行 `incspec validate` 确保项目健康,归档后再次验证确保文件移动正确
109
+
102
110
  ## 目录结构
103
111
 
104
112
  ```
@@ -100,7 +100,8 @@ description: 设计优先的前端功能增量编码工作流。适用于实现
100
100
  管理命令:
101
101
  - `incspec status` - 查看工作流状态
102
102
  - `incspec list` - 列出规范文件
103
- - `incspec validate` - 验证项目健康状态
103
+ - `incspec validate` - 验证项目健康状态(步骤1/4/6后、归档前执行)
104
+ - `incspec validate --strict` - 严格模式,有错误时退出码为1(用于CI)
104
105
  - `incspec reset` - 重置工作流到初始状态
105
106
  - `incspec reset --to=N` - 回退到步骤N,保留1-N,重置N+1至7(示例:`--to=3` 保留1-3,重置4-7)
106
107
 
@@ -123,6 +124,8 @@ description: 设计优先的前端功能增量编码工作流。适用于实现
123
124
  - 组件/Store依赖关系图
124
125
  - 数据流摘要
125
126
 
127
+ **验证:** 完成后执行 `incspec validate` 检查基线格式(必含时序图和依赖图)
128
+
126
129
  详见 [references/analyze-codeflow.md](references/analyze-codeflow.md)。
127
130
 
128
131
  ### 步骤2: 需求收集
@@ -165,6 +168,8 @@ description: 设计优先的前端功能增量编码工作流。适用于实现
165
168
  - 文件修改计划 (新增/修改/删除)
166
169
  - 分步实现指导
167
170
 
171
+ **验证:** 完成后执行 `incspec validate` 检查增量格式(必含5个模块章节)
172
+
168
173
  详见 [references/analyze-increment-codeflow.md](references/analyze-increment-codeflow.md)。
169
174
 
170
175
  ### 步骤5: 代码应用
@@ -188,6 +193,8 @@ description: 设计优先的前端功能增量编码工作流。适用于实现
188
193
 
189
194
  **输出:** 代表当前系统状态的干净基线(无增量标记)
190
195
 
196
+ **验证:** 完成后执行 `incspec validate` 检查新基线完整性
197
+
191
198
  详见 [references/merge-to-baseline.md](references/merge-to-baseline.md)。
192
199
 
193
200
  ### 步骤7: 归档
@@ -203,6 +210,8 @@ incspec archive <file> --yes # 归档指定文件
203
210
  incspec archive <file> --keep # 复制而非移动
204
211
  ```
205
212
 
213
+ **验证:** 归档前执行 `incspec validate` 确保项目健康,归档后再次验证确保文件移动正确
214
+
206
215
  详见 [references/inc-archive.md](references/inc-archive.md)。
207
216
 
208
217
  ## 最佳实践
@@ -220,10 +229,12 @@ incspec archive <file> --keep # 复制而非移动
220
229
  - 仅在变更范围明确、不涉及复杂依赖时使用快速模式
221
230
 
222
231
  **验证节点:**
232
+ - 步骤1后: `incspec validate` 检查基线格式(必含时序图和依赖图)
223
233
  - 步骤2后: 需求中无模糊术语
224
- - 步骤4后 (完整模式): 编码前审查蓝图
234
+ - 步骤4后 (完整模式): `incspec validate` 检查增量格式 + 编码前审查蓝图
225
235
  - 步骤5后: 验证所有文件已正确创建/修改
226
- - 步骤7后: 确认工作区已清理
236
+ - 步骤6后: `incspec validate` 检查新基线完整性
237
+ - 步骤7前后: 归档前后各执行 `incspec validate` 确保项目健康
227
238
 
228
239
  **工作流重置:**
229
240
  - 完全重置: `incspec reset` - 归档所有产出,回到初始状态