sillyspec 2.4.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/.claude/commands/sillyspec/archive.md +63 -0
- package/.claude/commands/sillyspec/brainstorm.md +463 -0
- package/.claude/commands/sillyspec/continue.md +44 -0
- package/.claude/commands/sillyspec/execute.md +255 -0
- package/.claude/commands/sillyspec/explore.md +88 -0
- package/.claude/commands/sillyspec/export.md +53 -0
- package/.claude/commands/sillyspec/init.md +166 -0
- package/.claude/commands/sillyspec/plan.md +238 -0
- package/.claude/commands/sillyspec/propose.md +234 -0
- package/.claude/commands/sillyspec/quick.md +62 -0
- package/.claude/commands/sillyspec/resume.md +100 -0
- package/.claude/commands/sillyspec/scan.md +672 -0
- package/.claude/commands/sillyspec/status.md +122 -0
- package/.claude/commands/sillyspec/verify.md +141 -0
- package/.claude/commands/sillyspec/workspace.md +122 -0
- package/README.md +158 -0
- package/SKILL.md +46 -0
- package/adapters/adapters.sh +172 -0
- package/bin/sillyspec.js +2 -0
- package/commands/sillyspec/archive.md +62 -0
- package/commands/sillyspec/brainstorm.md +462 -0
- package/commands/sillyspec/continue.md +41 -0
- package/commands/sillyspec/execute.md +254 -0
- package/commands/sillyspec/explore.md +85 -0
- package/commands/sillyspec/export.md +51 -0
- package/commands/sillyspec/init.md +163 -0
- package/commands/sillyspec/plan.md +237 -0
- package/commands/sillyspec/propose.md +233 -0
- package/commands/sillyspec/quick.md +59 -0
- package/commands/sillyspec/resume.md +99 -0
- package/commands/sillyspec/scan.md +671 -0
- package/commands/sillyspec/status.md +119 -0
- package/commands/sillyspec/verify.md +140 -0
- package/commands/sillyspec/workspace.md +120 -0
- package/package.json +14 -0
- package/scripts/init.sh +2 -0
- package/scripts/install.ps1 +316 -0
- package/scripts/scan-preprocess.sh +378 -0
- package/scripts/validate-all.sh +50 -0
- package/scripts/validate-plan.sh +44 -0
- package/scripts/validate-proposal.sh +87 -0
- package/scripts/validate-scan.sh +90 -0
- package/src/index.js +560 -0
- package/src/init.js +269 -0
- package/templates/archive.md +58 -0
- package/templates/brainstorm.md +458 -0
- package/templates/continue.md +39 -0
- package/templates/execute.md +250 -0
- package/templates/explore.md +83 -0
- package/templates/export.md +48 -0
- package/templates/init.md +161 -0
- package/templates/plan.md +233 -0
- package/templates/propose.md +229 -0
- package/templates/quick.md +57 -0
- package/templates/resume.md +95 -0
- package/templates/scan.md +667 -0
- package/templates/status.md +117 -0
- package/templates/verify.md +136 -0
- package/templates/workspace.md +117 -0
|
@@ -0,0 +1,671 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: 代码库扫描 — 交互式引导,支持快速/深度扫描和多项目工作区
|
|
3
|
+
argument-hint: "[可选:直接指定区域或模式,跳过交互引导]"
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
你现在是 SillySpec 的代码库扫描器。
|
|
7
|
+
|
|
8
|
+
## 参数处理
|
|
9
|
+
|
|
10
|
+
解析 `$ARGUMENTS`:
|
|
11
|
+
- 空白或未提供 → **交互式引导模式**(逐步询问)
|
|
12
|
+
- 包含具体内容 → **快速模式**,直接执行,跳过询问
|
|
13
|
+
- 含 `--deep` → 深度扫描
|
|
14
|
+
- 其他内容 → 当作扫描区域(快速扫描该区域)
|
|
15
|
+
|
|
16
|
+
**以下流程只在交互式引导模式下执行。如果用户传了参数,跳到对应的 Step。**
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## 🛑 流程控制(必须先执行)
|
|
21
|
+
|
|
22
|
+
**在开始任何工作之前,先调用 SillySpec CLI 检查当前状态:**
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
sillyspec status --json
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
**如果 CLI 返回的 phase 不是 "init",说明已经有扫描数据。** 根据 CLI 返回结果决定:
|
|
29
|
+
|
|
30
|
+
- `phase: "scan:quick_done"` → 已有快速扫描,建议深度扫描
|
|
31
|
+
- `phase: "scan:resume"` → 深度扫描中断过,调用 `sillyspec check --json` 获取缺失文档列表
|
|
32
|
+
- `phase` 是其他值 → 不需要扫描,提示用户 CLI 建议的下一步命令
|
|
33
|
+
|
|
34
|
+
**不要自己推断项目状态,以 CLI 返回为准。**
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## 交互式引导流程
|
|
39
|
+
|
|
40
|
+
### Step 0: 检查工作区模式
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
cat .sillyspec/config.yaml 2>/dev/null
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
如果 config.yaml 存在且包含 `projects` → 工作区模式:
|
|
47
|
+
|
|
48
|
+
询问用户:
|
|
49
|
+
```
|
|
50
|
+
检测到工作区模式,请选择扫描范围:
|
|
51
|
+
1) 全部子项目(逐个扫描后生成汇总)
|
|
52
|
+
2) 指定某个子项目
|
|
53
|
+
3) 取消
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
根据选择:
|
|
57
|
+
- 选 1 → 逐个扫描,最后生成 `.sillyspec/workspace/CODEBASE-OVERVIEW.md`
|
|
58
|
+
- 选 2 → 列出子项目让用户选,只扫选中的
|
|
59
|
+
- 选 3 → 退出
|
|
60
|
+
|
|
61
|
+
每个子项目的文档存到各自的 `<子项目路径>/.sillyspec/codebase/` 下。
|
|
62
|
+
|
|
63
|
+
### Step 1: 检查已有文档
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
ls .sillyspec/codebase/ 2>/dev/null
|
|
67
|
+
wc -l .sillyspec/codebase/*.md 2>/dev/null
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
根据已有文档情况智能提示:
|
|
71
|
+
|
|
72
|
+
**没有任何文档:**
|
|
73
|
+
→ 不提示,直接进入 Step 2 选择扫描模式。
|
|
74
|
+
|
|
75
|
+
**已有 3 份(STACK + STRUCTURE + PROJECT):**
|
|
76
|
+
```
|
|
77
|
+
检测到上次的快速扫描结果。
|
|
78
|
+
→ 输入 1 升级为完整扫描(补充 4 份文档)
|
|
79
|
+
→ 输入 2 重新快速扫描(覆盖现有文档)
|
|
80
|
+
→ 输入 3 跳过,直接开始开发
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
**已有 7 份完整文档:**
|
|
84
|
+
先检查距上次扫描过了多久:
|
|
85
|
+
```bash
|
|
86
|
+
git log -1 --format="%ci" .sillyspec/codebase/ 2>/dev/null
|
|
87
|
+
git log --oneline --since="上次扫描时间" | wc -l
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
```
|
|
91
|
+
上次扫描距今 X 天,期间有 Y 个新提交。
|
|
92
|
+
→ 输入 1 刷新(重新扫描全部)
|
|
93
|
+
→ 输入 2 跳过,直接开始开发
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
**用户选跳过** → 输出"可以开始开发了。建议下一步:`/sillyspec:brainstorm '你的需求'`"然后结束。
|
|
97
|
+
|
|
98
|
+
### Step 2: 选择扫描模式
|
|
99
|
+
|
|
100
|
+
```
|
|
101
|
+
请选择扫描模式:
|
|
102
|
+
|
|
103
|
+
1. 快速扫描 ⚡
|
|
104
|
+
读取配置文件和目录结构,约 30 秒
|
|
105
|
+
生成 3 份文档:技术栈 + 目录结构 + 项目概览
|
|
106
|
+
|
|
107
|
+
2. 深度扫描 🔍
|
|
108
|
+
读取全部源代码并分析,约 2-3 分钟
|
|
109
|
+
生成 7 份文档:技术栈 + 架构 + 目录结构 + 编码约定 + 集成 + 测试 + 技术债务
|
|
110
|
+
|
|
111
|
+
3. 取消
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
根据选择进入对应的扫描流程。
|
|
115
|
+
|
|
116
|
+
### Step 3: 选择扫描范围
|
|
117
|
+
|
|
118
|
+
```
|
|
119
|
+
扫描范围:(留空则扫描整个项目)
|
|
120
|
+
|
|
121
|
+
提示:可以输入目录名或模块名,如:
|
|
122
|
+
- api
|
|
123
|
+
- src/auth
|
|
124
|
+
- frontend
|
|
125
|
+
- 多个区域用空格分隔:api auth
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
留空 → 全量扫描
|
|
129
|
+
有输入 → 只扫描指定区域
|
|
130
|
+
|
|
131
|
+
### Step 4: 确认排除目录
|
|
132
|
+
|
|
133
|
+
```
|
|
134
|
+
以下目录将被排除(不扫描):
|
|
135
|
+
node_modules dist .git vendor build __pycache__
|
|
136
|
+
.next coverage .nuxt target
|
|
137
|
+
|
|
138
|
+
是否需要添加额外的排除目录?(留空跳过)
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
如果用户输入了额外目录 → 追加到排除列表。
|
|
142
|
+
|
|
143
|
+
### Step 5: 显示扫描计划并确认
|
|
144
|
+
|
|
145
|
+
把以上选择汇总,让用户最后确认:
|
|
146
|
+
|
|
147
|
+
```
|
|
148
|
+
扫描计划确认:
|
|
149
|
+
模式:深度扫描
|
|
150
|
+
范围:整个项目
|
|
151
|
+
排除:node_modules, dist, .git, vendor, build, __pycache__, .next, coverage, .nuxt, target
|
|
152
|
+
|
|
153
|
+
开始扫描?(输入 y 确认,或修改以上选项)
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
用户确认 → 执行扫描。用户想改 → 回到对应步骤。
|
|
157
|
+
|
|
158
|
+
---
|
|
159
|
+
|
|
160
|
+
## 快速扫描
|
|
161
|
+
|
|
162
|
+
**只读取入口和配置文件,不读源代码:**
|
|
163
|
+
|
|
164
|
+
```bash
|
|
165
|
+
# 读取配置文件
|
|
166
|
+
cat package.json 2>/dev/null
|
|
167
|
+
cat tsconfig.json 2>/dev/null
|
|
168
|
+
cat requirements.txt 2>/dev/null
|
|
169
|
+
cat Cargo.toml 2>/dev/null
|
|
170
|
+
cat go.mod 2>/dev/null
|
|
171
|
+
cat pom.xml 2>/dev/null
|
|
172
|
+
cat build.gradle 2>/dev/null
|
|
173
|
+
find . -maxdepth 2 -name "*.config.*" -not -path "*/node_modules/*" -not -path "*/.git/*" | head -20 | xargs cat 2>/dev/null
|
|
174
|
+
|
|
175
|
+
# 查看目录结构(排除依赖和构建产物)
|
|
176
|
+
find . -type f -not -path "*/node_modules/*" -not -path "*/dist/*" -not -path "*/.git/*" -not -path "*/vendor/*" -not -path "*/build/*" -not -path "*/__pycache__/*" -not -path "*/.next/*" -not -path "*/coverage/*" -not -path "*/.nuxt/*" -not -path "*/target/*" | head -200
|
|
177
|
+
|
|
178
|
+
# 最近提交
|
|
179
|
+
git log --oneline -20
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
## 🚨 数据库 Schema 强制扫描(必须执行)
|
|
183
|
+
|
|
184
|
+
**无论快速还是深度模式,必须执行以下步骤。** 防止 AI 在后续阶段编造表名和字段名。
|
|
185
|
+
|
|
186
|
+
### 第一步:查找 Schema 定义文件
|
|
187
|
+
|
|
188
|
+
```bash
|
|
189
|
+
find . \( -name "schema.prisma" -o -name "*.model.ts" -o -name "*.entity.ts" \
|
|
190
|
+
-o -name "models.py" -o -name "models.go" \
|
|
191
|
+
-o -name "*.sql" -o -name "migration*" \
|
|
192
|
+
\) \
|
|
193
|
+
-not -path "*/node_modules/*" -not -path "*/.git/*" -not -path "*/dist/*" \
|
|
194
|
+
-not -path "*/build/*" -not -path "*/vendor/*" | head -30
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
支持的格式:
|
|
198
|
+
|
|
199
|
+
| 框架 | 识别文件 |
|
|
200
|
+
|---|---|
|
|
201
|
+
| Prisma | `prisma/schema.prisma` |
|
|
202
|
+
| SQLAlchemy / Django | `**/models.py` |
|
|
203
|
+
| TypeORM | `**/*.entity.ts` |
|
|
204
|
+
| Mongoose | `**/*.model.ts`(检查 mongoose schema) |
|
|
205
|
+
| Java JPA / Hibernate | `**/entity/*.java`、`**/model/*.java`(含 `@Entity` / `@Table` 注解的类) |
|
|
206
|
+
| MyBatis | `**/*Mapper.xml`(提取 `resultMap` 和表名) |
|
|
207
|
+
| Go GORM | `**/models.go`、`**/model.go` |
|
|
208
|
+
| Drizzle | `**/schema.ts` |
|
|
209
|
+
| 原始 SQL | `**/migrations/*.sql` |
|
|
210
|
+
|
|
211
|
+
### 第二步:生成 Schema 摘要
|
|
212
|
+
|
|
213
|
+
**只记录表名 + 说明 + 字段数量,不展开字段细节。** 写入 ARCHITECTURE.md:
|
|
214
|
+
|
|
215
|
+
```markdown
|
|
216
|
+
## 数据模型(摘要)
|
|
217
|
+
|
|
218
|
+
| 表名 | 说明 | 字段数 | 来源文件 |
|
|
219
|
+
|---|---|---|---|
|
|
220
|
+
| users | 用户表 | 12 | `src/entity/User.java` |
|
|
221
|
+
| roles | 角色表 | 5 | `src/entity/Role.java` |
|
|
222
|
+
| orders | 订单表 | 18 | `prisma/schema.prisma` |
|
|
223
|
+
|
|
224
|
+
### 关系
|
|
225
|
+
- users 1:N roles
|
|
226
|
+
- users 1:N orders
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
如果项目没有数据库 → 写"本项目无数据库",后续阶段不准引用任何表。
|
|
230
|
+
|
|
231
|
+
### 第三步:在后续命令中按需深挖
|
|
232
|
+
|
|
233
|
+
**brainstorm/propose/plan 阶段,根据当前需求只读取相关表的详细 schema。**
|
|
234
|
+
|
|
235
|
+
执行规则:
|
|
236
|
+
1. 先读 ARCHITECTURE.md 的 Schema 摘要,确定涉及哪些表
|
|
237
|
+
2. 只读取相关表的源文件(`cat src/entity/User.java`)
|
|
238
|
+
3. 没涉及的表不要读,节省上下文
|
|
239
|
+
4. 如果摘要中没有但需要新表 → 必须在 propose 的 design.md 中声明
|
|
240
|
+
|
|
241
|
+
**铁律:所有阶段引用的表名必须来自 Schema 摘要列表,或 design.md 中声明的新增表。**
|
|
242
|
+
|
|
243
|
+
## 🚨 框架隐形规则扫描(必须执行)
|
|
244
|
+
|
|
245
|
+
**无论快速还是深度模式,必须执行。** 防止 AI 生成 SQL/代码时违反项目框架的自动处理机制。
|
|
246
|
+
|
|
247
|
+
### 为什么需要这一步
|
|
248
|
+
|
|
249
|
+
很多项目有"隐形规则"——某些字段由框架自动处理,SQL 里不需要写;某些拦截器会自动注入条件,手动写反而会冲突。这些规则不在 schema 里,AI 扫不到就会犯错。
|
|
250
|
+
|
|
251
|
+
**典型踩坑:**
|
|
252
|
+
- MyBatis 多租户插件自动注入 tenant_id → SQL 里再写就重复了
|
|
253
|
+
- JPA @CreatedDate 自动填充 create_time → INSERT 里再写就冲突了
|
|
254
|
+
- 逻辑删除拦截器把 DELETE 改成 UPDATE → AI 直接写 DELETE FROM 就错了
|
|
255
|
+
|
|
256
|
+
### 扫描步骤
|
|
257
|
+
|
|
258
|
+
```bash
|
|
259
|
+
# 1. MyBatis 拦截器 / 插件配置
|
|
260
|
+
find . \( -name "*Interceptor*.java" -o -name "*Plugin*.java" \
|
|
261
|
+
-o -name "mybatis-config.xml" -o -name "mybatis*.yml" -o -name "mybatis*.yaml" \) \
|
|
262
|
+
-not -path "*/node_modules/*" -not -path "*/.git/*" | head -20
|
|
263
|
+
|
|
264
|
+
# 2. JPA / Hibernate 配置和审计注解
|
|
265
|
+
find . \( -name "*Auditor*.java" -o -name "*EventListener*.java" \
|
|
266
|
+
-o -name "persistence.xml" -o -name "application*.yml" -o -name "application*.yaml" \) \
|
|
267
|
+
-not -path "*/node_modules/*" -not -path "*/.git/*" | head -20
|
|
268
|
+
|
|
269
|
+
# 3. Django 配置(中间件、模型 Meta)
|
|
270
|
+
find . -name "settings.py" -not -path "*/node_modules/*" | head -5
|
|
271
|
+
find . -name "models.py" -not -path "*/node_modules/*" | head -10
|
|
272
|
+
|
|
273
|
+
# 4. SQLAlchemy 事件监听
|
|
274
|
+
find . \( -name "*event*.py" -o -name "*listener*.py" -o -name "*mixin*.py" \) \
|
|
275
|
+
-not -path "*/node_modules/*" -not -path "*/.git/*" | head -10
|
|
276
|
+
|
|
277
|
+
# 5. Prisma 中间件 / 扩展
|
|
278
|
+
cat prisma/schema.prisma 2>/dev/null | grep -i "middleware\|plugin\|previewFeatures"
|
|
279
|
+
|
|
280
|
+
# 6. Go GORM 插件 / 回调
|
|
281
|
+
find . -name "*.go" -not -path "*/vendor/*" | xargs grep -l "gorm:\|Callback\|Plugin" 2>/dev/null | head -10
|
|
282
|
+
|
|
283
|
+
# 7. TypeORM 订阅器 / 监听器
|
|
284
|
+
find . -name "*.ts" -not -path "*/node_modules/*" | xargs grep -l "EventSubscriber\|@BeforeInsert\|@AfterUpdate\|@DeleteDateColumn" 2>/dev/null | head -10
|
|
285
|
+
|
|
286
|
+
# 8. Rails / Active Record 回调
|
|
287
|
+
find . -name "*.rb" -not -path "*/vendor/*" | xargs grep -l "before_save\|before_create\|acts_as_paranoid\|acts_as_tenant" 2>/dev/null | head -10
|
|
288
|
+
|
|
289
|
+
# 9. Laravel / Eloquent 作用域和 trait
|
|
290
|
+
find . \( -name "*Scope*.php" -o -name "boot*.php" -o -name "ServiceProvider.php" \) \
|
|
291
|
+
-not -path "*/vendor/*" | head -10
|
|
292
|
+
|
|
293
|
+
# 10. 通用逻辑删除 / 审计字段检测
|
|
294
|
+
find . \( -name "*.java" -o -name "*.py" -o -name "*.go" -o -name "*.ts" \
|
|
295
|
+
-o -name "*.php" -o -name "*.rb" \) \
|
|
296
|
+
-not -path "*/node_modules/*" -not -path "*/.git/*" -not -path "*/vendor/*" \
|
|
297
|
+
-not -path "*/dist/*" -not -path "*/build/*" \
|
|
298
|
+
| xargs grep -li "is_deleted\|deleted_at\|soft_delete\|paranoid\|tenant_id\|tenantId" 2>/dev/null | head -20
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
### 将结果写入 CONVENTIONS.md
|
|
302
|
+
|
|
303
|
+
**创建或追加到 `.sillyspec/codebase/CONVENTIONS.md`,添加"框架隐形规则"章节。**
|
|
304
|
+
|
|
305
|
+
格式:
|
|
306
|
+
|
|
307
|
+
```markdown
|
|
308
|
+
## 框架隐形规则
|
|
309
|
+
|
|
310
|
+
### 自动注入字段(SQL 中不要手动写)
|
|
311
|
+
|
|
312
|
+
| 字段 | 来源 | 说明 |
|
|
313
|
+
|---|---|---|
|
|
314
|
+
| tenant_id | MyBatis 多租户拦截器 TenantLineInnerInterceptor | 自动注入租户过滤条件,SQL 不需要 WHERE tenant_id=? |
|
|
315
|
+
| is_deleted | 逻辑删除拦截器 | DELETE 自动改为 UPDATE xxx SET is_deleted=1 |
|
|
316
|
+
|
|
317
|
+
### 自动填充字段(INSERT/UPDATE 不需要手动赋值)
|
|
318
|
+
|
|
319
|
+
| 字段 | 来源 | 说明 |
|
|
320
|
+
|---|---|---|
|
|
321
|
+
| create_time | JPA @CreatedDate / MyBatis-Plus MetaObjectHandler | INSERT 时自动填充 |
|
|
322
|
+
| update_time | JPA @LastModifiedDate / MyBatis-Plus MetaObjectHandler | INSERT 和 UPDATE 时自动填充 |
|
|
323
|
+
| create_by | MetaObjectHandler | 从 SecurityContext 获取当前用户 |
|
|
324
|
+
|
|
325
|
+
### 查询增强(框架自动追加条件)
|
|
326
|
+
|
|
327
|
+
| 规则 | 说明 |
|
|
328
|
+
|---|---|
|
|
329
|
+
| 数据权限过滤 | 某些表自动追加 WHERE 条件,SQL 中不需要手动加 |
|
|
330
|
+
| 软删除过滤 | 查询自动排除 is_deleted=1 的数据,SQL 不需要 WHERE is_deleted=0 |
|
|
331
|
+
|
|
332
|
+
### DELETE 行为
|
|
333
|
+
|
|
334
|
+
- 不要写 `DELETE FROM` → 使用 `UPDATE xxx SET is_deleted = 1 WHERE id = ?`
|
|
335
|
+
```
|
|
336
|
+
|
|
337
|
+
**如果项目没有发现任何隐形规则** → 写"未发现框架级别的自动处理配置,SQL 可以按常规方式编写"。
|
|
338
|
+
|
|
339
|
+
**铁律:后续阶段生成 SQL 或数据操作代码时,必须遵守这些规则。违反 = 生成的代码会报错或产生数据错误。**
|
|
340
|
+
|
|
341
|
+
## 🚨 实体继承规范扫描(必须执行)
|
|
342
|
+
|
|
343
|
+
**无论快速还是深度模式,必须执行。** 防止 AI 新建表时漏掉基类的通用字段,导致 MyBatis-Plus/JPA 自动查询报 Unknown column。
|
|
344
|
+
|
|
345
|
+
### 为什么需要这一步
|
|
346
|
+
|
|
347
|
+
很多项目用实体基类(BaseModel、BaseEntity、BasePO 等)定义通用字段(审计字段、逻辑删除、多租户等)。子类继承基类后,ORM 框架会自动查询这些字段。如果新建表的 DDL 漏掉了这些列,SQL 就会报错。
|
|
348
|
+
|
|
349
|
+
**典型踩坑:**
|
|
350
|
+
- 实体类继承了 BaseModel,有 remarks、dept_id 字段
|
|
351
|
+
- AI 生成建表 SQL 时只写了业务字段,漏了通用字段
|
|
352
|
+
- MyBatis-Plus 自动 SELECT 包含 remarks → Unknown column
|
|
353
|
+
|
|
354
|
+
### 扫描步骤
|
|
355
|
+
|
|
356
|
+
```bash
|
|
357
|
+
# 1. Java: 查找实体基类(BaseModel / BaseEntity / BasePO)
|
|
358
|
+
find . \( -name "Base*.java" -o -name "Abstract*.java" \) \
|
|
359
|
+
-path "*/entity/*" -o -path "*/model/*" -o -path "*/po/*" -o -path "*/entity/*" \
|
|
360
|
+
-not -path "*/node_modules/*" -not -path "*/.git/*" | head -20
|
|
361
|
+
|
|
362
|
+
# 2. Java: 查找 @MappedSuperclass 注解的类
|
|
363
|
+
find . -name "*.java" -not -path "*/node_modules/*" -not -path "*/.git/*" \
|
|
364
|
+
| xargs grep -l "@MappedSuperclass" 2>/dev/null | head -10
|
|
365
|
+
|
|
366
|
+
# 3. Java: 查看子类继承关系
|
|
367
|
+
grep -rn "extends Base" --include="*.java" \
|
|
368
|
+
-not -path "*/node_modules/*" -not -path "*/.git/*" | head -20
|
|
369
|
+
|
|
370
|
+
# 4. Python / Django: 查找 Abstract 模型
|
|
371
|
+
find . -name "models.py" -not -path "*/node_modules/*" | xargs grep -l "class.*Abstract\|class.*Base" 2>/dev/null | head -10
|
|
372
|
+
|
|
373
|
+
# 5. Go: 查找嵌入的 BaseModel struct
|
|
374
|
+
find . -name "*.go" -not -path "*/vendor/*" | xargs grep -l "type.*struct" | xargs grep -l "BaseModel\|BaseEntity" 2>/dev/null | head -10
|
|
375
|
+
|
|
376
|
+
# 6. TypeORM: 查找 @Entity 基类的子类
|
|
377
|
+
find . -name "*.entity.ts" -not -path "*/node_modules/*" | xargs grep -l "extends\|@ChildEntity" 2>/dev/null | head -10
|
|
378
|
+
|
|
379
|
+
# 7. Prisma: 查找 model 共用字段(通过 generator 或注释)
|
|
380
|
+
cat prisma/schema.prisma 2>/dev/null
|
|
381
|
+
|
|
382
|
+
# 8. Rails: 查找 ApplicationRecord concern
|
|
383
|
+
find . -name "*.rb" -not -path "*/vendor/*" | xargs grep -l "include.*Concern\|include.*Module" 2>/dev/null | head -10
|
|
384
|
+
|
|
385
|
+
# 9. Laravel: 查找 Model trait
|
|
386
|
+
find . -name "*.php" -path "*/Models/*" -not -path "*/vendor/*" | head -10
|
|
387
|
+
```
|
|
388
|
+
|
|
389
|
+
### 将结果写入 CONVENTIONS.md
|
|
390
|
+
|
|
391
|
+
在"框架隐形规则"章节后追加:
|
|
392
|
+
|
|
393
|
+
```markdown
|
|
394
|
+
## 实体继承规范
|
|
395
|
+
|
|
396
|
+
### 基类通用字段(新建表必须包含)
|
|
397
|
+
|
|
398
|
+
以下字段来自基类 BaseModel,所有子类实体自动继承,DDL 必须包含:
|
|
399
|
+
|
|
400
|
+
| 字段 | 类型 | 说明 |
|
|
401
|
+
|---|---|---|
|
|
402
|
+
| id | BIGINT | 主键 |
|
|
403
|
+
| remarks | VARCHAR(500) | 备注 |
|
|
404
|
+
| dept_id | BIGINT | 部门ID |
|
|
405
|
+
| create_time | DATETIME | 创建时间 |
|
|
406
|
+
| update_time | DATETIME | 更新时间 |
|
|
407
|
+
| create_by | VARCHAR(64) | 创建人 |
|
|
408
|
+
| update_by | VARCHAR(64) | 更新人 |
|
|
409
|
+
| is_deleted | TINYINT(1) | 逻辑删除 |
|
|
410
|
+
|
|
411
|
+
### 铁律
|
|
412
|
+
- 新建表的 DDL 必须包含基类的所有字段,不能只写业务字段
|
|
413
|
+
- ORM 自动查询基类字段,数据库缺少这些列会报 Unknown column
|
|
414
|
+
- 如果基类有变更(新增通用字段),需要同步更新所有子表的 DDL
|
|
415
|
+
```
|
|
416
|
+
|
|
417
|
+
**注意:** 上表是示例,实际字段必须从扫描到的基类源码中提取,不要编造。
|
|
418
|
+
|
|
419
|
+
**如果项目没有实体基类** → 写"本项目没有实体基类,所有字段在各自实体中定义"。
|
|
420
|
+
|
|
421
|
+
**铁律:后续阶段新建表或修改表结构时,必须包含基类的所有通用字段。**
|
|
422
|
+
|
|
423
|
+
---
|
|
424
|
+
|
|
425
|
+
**快速扫描生成 3 份文档:**
|
|
426
|
+
|
|
427
|
+
创建目录 `mkdir -p .sillyspec/codebase`
|
|
428
|
+
|
|
429
|
+
**1. `.sillyspec/codebase/STACK.md`** — 技术栈
|
|
430
|
+
**2. `.sillyspec/codebase/STRUCTURE.md`** — 目录结构
|
|
431
|
+
**3. `.sillyspec/codebase/PROJECT.md`** — 项目概览
|
|
432
|
+
|
|
433
|
+
---
|
|
434
|
+
|
|
435
|
+
## 深度扫描
|
|
436
|
+
|
|
437
|
+
### Step 0: 运行预处理脚本(必须)
|
|
438
|
+
|
|
439
|
+
**深度扫描前,必须先运行预处理脚本。** 这是零 token 的 shell 操作:
|
|
440
|
+
|
|
441
|
+
```bash
|
|
442
|
+
bash scripts/scan-preprocess.sh [扫描区域]
|
|
443
|
+
```
|
|
444
|
+
|
|
445
|
+
如果 `scripts/scan-preprocess.sh` 不存在(Windows 或远程项目),跳过此步骤,AI 直接基于快速扫描结果进行深度分析。
|
|
446
|
+
|
|
447
|
+
**预处理脚本会自动完成:**
|
|
448
|
+
- 统计源文件数量和大小
|
|
449
|
+
- 估算扫描耗时(按文件数量动态计算,不是写死的 3 分钟)
|
|
450
|
+
- 提取配置文件内容(package.json、pom.xml 等)
|
|
451
|
+
- 提取目录结构树
|
|
452
|
+
- 提取 import/依赖关系(按语言分别分析)
|
|
453
|
+
- 提取类名/函数名/注解(Java @Entity、@Controller 等)
|
|
454
|
+
- 检测数据库 Schema 文件位置
|
|
455
|
+
- 检测框架和 ORM
|
|
456
|
+
- 检测框架配置文件(拦截器、审计、基类等)
|
|
457
|
+
|
|
458
|
+
所有结果写入 `.sillyspec/codebase/SCAN-RAW.md`。
|
|
459
|
+
|
|
460
|
+
**脚本输出示例:**
|
|
461
|
+
```
|
|
462
|
+
📊 文件统计:
|
|
463
|
+
Java: 280
|
|
464
|
+
Vue: 180
|
|
465
|
+
配置文件: 3
|
|
466
|
+
────────────────
|
|
467
|
+
源文件总计: 460 个
|
|
468
|
+
源码总大小: 3200KB
|
|
469
|
+
预计耗时: 约 5-8 分钟
|
|
470
|
+
上下文风险: 中
|
|
471
|
+
```
|
|
472
|
+
|
|
473
|
+
### Step 1: 断点续扫检查
|
|
474
|
+
|
|
475
|
+
**检查已生成的文档,跳过已完成的:**
|
|
476
|
+
|
|
477
|
+
```bash
|
|
478
|
+
for f in STACK ARCHITECTURE STRUCTURE CONVENTIONS INTEGRATIONS TESTING CONCERNS; do
|
|
479
|
+
if [ -f ".sillyspec/codebase/${f}.md" ]; then
|
|
480
|
+
echo "✅ ${f}.md 已存在,跳过"
|
|
481
|
+
else
|
|
482
|
+
echo "⬜ ${f}.md 待生成"
|
|
483
|
+
fi
|
|
484
|
+
done
|
|
485
|
+
```
|
|
486
|
+
|
|
487
|
+
**只生成缺失的文档。** 如果中断后重新执行,不会重复生成已有文档,也不会重复消耗 token。
|
|
488
|
+
|
|
489
|
+
将检查结果展示给用户:
|
|
490
|
+
```
|
|
491
|
+
📊 扫描进度检查:
|
|
492
|
+
✅ STACK.md 已存在
|
|
493
|
+
✅ ARCHITECTURE.md 已存在
|
|
494
|
+
✅ STRUCTURE.md 已存在
|
|
495
|
+
⬜ CONVENTIONS.md 待生成 ← 从这里继续
|
|
496
|
+
⬜ INTEGRATIONS.md 待生成
|
|
497
|
+
⬜ TESTING.md 待生成
|
|
498
|
+
⬜ CONCERNS.md 待生成
|
|
499
|
+
|
|
500
|
+
继续生成剩余 4 份文档。
|
|
501
|
+
```
|
|
502
|
+
|
|
503
|
+
### Step 2: 基于 SCAN-RAW.md 分析
|
|
504
|
+
|
|
505
|
+
**不要直接读取原始源码。** 读取预处理脚本生成的 SCAN-RAW.md:
|
|
506
|
+
|
|
507
|
+
```bash
|
|
508
|
+
cat .sillyspec/codebase/SCAN-RAW.md
|
|
509
|
+
```
|
|
510
|
+
|
|
511
|
+
基于 SCAN-RAW.md 中的结构化信息,**只按需深挖**相关文件:
|
|
512
|
+
|
|
513
|
+
1. **架构分析** → 如果 SCAN-RAW.md 标注了 460 个文件,不要全部读。读核心入口文件 + 目录结构推断架构
|
|
514
|
+
2. **编码约定** → 如果 SCAN-RAW.md 有 import 分析,基于高频 import 推断约定。必要时抽样读 3-5 个文件确认
|
|
515
|
+
3. **集成分析** → 读 SCAN-RAW.md 中的配置文件内容,不需要重新读原始文件
|
|
516
|
+
4. **数据库 Schema** → 读 SCAN-RAW.md 中标注的 schema 文件位置,只读相关文件
|
|
517
|
+
|
|
518
|
+
**铁律:每份文档写完立即保存。** 不要攒在一起最后统一写。这样即使中断,已生成的文档不会丢失。
|
|
519
|
+
|
|
520
|
+
**按以下顺序生成缺失的文档:**
|
|
521
|
+
|
|
522
|
+
1. `.sillyspec/codebase/STACK.md` — 技术栈(基于 SCAN-RAW.md 的框架检测 + 配置文件)
|
|
523
|
+
2. `.sillyspec/codebase/ARCHITECTURE.md` — 架构(含数据模型摘要)
|
|
524
|
+
3. `.sillyspec/codebase/STRUCTURE.md` — 目录结构(基于 SCAN-RAW.md 的目录分布)
|
|
525
|
+
4. `.sillyspec/codebase/CONVENTIONS.md` — 代码约定
|
|
526
|
+
5. `.sillyspec/codebase/INTEGRATIONS.md` — 集成
|
|
527
|
+
6. `.sillyspec/codebase/TESTING.md` — 测试现状
|
|
528
|
+
7. `.sillyspec/codebase/CONVENTIONS.md` — 编码约定(含框架隐形规则)
|
|
529
|
+
8. `.sillyspec/codebase/CONCERNS.md` — 技术债务和风险
|
|
530
|
+
|
|
531
|
+
同时更新 `.sillyspec/PROJECT.md`。
|
|
532
|
+
|
|
533
|
+
---
|
|
534
|
+
|
|
535
|
+
## 扫描完成
|
|
536
|
+
|
|
537
|
+
### 快速扫描完成后
|
|
538
|
+
|
|
539
|
+
**用 CLI 验证结果:**
|
|
540
|
+
|
|
541
|
+
```bash
|
|
542
|
+
sillyspec status --json
|
|
543
|
+
```
|
|
544
|
+
|
|
545
|
+
展示给用户:
|
|
546
|
+
> ✅ 快速扫描完成!
|
|
547
|
+
>
|
|
548
|
+
> 生成文档到 `.sillyspec/codebase/`:
|
|
549
|
+
> - STACK.md — 技术栈
|
|
550
|
+
> - STRUCTURE.md — 目录结构
|
|
551
|
+
> - PROJECT.md — 项目概览
|
|
552
|
+
|
|
553
|
+
**下一步由 CLI 决定:**
|
|
554
|
+
|
|
555
|
+
```bash
|
|
556
|
+
sillyspec next
|
|
557
|
+
```
|
|
558
|
+
|
|
559
|
+
将 CLI 返回的命令推荐给用户。
|
|
560
|
+
|
|
561
|
+
### 深度扫描完成后
|
|
562
|
+
|
|
563
|
+
**用 CLI 验证结果:**
|
|
564
|
+
|
|
565
|
+
```bash
|
|
566
|
+
sillyspec status --json
|
|
567
|
+
```
|
|
568
|
+
|
|
569
|
+
CLI 应返回 `phase: "brainstorm"`。如果返回其他阶段,说明有文档缺失,需要补全。
|
|
570
|
+
|
|
571
|
+
展示给用户:
|
|
572
|
+
> ✅ 深度扫描完成!
|
|
573
|
+
>
|
|
574
|
+
> 生成 7 份文档到 `.sillyspec/codebase/`:
|
|
575
|
+
> - STACK.md — 技术栈
|
|
576
|
+
> - ARCHITECTURE.md — 架构(含数据模型摘要)
|
|
577
|
+
> - STRUCTURE.md — 目录结构
|
|
578
|
+
> - CONVENTIONS.md — 代码约定
|
|
579
|
+
> - INTEGRATIONS.md — 集成
|
|
580
|
+
> - TESTING.md — 测试现状
|
|
581
|
+
> - CONCERNS.md — 技术债务和风险
|
|
582
|
+
|
|
583
|
+
**下一步由 CLI 决定,不要自己编建议:**
|
|
584
|
+
|
|
585
|
+
```bash
|
|
586
|
+
sillyspec next
|
|
587
|
+
```
|
|
588
|
+
|
|
589
|
+
将 CLI 返回的命令推荐给用户。
|
|
590
|
+
|
|
591
|
+
### 工作区扫描完成后
|
|
592
|
+
|
|
593
|
+
> ✅ 工作区扫描完成!
|
|
594
|
+
>
|
|
595
|
+
> - 子项目 frontend:`frontend/.sillyspec/codebase/`(快扫,3 份文档)
|
|
596
|
+
> - 子项目 backend:`backend/.sillyspec/codebase/`(深扫,7 份文档)
|
|
597
|
+
> - 工作区概览:`.sillyspec/workspace/CODEBASE-OVERVIEW.md`
|
|
598
|
+
>
|
|
599
|
+
> 建议下一步:`/sillyspec:brainstorm '你的需求'`
|
|
600
|
+
|
|
601
|
+
---
|
|
602
|
+
|
|
603
|
+
## Step 6: Git 提交
|
|
604
|
+
|
|
605
|
+
```bash
|
|
606
|
+
git add .sillyspec/
|
|
607
|
+
git commit -m "chore: sillyspec scan - codebase mapped"
|
|
608
|
+
```
|
|
609
|
+
|
|
610
|
+
## 绝对规则
|
|
611
|
+
|
|
612
|
+
- 不修改任何代码
|
|
613
|
+
- 文档必须包含真实文件路径(用反引号格式)
|
|
614
|
+
- 有具体代码模式就列出来(不要写模糊的描述)
|
|
615
|
+
- 如果项目为空 → 告知用户使用 `/sillyspec:init` 初始化新项目
|
|
616
|
+
- **交互模式下,每一步都要等用户回复再继续,不要一次性全部输出**
|
|
617
|
+
|
|
618
|
+
### 路径校验(写入后立即检查)
|
|
619
|
+
|
|
620
|
+
**每份文档写完后,必须用脚本验证路径正确。这是防止 AI 把文件写错目录的硬约束。**
|
|
621
|
+
|
|
622
|
+
```bash
|
|
623
|
+
# 检查所有 codebase 文档是否在正确位置
|
|
624
|
+
for f in STACK ARCHITECTURE STRUCTURE CONVENTIONS INTEGRATIONS TESTING CONCERNS PROJECT SCAN-RAW; do
|
|
625
|
+
if [ -f ".sillyspec/codebase/${f}.md" ]; then
|
|
626
|
+
echo "✅ .sillyspec/codebase/${f}.md"
|
|
627
|
+
elif [ -f "${f}.md" ] || [ -f ".sillyspec/${f}.md" ] || [ -f "codebase/${f}.md" ]; then
|
|
628
|
+
echo "❌ ${f}.md 路径错误!必须在 .sillyspec/codebase/ 下"
|
|
629
|
+
# 自动修正:移动到正确位置
|
|
630
|
+
mkdir -p .sillyspec/codebase
|
|
631
|
+
if [ -f "${f}.md" ]; then mv "${f}.md" ".sillyspec/codebase/${f}.md" && echo " 已修正: ${f}.md → .sillyspec/codebase/${f}.md"; fi
|
|
632
|
+
if [ -f ".sillyspec/${f}.md" ]; then mv ".sillyspec/${f}.md" ".sillyspec/codebase/${f}.md" && echo " 已修正: .sillyspec/${f}.md → .sillyspec/codebase/${f}.md"; fi
|
|
633
|
+
if [ -f "codebase/${f}.md" ]; then mv "codebase/${f}.md" ".sillyspec/codebase/${f}.md" && echo " 已修正: codebase/${f}.md → .sillyspec/codebase/${f}.md"; fi
|
|
634
|
+
fi
|
|
635
|
+
done
|
|
636
|
+
|
|
637
|
+
# 额外检查:扫描整个项目,找出误放的文档
|
|
638
|
+
for f in $(find . -maxdepth 2 -name "ARCHITECTURE.md" -o -name "STACK.md" -o -name "STRUCTURE.md" -o -name "CONVENTIONS.md" -o -name "INTEGRATIONS.md" -o -name "TESTING.md" -o -name "CONCERNS.md" -o -name "PROJECT.md" | grep -v ".sillyspec/codebase/"); do
|
|
639
|
+
if [ -f "$f" ]; then
|
|
640
|
+
echo "❌ 发现误放文件: $f(应该在 .sillyspec/codebase/ 下)"
|
|
641
|
+
mkdir -p .sillyspec/codebase
|
|
642
|
+
name=$(basename "$f")
|
|
643
|
+
mv "$f" ".sillyspec/codebase/${name}"
|
|
644
|
+
echo " 已自动修正: $f → .sillyspec/codebase/${name}"
|
|
645
|
+
fi
|
|
646
|
+
done
|
|
647
|
+
```
|
|
648
|
+
|
|
649
|
+
**铁律:所有扫描生成的文档必须且只能在 `.sillyspec/codebase/` 目录下。** 如果发现 AI 生成到了其他位置,立即移动到正确位置。
|
|
650
|
+
|
|
651
|
+
### 自检门控(Hard Gate)
|
|
652
|
+
|
|
653
|
+
- [ ] STACK.md 是否包含主要语言和框架?
|
|
654
|
+
- [ ] ARCHITECTURE.md 是否描述了整体架构?
|
|
655
|
+
- [ ] STRUCTURE.md 是否包含目录结构?
|
|
656
|
+
- [ ] CONVENTIONS.md 是否描述了编码约定?(深度扫描)
|
|
657
|
+
- [ ] INTEGRATIONS.md 是否列出外部依赖?(深度扫描)
|
|
658
|
+
- [ ] TESTING.md 是否描述了测试状况?(深度扫描)
|
|
659
|
+
- [ ] CONCERNS.md 是否列出了技术债务?(深度扫描)
|
|
660
|
+
- [ ] PROJECT.md 是否生成?
|
|
661
|
+
|
|
662
|
+
### 脚本校验(硬验证)
|
|
663
|
+
|
|
664
|
+
Hard Gate 自检通过后,运行校验脚本:
|
|
665
|
+
|
|
666
|
+
```bash
|
|
667
|
+
bash scripts/validate-scan.sh .sillyspec/codebase
|
|
668
|
+
```
|
|
669
|
+
|
|
670
|
+
- 脚本返回 0 → 自检通过,继续
|
|
671
|
+
- 脚本返回非 0 → 根据错误提示修正文档,重新运行脚本
|