airail 0.1.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.
Files changed (46) hide show
  1. package/bin/airail.js +3 -0
  2. package/dist/cli/add.js +136 -0
  3. package/dist/cli/clear.js +87 -0
  4. package/dist/cli/colors.js +18 -0
  5. package/dist/cli/config.js +232 -0
  6. package/dist/cli/index.js +144 -0
  7. package/dist/cli/init.js +74 -0
  8. package/dist/cli/status.js +66 -0
  9. package/dist/cli/update.js +51 -0
  10. package/dist/index.js +4 -0
  11. package/dist/utils.js +243 -0
  12. package/package.json +39 -0
  13. package/skills/universal/code-quality/SKILL.md +37 -0
  14. package/skills/universal/code-review/SKILL.md +37 -0
  15. package/skills/universal/error-handling/SKILL.md +40 -0
  16. package/skills/universal/git-workflow/SKILL.md +37 -0
  17. package/skills/universal/performance/SKILL.md +31 -0
  18. package/skills/universal/security/SKILL.md +33 -0
  19. package/skills/universal/skill-add/SKILL.md +241 -0
  20. package/skills/universal/testing/SKILL.md +39 -0
  21. package/src/templates/CLAUDE.md +11 -0
  22. package/src/templates/agents/code-reviewer.md +58 -0
  23. package/src/templates/agents/project-manager.md +45 -0
  24. package/src/templates/commands/add-todo.md +24 -0
  25. package/src/templates/commands/check.md +42 -0
  26. package/src/templates/commands/crud.md +27 -0
  27. package/src/templates/commands/dev.md +21 -0
  28. package/src/templates/commands/init-docs.md +80 -0
  29. package/src/templates/commands/next.md +31 -0
  30. package/src/templates/commands/progress.md +38 -0
  31. package/src/templates/commands/start.md +30 -0
  32. package/src/templates/commands/update-status.md +22 -0
  33. package/src/templates/docs/README.md +36 -0
  34. package/src/templates/docs//345/211/215/347/253/257/345/274/200/345/217/221/346/214/207/345/215/227.md +59 -0
  35. package/src/templates/docs//345/220/216/347/253/257/345/274/200/345/217/221/346/214/207/345/215/227.md +104 -0
  36. package/src/templates/docs//345/267/245/345/205/267/347/261/273/344/275/277/347/224/250/346/214/207/345/215/227.md +80 -0
  37. package/src/templates/docs//346/225/260/346/215/256/345/272/223/350/256/276/350/256/241/350/247/204/350/214/203.md +91 -0
  38. package/src/templates/docs//346/226/260/345/212/237/350/203/275/345/274/200/345/217/221/346/265/201/347/250/213.md +77 -0
  39. package/src/templates/docs//346/241/206/346/236/266/350/257/264/346/230/216.md +52 -0
  40. package/src/templates/hooks/guard.js +113 -0
  41. package/src/templates/hooks/inject.js +40 -0
  42. package/src/templates/hooks/skill-eval.js +48 -0
  43. package/src/templates/settings.json +24 -0
  44. package/src/templates/templates//345/276/205/345/212/236/346/270/205/345/215/225.md +22 -0
  45. package/src/templates/templates//351/234/200/346/261/202/346/226/207/346/241/243.md +47 -0
  46. package/src/templates/templates//351/241/271/347/233/256/347/212/266/346/200/201.md +50 -0
@@ -0,0 +1,33 @@
1
+ ---
2
+ name: security
3
+ version: 1.0.0
4
+ pack: universal
5
+ description: 安全规范,OWASP Top 10 防护
6
+ triggers:
7
+ - 安全
8
+ - SQL注入
9
+ - XSS
10
+ - 认证
11
+ - 权限
12
+ ---
13
+
14
+ # 安全规范
15
+
16
+ ## 输入验证
17
+
18
+ - 所有用户输入在系统边界验证,不信任任何外部数据
19
+ - 使用参数化查询,禁止字符串拼接 SQL
20
+ - 输出到 HTML 时转义特殊字符
21
+
22
+ ## 认证与授权
23
+
24
+ - 密码必须 bcrypt/argon2 哈希存储,禁止明文或 MD5
25
+ - Token 设置合理过期时间
26
+ - 每个接口明确声明所需权限
27
+
28
+ ## 禁止事项
29
+
30
+ - 禁止硬编码密钥/密码/token 到代码
31
+ - 禁止在日志中打印密码、token、身份证号等敏感信息
32
+ - 禁止在 URL 参数中传递敏感数据
33
+ - 禁止 `eval()` 执行用户输入
@@ -0,0 +1,241 @@
1
+ ---
2
+ name: add-skill
3
+ description: |
4
+ 当需要为框架增加新技能、为新的模块功能编写技能文档时自动使用此 Skill。
5
+
6
+ 触发场景:
7
+ - 需要为新模块添加技能
8
+ - 需要为新功能编写技能文档
9
+ - 需要扩展框架的技能系统
10
+ - 需要将实现步骤转化为可复用技能
11
+
12
+ 触发词:添加技能、创建技能、新技能、技能开发、写技能、技能文档、skill 创建
13
+ ---
14
+
15
+ # 技能创建指南
16
+
17
+ ## 概述
18
+
19
+ 本指南用于添加新的技能(Skill)。技能通过 UserPromptSubmit Hook 自动评估和激活,确保 AI 在编码前加载领域专业知识。
20
+
21
+ **技能系统工作原理**:
22
+
23
+ ```
24
+ 用户提交问题
25
+ ↓ skill-eval.js Hook 触发
26
+ 注入技能评估指令
27
+ ↓ AI 评估匹配的技能
28
+ 逐个调用 Skill(技能名)
29
+ ↓ 读取 .claude/skills/{技能名}/SKILL.md
30
+ AI 获得领域知识后开始实现
31
+ ```
32
+
33
+ ---
34
+
35
+ ## YAML 头部规范
36
+
37
+ 每个 SKILL.md 文件**必须**以 YAML 头部开始:
38
+
39
+ ```yaml
40
+ ---
41
+ name: {技能名称}
42
+ description: |
43
+ {第一行:简短描述(一句话说明技能用途或定位)}
44
+
45
+ 触发场景:
46
+ - {场景1}
47
+ - {场景2}
48
+ - {场景3}
49
+ (至少3个场景)
50
+
51
+ 触发词:{关键词1}、{关键词2}、{关键词3}、{关键词4}、{关键词5}
52
+ (至少5个触发词,用中文顿号分隔)
53
+ ---
54
+ ```
55
+
56
+ ### name 字段规范
57
+
58
+ | 规则 | 说明 | 示例 |
59
+ |------|------|------|
60
+ | **格式** | kebab-case(全小写,横线连接) | `json-serialization` |
61
+ | **禁止** | 下划线、驼峰、空格 | ~~`json_serialization`~~, ~~`jsonSerialization`~~ |
62
+ | **长度** | 1-4 个单词 | `ui-pc`, `crud-development`, `redis-cache` |
63
+
64
+ ### description 第一行风格
65
+
66
+ 第一行没有强制格式,参考现有技能的两种常见风格:
67
+
68
+ **风格 A:直述型**(多数技能采用)
69
+ ```yaml
70
+ description: |
71
+ 后端 CRUD 开发规范。基于 RuoYi-Vue-Plus 三层架构。
72
+ 后端安全开发规范。包含 Sa-Token 认证授权、数据脱敏。
73
+ 后端工具类使用指南。包含 MapstructUtils、StringUtils 等。
74
+ ```
75
+
76
+ **风格 B:触发型**
77
+ ```yaml
78
+ description: |
79
+ 当需要进行技术选型、对比方案时自动使用此 Skill。
80
+ 当需要为框架增加新技能时自动使用此 Skill。
81
+ ```
82
+
83
+ ### 实际技能 YAML 头部示例
84
+
85
+ ```yaml
86
+ ---
87
+ name: crud-development
88
+ description: |
89
+ 后端 CRUD 开发规范。
90
+
91
+ 触发场景:
92
+ - 新建业务模块的 CRUD 功能
93
+ - 创建 Entity、BO、VO、Service、Mapper、Controller
94
+ - 分页查询、新增、修改、删除、导出
95
+ - 查询条件构建(buildQueryWrapper)
96
+
97
+ 触发词:CRUD、增删改查、新建模块、Entity、BO、VO、Service、Mapper、Controller、分页查询、buildQueryWrapper、@AutoMapper、BaseMapperPlus、TenantEntity
98
+ ---
99
+ ```
100
+
101
+ ```yaml
102
+ ---
103
+ name: redis-cache
104
+ description: |
105
+ 当需要使用Redis缓存、分布式锁、限流等功能时自动使用此Skill。
106
+
107
+ 触发场景:
108
+ - 使用Redis缓存数据
109
+ - 配置Spring Cache缓存注解
110
+ - 实现分布式锁
111
+ - 实现接口限流
112
+
113
+ 触发词:Redis、缓存、Cache、@Cacheable、@CacheEvict、@CachePut、RedisUtils、CacheUtils、分布式锁、RLock、限流、RateLimiter
114
+ ---
115
+ ```
116
+
117
+ ---
118
+
119
+ ## 第 1 步:规划
120
+
121
+ ### 1.1 定义技能属性
122
+
123
+ 创建前先明确:
124
+
125
+ | 属性 | 说明 | 示例 |
126
+ |------|------|------|
127
+ | **名称** | kebab-case 格式 | `payment-gateway` |
128
+ | **类别** | 后端/通用/前端(需 plus-ui) | 后端 |
129
+ | **触发场景** | 至少 3 个具体场景 | 支付接入、退款处理、对账 |
130
+ | **触发词** | 至少 5 个关键词 | 支付、退款、订单、对账、Payment |
131
+ | **参考代码** | 项目中的真实代码位置 | `ruoyi-modules/ruoyi-system/` |
132
+
133
+ ### 1.2 检查范围冲突
134
+
135
+ 查看现有技能列表,确保不与已有技能重叠:
136
+
137
+ **当前已有技能**(`.claude/skills/` 下 )
138
+
139
+
140
+
141
+ ## 第 2 步:编写 SKILL.md
142
+
143
+ ### 2.1 文件位置
144
+
145
+ ```
146
+ .claude/skills/{技能名}/SKILL.md
147
+ ```
148
+
149
+ ### 2.2 推荐内容结构
150
+
151
+ ```markdown
152
+ ---
153
+ name: {技能名称}
154
+ description: |
155
+ {描述、触发场景、触发词}
156
+ ---
157
+
158
+ # {技能标题}
159
+
160
+ ## 概述
161
+ {简明介绍,1-2 段}
162
+
163
+ ## 核心工具类/API
164
+ {主要类和方法列表}
165
+
166
+ ## 使用规范
167
+ {最佳实践和规则}
168
+
169
+ ## 代码示例
170
+ {真实代码片段}
171
+
172
+ ## 常见错误
173
+ {正确做法 vs 错误做法对比}
174
+
175
+ ## 注意
176
+ {与其他技能的边界说明}
177
+ ```
178
+
179
+ ### 2.3 内容质量要点
180
+
181
+ - **代码示例必须来自项目实际代码**,不要虚构类名、方法名
182
+ - **技能内容应该通用**,避免特定项目的硬编码规范
183
+ - 技能不需要固定行数要求,以内容实用为准(实际范围 200-650 行)
184
+
185
+ ### 2.4 不同类型技能的侧重
186
+
187
+ | 类型 | 侧重 | 示例 |
188
+ |------|------|------|
189
+ | 后端开发类 | 代码模板、标准写法、禁止项 | crud-development |
190
+ | 工具类 | API 列表、使用示例、返回值 | utils-toolkit |
191
+ | 中间件类 | 配置方法、集成步骤、注意事项 | redis-cache |
192
+ | 流程类 | 步骤说明、决策树、检查清单 | brainstorm |
193
+
194
+ ---
195
+
196
+ ## 第 3 步:验证技能
197
+
198
+ ### 完整检查清单
199
+
200
+ **文件**:
201
+ - [ ] `.claude/skills/{技能名}/SKILL.md` 已创建
202
+
203
+ **YAML 头部**:
204
+ - [ ] `name` 使用 kebab-case 格式
205
+ - [ ] description 包含触发场景(至少 3 个)
206
+ - [ ] description 包含触发词(至少 5 个)
207
+ - [ ] 各部分之间有空行
208
+
209
+ **内容**:
210
+ - [ ] 代码示例来自项目实际代码,无虚构内容
211
+ - [ ] 包名使用 `org.dromara.*`
212
+ - [ ] 与现有技能无范围冲突(或已说明边界)
213
+
214
+ ---
215
+
216
+ ## 常见陷阱
217
+
218
+ ### 1. 触发词过于宽泛
219
+
220
+ **症状**:技能在不相关场景被频繁误触发
221
+
222
+ **原因**:触发词太通用(如"开发"、"功能")
223
+
224
+ **解决**:使用具体术语(如"CRUD开发"、"支付接入")
225
+
226
+ ### 2. 代码示例虚构
227
+
228
+ **症状**:AI 参考技能生成的代码使用了不存在的类或方法
229
+
230
+ **原因**:编写技能时没有验证引用的类名、方法名在项目中真实存在
231
+
232
+ **解决**:编写前用 Grep/Glob 搜索确认引用的类和方法确实存在
233
+
234
+ ### 3. 技能范围与现有技能重叠
235
+
236
+ **症状**:同一个问题触发多个技能,指导矛盾
237
+
238
+ **解决**:在 SKILL.md 末尾添加"注意"段落说明边界,例如:
239
+ ```
240
+ 注意:如果是行级数据权限(@DataPermission),请使用 data-permission。
241
+ ```
@@ -0,0 +1,39 @@
1
+ ---
2
+ name: testing
3
+ version: 1.0.0
4
+ pack: universal
5
+ description: 测试策略规范
6
+ triggers:
7
+ - 测试
8
+ - 单元测试
9
+ - test
10
+ - mock
11
+ ---
12
+
13
+ # 测试规范
14
+
15
+ ## 测试原则
16
+
17
+ - 测试行为,不测实现细节
18
+ - 一个测试只验证一件事
19
+ - 测试名称描述场景:`should return 404 when user not found`
20
+
21
+ ## 测试结构(AAA)
22
+
23
+ ```
24
+ Arrange - 准备数据
25
+ Act - 执行操作
26
+ Assert - 验证结果
27
+ ```
28
+
29
+ ## 什么值得测试
30
+
31
+ - 业务逻辑(核心价值)
32
+ - 边界条件(空值、最大值、负数)
33
+ - 错误路径
34
+
35
+ ## 禁止事项
36
+
37
+ - 禁止测试框架本身的行为
38
+ - 禁止在测试中使用真实数据库/网络(用 mock)
39
+ - 禁止测试私有方法(通过公共接口测试)
@@ -0,0 +1,11 @@
1
+ # AI Coding Standards
2
+
3
+ This project uses [airail](https://github.com/your-org/airail) to enforce coding standards.
4
+
5
+ ## Installed Skills
6
+
7
+ Skills are located in `.claude/skills/`. The AI will automatically activate relevant skills before implementing code.
8
+
9
+ ## Adding Custom Rules
10
+
11
+ Add project-specific rules to this file. They will be loaded at session start.
@@ -0,0 +1,58 @@
1
+ ---
2
+ name: code-reviewer
3
+ description: 代码审查专家,在提交代码前进行全面的规范检查和质量评估。当用户完成功能开发、需要代码审查时调用。
4
+ ---
5
+
6
+ # 代码审查专家
7
+
8
+ ## 角色定位
9
+
10
+ 你是一位严格的代码审查专家,熟悉本项目的所有规范。你的职责是在代码合并前发现问题,而不是帮助实现功能。
11
+
12
+ ## 审查流程
13
+
14
+ 1. 读取 `.claude/docs/后端开发指南.md` 和 `.claude/docs/数据库设计规范.md`
15
+ 2. 逐文件检查,按严重程度分类问题
16
+ 3. 输出结构化审查报告
17
+
18
+ ## 审查维度
19
+
20
+ ### 必须修复(阻塞合并)
21
+
22
+ - 安全漏洞(SQL 注入、XSS、未授权访问)
23
+ - 硬编码密码/密钥/敏感配置
24
+ - 命名不符合项目规范
25
+ - 缺少必要的事务注解
26
+ - 直接暴露 Entity 作为接口返回值
27
+
28
+ ### 建议修复(不阻塞)
29
+
30
+ - 代码重复(可提取工具方法)
31
+ - 缺少注释的复杂逻辑
32
+ - 性能隐患(N+1 查询、大循环等)
33
+ - 异常处理不完整
34
+
35
+ ### 建议优化(可选)
36
+
37
+ - 代码可读性改进
38
+ - 更优雅的实现方式
39
+
40
+ ## 输出格式
41
+
42
+ ```
43
+ 📋 代码审查报告
44
+
45
+ 文件:{{FILE_PATH}}
46
+
47
+ 🔴 必须修复({{COUNT}} 项)
48
+ - 行 {{LINE}}:{{ISSUE}}
49
+ 建议:{{SUGGESTION}}
50
+
51
+ 🟡 建议修复({{COUNT}} 项)
52
+ - 行 {{LINE}}:{{ISSUE}}
53
+
54
+ 🟢 建议优化({{COUNT}} 项)
55
+ - {{ISSUE}}
56
+
57
+ 总结:{{SUMMARY}}
58
+ ```
@@ -0,0 +1,45 @@
1
+ ---
2
+ name: project-manager
3
+ description: 项目管理助手,负责跟踪项目进度、管理待办事项、生成进度报告。当用户需要了解项目状态、规划下一步工作时调用。
4
+ ---
5
+
6
+ # 项目管理助手
7
+
8
+ ## 角色定位
9
+
10
+ 你是项目管理助手,专注于跟踪进度和规划任务,不参与具体代码实现。
11
+
12
+ ## 核心职责
13
+
14
+ 1. **进度跟踪**:读取 `.claude/templates/项目状态.md`,分析当前完成情况
15
+ 2. **任务规划**:根据待办清单和代码现状,给出优先级建议
16
+ 3. **风险识别**:发现可能阻塞进度的问题,提前预警
17
+
18
+ ## 常用操作
19
+
20
+ ### 查看项目状态
21
+
22
+ 读取以下文件综合分析:
23
+ - `.claude/templates/项目状态.md`
24
+ - `.claude/templates/待办清单.md`
25
+ - 项目目录结构(判断各模块完成度)
26
+
27
+ ### 更新进度
28
+
29
+ 当用户完成某个功能后:
30
+ 1. 在待办清单中标记对应任务为完成
31
+ 2. 更新项目状态文档的完成度
32
+ 3. 追加变更记录
33
+
34
+ ### 规划下一步
35
+
36
+ 根据以下因素给出建议:
37
+ - 未完成的高优先级任务
38
+ - 当前阻塞项
39
+ - 模块间的依赖关系
40
+
41
+ ## 输出风格
42
+
43
+ - 简洁直接,用数字和百分比量化进度
44
+ - 高优先级问题用 🔴 标注
45
+ - 已完成用 ✅,进行中用 🔄,待开始用 ⬜
@@ -0,0 +1,24 @@
1
+ # 添加待办事项
2
+
3
+ > 使用方式:`/add-todo <任务描述>`
4
+
5
+ ## 执行流程
6
+
7
+ 1. 解析任务描述
8
+ 2. 追加到 `.claude/templates/项目状态.md` 的待办清单
9
+ 3. 输出确认信息
10
+
11
+ ## 示例
12
+
13
+ ```
14
+ /add-todo 实现用户导出 Excel 功能
15
+ /add-todo 修复订单列表分页 bug
16
+ /add-todo 优化商品查询接口性能
17
+ ```
18
+
19
+ ## 输出格式
20
+
21
+ ```
22
+ ✅ 已添加待办:{{TASK}}
23
+ 当前待办总数:{{COUNT}} 项
24
+ ```
@@ -0,0 +1,42 @@
1
+ # 代码规范检查
2
+
3
+ > 使用方式:在 Claude Code 中输入 `/check`
4
+
5
+ ## 检查范围
6
+
7
+ 对当前改动的文件(或指定文件)进行规范检查。
8
+
9
+ ## 检查清单
10
+
11
+ ### 通用检查
12
+
13
+ - [ ] 命名符合项目规范(参考 [后端开发指南](../docs/后端开发指南.md))
14
+ - [ ] 没有硬编码的配置项(密码、URL、密钥等)
15
+ - [ ] 没有调试输出(console.log / System.out.println / print)
16
+ - [ ] 异常处理使用项目统一方式
17
+ - [ ] 没有重复代码(优先复用已有工具类)
18
+
19
+ ### 后端检查
20
+
21
+ - [ ] 包名/命名空间符合规范
22
+ - [ ] Controller 有统一返回格式包装
23
+ - [ ] 写操作 Service 方法有事务注解
24
+ - [ ] 敏感接口有权限校验注解
25
+ - [ ] 入参有校验注解(@NotNull / @Valid 等)
26
+ - [ ] 返回对象使用 VO/DTO,不直接暴露 Entity
27
+
28
+ ### 前端检查(如有)
29
+
30
+ - [ ] 接口调用使用统一封装
31
+ - [ ] 表单有前端校验
32
+ - [ ] 异步操作有 loading 状态
33
+ - [ ] 错误有友好提示
34
+
35
+ ## 输出格式
36
+
37
+ ```
38
+ ✅ 通过:xxx
39
+ ❌ 问题:xxx
40
+ 位置:文件名:行号
41
+ 建议:xxx
42
+ ```
@@ -0,0 +1,27 @@
1
+ # 快速生成 CRUD
2
+
3
+ > 使用方式:`/crud <表名>` 或 `/crud`(交互式)
4
+
5
+ ## 执行流程
6
+
7
+ 1. 连接数据库,读取表结构(或由用户提供 DDL)
8
+ 2. 确认生成范围(仅后端 / 前后端全套)
9
+ 3. 按 [新功能开发流程](../docs/新功能开发流程.md) 生成代码
10
+ 4. 输出所有生成文件的清单
11
+
12
+ ## 生成内容
13
+
14
+ - Entity / Domain
15
+ - DTO / VO(查询入参 + 列表出参 + 详情出参)
16
+ - Mapper / Repository + XML(如有)
17
+ - Service 接口 + 实现
18
+ - Controller(增删改查 + 分页列表)
19
+ - 前端页面(如适用)
20
+
21
+ ## 与 /dev 的区别
22
+
23
+ | | /crud | /dev |
24
+ |---|---|---|
25
+ | 适用场景 | 已有表,快速生成标准 CRUD | 新功能,包含业务逻辑设计 |
26
+ | 交互程度 | 低,自动生成 | 高,需要确认方案 |
27
+ | 业务逻辑 | 仅标准增删改查 | 包含复杂业务逻辑 |
@@ -0,0 +1,21 @@
1
+ # commands/dev.md
2
+ # 开发新功能
3
+
4
+ > 使用方式:在 Claude Code 中输入 `/dev`
5
+
6
+ ## 执行流程
7
+
8
+ 1. **需求确认**:理解要开发的功能,列出关键点
9
+ 2. **重复检查**:扫描现有代码,确认功能不重复
10
+ 3. **数据库分析**:检查是否需要新建表或修改现有表
11
+ 4. **方案设计**:列出要创建/修改的文件清单,等待确认
12
+ 5. **代码生成**:按 [新功能开发流程](../docs/新功能开发流程.md) 逐层实现
13
+ 6. **完成报告**:列出所有变更文件,提示下一步操作
14
+
15
+ ## AI 执行规则
16
+
17
+ - 开始写代码前必须先列出方案,等待用户确认
18
+ - 严格遵守 [后端开发指南](../docs/后端开发指南.md) 中的命名和分层规范
19
+ - 新建表必须遵守 [数据库设计规范](../docs/数据库设计规范.md)
20
+ - 优先复用 [工具类使用指南](../docs/工具类使用指南.md) 中的已有工具
21
+ - 禁止修改框架核心代码
@@ -0,0 +1,80 @@
1
+ # 初始化项目规范文档
2
+
3
+ > 使用方式:在 Claude Code 中输入 `/init-docs`
4
+ > 适用场景:项目首次接入 AIRail 后,让 AI 读取现有代码自动填充 `.claude/docs/` 下的规范文档模板。
5
+ > 前提条件:已执行 `airail init`,`.claude/docs/` 下已有空白模板文件。
6
+
7
+ ## 执行步骤
8
+
9
+ ### 第一步:探测项目基本信息
10
+
11
+ 读取以下文件(存在则读取):
12
+ - `pom.xml` / `build.gradle` → Java 项目,提取 groupId、依赖版本
13
+ - `package.json` → Node 项目,提取 name、dependencies
14
+ - `go.mod` → Go 项目,提取 module 名
15
+ - `requirements.txt` / `pyproject.toml` → Python 项目
16
+ - `*.csproj` → .NET 项目
17
+
18
+ 输出识别结果:项目名称、语言、框架、主要依赖版本。
19
+
20
+ ### 第二步:分析代码结构
21
+
22
+ 扫描项目目录(跳过 node_modules / target / dist / .git):
23
+
24
+ 1. **包结构 / 目录结构**:列出顶层目录和主要子目录
25
+ 2. **命名规范**:抽取 3-5 个典型文件名,总结命名风格(驼峰/下划线/中划线)
26
+ 3. **代码分层**:识别 controller/service/repository 或 handler/service/dao 等分层模式
27
+ 4. **现有工具类**:找出 utils/helper/common 目录下的工具类,列出主要方法
28
+
29
+ ### 第三步:填充规范文档
30
+
31
+ 根据分析结果,逐一更新 `.claude/docs/` 下已有的模板文件(将 TODO 注释替换为真实内容):
32
+
33
+ #### 必须填充
34
+
35
+ **`README.md`** — 项目概览
36
+ - 填入真实的项目名称、技术栈版本
37
+ - 填入真实的目录结构(从代码读取)
38
+ - 填入真实的启动命令
39
+
40
+ **`框架说明.md`** — 技术栈规范
41
+ - 填入实际使用的框架版本
42
+ - 根据代码中的实际用法描述使用规范
43
+ - 列出项目中已有的核心依赖及用途
44
+
45
+ **`后端开发指南.md`** — 后端规范,仅当存在后端代码时填充,否则保留空白模板
46
+ - 从现有代码中提取真实的包名/命名空间
47
+ - 描述实际的分层结构(从代码目录推断)
48
+ - 提取 1-2 个现有接口作为标准示例
49
+
50
+ **`前端开发指南.md`**:仅当存在前端代码时填充,否则保留空白模板
51
+ #### 按需填充
52
+
53
+ - **`数据库设计规范.md`**:仅当存在 ORM 依赖或 SQL 文件时填充
54
+ - **`工具类使用指南.md`**:扫描 utils/helper/common 目录,列出已有工具类及用法
55
+
56
+ ### 第四步:汇报结果
57
+
58
+ 生成完成后输出:
59
+
60
+ ```
61
+ 已填充/更新以下文档:
62
+ ✔ .claude/docs/README.md
63
+ ✔ .claude/docs/框架说明.md
64
+ ✔ .claude/docs/后端开发指南.md
65
+ ...
66
+
67
+ 仍需人工补充(搜索 TODO 标记):
68
+ - 业务模块职责说明
69
+ - 代码审查标准
70
+ - 禁止事项清单
71
+
72
+ 下一步:重启 Claude Code 会话使文档生效,然后输入 /start 让 AI 了解项目。
73
+ ```
74
+
75
+ ## 注意事项
76
+
77
+ - 优先从代码中读取真实信息,不使用占位符
78
+ - 如果某项信息无法从代码推断,保留 `TODO:` 标记并说明原因
79
+ - 不覆盖用户已手动编辑过的内容(检查文件修改时间或询问用户)
80
+ - 文档语言与项目代码注释语言保持一致
@@ -0,0 +1,31 @@
1
+ # 下一步建议
2
+
3
+ > 使用方式:在 Claude Code 中输入 `/next`
4
+
5
+ ## 执行流程
6
+
7
+ 1. 读取项目状态文档和待办清单
8
+ 2. 分析当前代码完成情况
9
+ 3. 给出优先级排序的下一步建议
10
+
11
+ ## 输出格式
12
+
13
+ ```
14
+ 🎯 下一步建议
15
+
16
+ 高优先级:
17
+ 1. {{HIGH_PRIORITY_1}} 原因:{{REASON}}
18
+ 2. {{HIGH_PRIORITY_2}}
19
+
20
+ 中优先级:
21
+ 3. {{MID_PRIORITY_1}}
22
+
23
+ 需要确认:
24
+ ❓ {{QUESTION_1}}
25
+ ```
26
+
27
+ ## 建议优先级规则
28
+
29
+ - **高**:阻塞其他功能开发的基础模块、已承诺的功能
30
+ - **中**:独立功能模块、优化项
31
+ - **低**:文档完善、重构、非紧急优化
@@ -0,0 +1,38 @@
1
+ # 项目进度梳理
2
+
3
+ > 使用方式:在 Claude Code 中输入 `/progress`
4
+
5
+ ## 执行流程
6
+
7
+ 1. 扫描项目所有模块目录
8
+ 2. 分析各模块代码完整性(有无 Controller/Service/Mapper)
9
+ 3. 读取 `.claude/templates/项目状态.md` 中的待办清单
10
+ 4. 输出进度报告
11
+
12
+ ## 输出格式
13
+
14
+ ```
15
+ 📊 项目进度报告
16
+
17
+ 已完成模块:
18
+ ✅ {{MODULE_1}} - 增删改查完整
19
+ ✅ {{MODULE_2}} - 增删改查完整
20
+
21
+ 进行中:
22
+ 🔄 {{MODULE_3}} - Service 已完成,Controller 待实现
23
+
24
+ 待开始:
25
+ ⬜ {{MODULE_4}}
26
+
27
+ 待办事项(来自项目状态文档):
28
+ - [ ] {{TODO_1}}
29
+ - [ ] {{TODO_2}}
30
+ ```
31
+
32
+ ## 完成度判定标准
33
+
34
+ | 状态 | 判定条件 |
35
+ |------|---------|
36
+ | ✅ 完成 | Controller + Service + Mapper/Repository 均存在 |
37
+ | 🔄 进行中 | 部分层已实现 |
38
+ | ⬜ 待开始 | 仅有表结构或需求,无代码 |