sillyspec 3.13.0 → 3.14.1
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/package.json +2 -1
- package/src/index.js +134 -0
- package/src/init.js +16 -0
- package/src/run.js +159 -0
- package/src/stages/archive.js +12 -34
- package/src/stages/scan.js +80 -86
- package/src/workflow.js +670 -0
- package/templates/workflows/archive-impact.yaml +79 -0
- package/templates/workflows/scan-docs.yaml +132 -0
package/src/stages/scan.js
CHANGED
|
@@ -37,117 +37,104 @@ export const definition = {
|
|
|
37
37
|
optional: false
|
|
38
38
|
},
|
|
39
39
|
{
|
|
40
|
-
name: '
|
|
41
|
-
prompt:
|
|
40
|
+
name: '构建扫描项目列表',
|
|
41
|
+
prompt: `确定本次要扫描的项目列表。
|
|
42
42
|
|
|
43
43
|
### 操作
|
|
44
|
-
1. \`ls .sillyspec/projects/*.yaml 2>/dev/null
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
44
|
+
1. \`ls .sillyspec/projects/*.yaml 2>/dev/null\` — 列出所有已注册项目
|
|
45
|
+
2. 对每个项目,检查已有的 scan 文档状态:\`ls .sillyspec/docs/<project>/scan/*.md 2>/dev/null\`
|
|
46
|
+
3. 按以下格式展示:
|
|
47
|
+
|
|
48
|
+
\`\`\`
|
|
49
|
+
扫描项目列表:
|
|
50
|
+
1. sillyspec(主项目)— scan 文档:0/7 已存在
|
|
51
|
+
2. dashboard(子项目)— scan 文档:0/7 已存在
|
|
52
|
+
\`\`\`
|
|
53
|
+
|
|
54
|
+
4. **必须停下来问用户**:
|
|
55
|
+
- 选择要扫描的项目(默认全部)
|
|
56
|
+
- 每个项目的扫描策略:**重新扫描(全部覆盖)** / **只补扫描缺失的文档** / **跳过**
|
|
57
|
+
|
|
58
|
+
### ⛔ 重要
|
|
53
59
|
- **不要自行决定跳过**,等用户选择后再继续
|
|
60
|
+
- 最终确定的项目列表将用于后续所有步骤
|
|
61
|
+
- **后续每个需要生成文档的步骤,都必须对列表中的每个项目分别执行**
|
|
54
62
|
|
|
55
63
|
### 输出
|
|
56
|
-
|
|
57
|
-
outputHint: '
|
|
64
|
+
确认后的扫描项目列表(项目名 + 扫描策略)`,
|
|
65
|
+
outputHint: '扫描项目列表',
|
|
58
66
|
optional: false
|
|
59
67
|
},
|
|
60
68
|
{
|
|
61
69
|
name: '构建环境探测',
|
|
62
|
-
|
|
70
|
+
perProject: true,
|
|
71
|
+
prompt: `探测当前项目的构建环境和依赖。
|
|
63
72
|
|
|
64
73
|
### 操作
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
74
|
+
对扫描列表中的每个项目重复以下操作:
|
|
75
|
+
1. 进入项目目录(子项目用其 path,如 \`packages/dashboard/\`)
|
|
76
|
+
2. \`cat package.json pom.xml build.gradle go.mod Cargo.toml requirements.txt pyproject.toml Gemfile composer.json 2>/dev/null\`
|
|
77
|
+
3. \`find <project-dir> -maxdepth 2 -name "*.config.*" -not -path "*/node_modules/*" -not -path "*/.git/*" | head -20 | xargs cat 2>/dev/null\`
|
|
78
|
+
4. 结果保存到 \`.sillyspec/docs/<project>/scan/_env-detect.md\`(临时文件,扫描完删除)
|
|
68
79
|
|
|
69
80
|
### 输出
|
|
70
|
-
|
|
81
|
+
每个项目的环境探测结果摘要`,
|
|
71
82
|
outputHint: '环境探测摘要',
|
|
72
83
|
optional: false
|
|
73
84
|
},
|
|
74
85
|
{
|
|
75
86
|
name: '断点续扫检测',
|
|
76
|
-
|
|
87
|
+
perProject: true,
|
|
88
|
+
prompt: `检测当前项目已有扫描文档,列出缺失的。
|
|
77
89
|
|
|
78
90
|
### 操作
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
91
|
+
对扫描列表中的每个项目分别执行:
|
|
92
|
+
1. 检查 7 份文档是否存在:ARCHITECTURE、STRUCTURE、CONVENTIONS、INTEGRATIONS、TESTING、CONCERNS、PROJECT
|
|
93
|
+
路径:\`.sillyspec/docs/<project>/scan/<DOC>.md\`
|
|
94
|
+
2. 列出已有 ✅ 和缺失 ⬜
|
|
83
95
|
|
|
84
96
|
### 输出
|
|
85
|
-
|
|
97
|
+
每个项目的已有/缺失文档列表`,
|
|
86
98
|
outputHint: '断点续扫状态',
|
|
87
99
|
optional: false
|
|
88
100
|
},
|
|
89
101
|
{
|
|
90
102
|
name: '深度扫描 — 7 份文档(子代理并行)',
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
-
|
|
114
|
-
-
|
|
115
|
-
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
搜索范围:目录树 + 模块说明 + 外部集成
|
|
120
|
-
- 用 find/ls/tree 和 grep,**禁止读源码全文**
|
|
121
|
-
- 搜索 API 调用、MQ 配置、缓存、第三方 SDK
|
|
122
|
-
- STRUCTURE.md:目录树+模块说明
|
|
123
|
-
- INTEGRATIONS.md:外部集成(按类型分组)
|
|
124
|
-
- 参考 _env-detect.md(如存在)
|
|
125
|
-
|
|
126
|
-
**子代理 D — 测试 + 债务 + 项目概览**
|
|
127
|
-
目标文件:\`.sillyspec/docs/<project>/scan/TESTING.md\` + \`.sillyspec/docs/<project>/scan/CONCERNS.md\` + \`.sillyspec/docs/<project>/scan/PROJECT.md\`
|
|
128
|
-
搜索范围:测试文件 + TODO/FIXME + 过时依赖 + 项目信息
|
|
129
|
-
- 用 grep 搜索测试文件、TODO/FIXME、过时依赖,**禁止读源码全文**
|
|
130
|
-
- TESTING.md:测试结构
|
|
131
|
-
- CONCERNS.md:技术债务(按严重程度分组)
|
|
132
|
-
- PROJECT.md:项目概览
|
|
133
|
-
- 参考 _env-detect.md(如存在)
|
|
134
|
-
|
|
135
|
-
### 每个子代理的共同要求
|
|
136
|
-
- **上下文注入**:主 agent 在启动子代理前,必须将以下信息拼入子代理 prompt:
|
|
137
|
-
- 项目名(直接用本次 prompt 中的实际项目名)
|
|
138
|
-
- 断点续扫步骤列出的缺失文档列表(哪些要生成、哪些跳过)
|
|
139
|
-
- 环境探测结果摘要(构建工具、语言框架、关键依赖)
|
|
140
|
-
- _env-detect.md 内容(如存在,直接贴入)
|
|
141
|
-
- 路径用反引号,不编造
|
|
142
|
-
- 目标文件不存在则创建,已存在则覆盖
|
|
143
|
-
- 只生成缺失文档(根据断点续扫结果)
|
|
103
|
+
perProject: true,
|
|
104
|
+
prompt: `按照 \`.sillyspec/workflows/scan-docs.yaml\` 中定义的角色和检查规则,使用子代理并行生成当前项目的 7 份扫描文档。
|
|
105
|
+
|
|
106
|
+
**你必须使用子代理执行,不要自己写文档。**
|
|
107
|
+
**对扫描列表中的每个项目分别执行以下流程。**
|
|
108
|
+
|
|
109
|
+
### 操作
|
|
110
|
+
1. 读取 \`.sillyspec/workflows/scan-docs.yaml\`,了解角色定义、输出要求和检查规则
|
|
111
|
+
2. 对每个项目(扫描列表中标记为需生成/覆盖的项目):
|
|
112
|
+
a. 将 \`<project>\` 替换为实际项目名,得到该项目的目标文件路径
|
|
113
|
+
b. 为每个角色启动独立子代理(可并行),每个子代理负责 1-2 份文档
|
|
114
|
+
c. 子代理的搜索范围限定在该项目目录内(子项目如 \`packages/dashboard/\`,不要搜索主项目源码)
|
|
115
|
+
d. 子代理直接用 grep/rg 搜索源码并写入文件,结果不回传到你的上下文
|
|
116
|
+
e. 等待该项目所有子代理完成后,验证文件是否生成且非空
|
|
117
|
+
f. 该项目完成后,继续下一个项目
|
|
118
|
+
3. 所有项目完成后,运行以下命令检查产物:
|
|
119
|
+
\`node -e "import('./src/workflow.js').then(w => { const r = w.runPostCheck(w.loadWorkflow('.', 'scan-docs'), '.', '<project>'); console.log(w.formatCheckReport(r)) })\`
|
|
120
|
+
对每个项目分别执行(将 \`<project>\` 替换为实际项目名)
|
|
121
|
+
4. 如果检查报告有失败项,按报告中的角色和文件重试失败的部分
|
|
122
|
+
|
|
123
|
+
### 子代理上下文注入
|
|
124
|
+
启动每个子代理前,将以下信息拼入子代理 prompt:
|
|
125
|
+
- 项目名(直接用实际项目名)
|
|
126
|
+
- 目标文件路径(从 workflow YAML 中 \`<project>\` 替换后的路径)
|
|
127
|
+
- 检查要求(从 workflow YAML 中该角色的 checks)
|
|
128
|
+
- 断点续扫步骤列出的缺失文档列表
|
|
129
|
+
- 环境探测结果摘要(如有 _env-detect.md,直接贴入)
|
|
130
|
+
- **⚠️ 必须强调:子代理必须用 write 工具将文件写入磁盘**
|
|
144
131
|
|
|
145
132
|
### 完成后
|
|
146
|
-
|
|
133
|
+
列出每个项目的 7 份文档状态:
|
|
147
134
|
- ✅ ARCHITECTURE.md / ❌ 缺失
|
|
148
135
|
- ✅ CONVENTIONS.md / ❌ 缺失
|
|
149
136
|
- ...`,
|
|
150
|
-
outputHint: '7
|
|
137
|
+
outputHint: '7 份文档生成状态(含 workflow 检查报告)',
|
|
151
138
|
optional: false
|
|
152
139
|
},
|
|
153
140
|
{
|
|
@@ -191,13 +178,15 @@ local.yaml 生成结果(已存在/已生成)`,
|
|
|
191
178
|
},
|
|
192
179
|
{
|
|
193
180
|
name: '生成模块映射',
|
|
194
|
-
|
|
181
|
+
perProject: true,
|
|
182
|
+
prompt: `生成当前项目的模块索引文件 \`_module-map.yaml\`。
|
|
195
183
|
|
|
196
184
|
### ⚠️ 重要:这个文件是唯一的结构化索引源
|
|
197
185
|
所有结构化事实(paths/tags/entrypoints/depends_on/used_by)只维护在这个文件里。
|
|
198
186
|
模块卡片(modules/*.md)只负责人类语义说明,不重复索引信息。
|
|
199
187
|
|
|
200
188
|
### 操作
|
|
189
|
+
对扫描列表中的每个项目分别执行:
|
|
201
190
|
1. 检查 \`.sillyspec/docs/<project>/modules/_module-map.yaml\` 是否已存在,已存在则跳过
|
|
202
191
|
2. 分析项目源码目录结构,识别模块划分:
|
|
203
192
|
- 用 \`find . -maxdepth 3 -type d -not -path "*/node_modules/*" -not -path "*/.git/*"\` 查看目录结构
|
|
@@ -307,13 +296,15 @@ _module-map.yaml 生成结果(已存在/已生成/模块列表)`,
|
|
|
307
296
|
},
|
|
308
297
|
{
|
|
309
298
|
name: '生成模块卡片文档',
|
|
310
|
-
|
|
299
|
+
perProject: true,
|
|
300
|
+
prompt: `根据当前项目的 \`_module-map.yaml\` 生成模块卡片文档。
|
|
311
301
|
|
|
312
302
|
### ⚠️ 重要:模块卡片只负责人类语义说明
|
|
313
303
|
结构化索引(paths/tags/entrypoints/depends_on/used_by)已经在 _module-map.yaml 里维护。
|
|
314
304
|
卡片里不要重复这些信息,只写 _module-map.yaml 无法表达的语义内容。
|
|
315
305
|
|
|
316
306
|
### 操作
|
|
307
|
+
对扫描列表中的每个项目分别执行:
|
|
317
308
|
1. 读取 \`.sillyspec/docs/<project>/modules/_module-map.yaml\`,获取模块列表和路径
|
|
318
309
|
2. 检查 \`.sillyspec/docs/<project>/modules/\` 下已有的模块文档(<module>.md)
|
|
319
310
|
3. 列出每个模块的状态:已有文档 / 缺失
|
|
@@ -383,7 +374,8 @@ module_id: <module-id>
|
|
|
383
374
|
},
|
|
384
375
|
{
|
|
385
376
|
name: '生成业务流程和术语表(可选)',
|
|
386
|
-
|
|
377
|
+
perProject: true,
|
|
378
|
+
prompt: `根据当前项目的模块依赖关系和源码,生成跨模块业务流程文档和术语表。
|
|
387
379
|
|
|
388
380
|
⚠️ 这一步是可选的。如果项目模块简单、流程不明显,可以跳过。
|
|
389
381
|
|
|
@@ -449,18 +441,20 @@ step1 → step2 → step3
|
|
|
449
441
|
},
|
|
450
442
|
{
|
|
451
443
|
name: '自检和提交',
|
|
452
|
-
|
|
444
|
+
perProject: true,
|
|
445
|
+
prompt: `验证当前项目的扫描完整性,清理并提交。
|
|
453
446
|
|
|
454
447
|
### 操作
|
|
455
|
-
|
|
456
|
-
|
|
448
|
+
对扫描列表中的每个项目分别执行:
|
|
449
|
+
1. 检查 7 份 scan 文档是否全部生成(\`.sillyspec/docs/<project>/scan/\`)
|
|
450
|
+
2. 检查模块文档状态(\`.sillyspec/docs/<project>/modules/\`)
|
|
457
451
|
3. 自检门控:ARCHITECTURE(技术栈+Schema摘要)、CONVENTIONS(隐形规则+代码风格)、STRUCTURE(目录结构)、INTEGRATIONS(外部依赖)、TESTING(测试现状)、CONCERNS(技术债务)、PROJECT(项目概览)
|
|
458
452
|
4. 检查 flows/ 和 glossary.md 是否已生成(如有)
|
|
459
453
|
5. 清理:\`rm -f .sillyspec/docs/<project>/scan/_env-detect.md\`
|
|
460
454
|
6. \`git add .sillyspec/\` — 暂存扫描结果(不要 commit,由用户通过统一提交工具处理)
|
|
461
455
|
|
|
462
456
|
### 输出
|
|
463
|
-
|
|
457
|
+
每个项目的扫描完整性报告
|
|
464
458
|
|
|
465
459
|
### 注意
|
|
466
460
|
- ❌ 修改代码 / 编造路径 / 读源码全文`,
|