@ultime/codecraft 1.0.1 → 1.0.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/CHANGELOG.md +5 -0
- package/README.md +7 -1
- package/VERSION +1 -1
- package/adapters/README.md +2 -0
- package/docs/07-ai-prompts.md +148 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -75,6 +75,12 @@ npx codecraft check --root .
|
|
|
75
75
|
|
|
76
76
|
如果确实要把 `SKILL.md` 复制到 agent 的 skills 目录,必须让 `docs/`、`scenarios/`、`prompts/` 与该文件保持 `../../` 的相对位置(符号链接即可),否则入口里的路径会失效。
|
|
77
77
|
|
|
78
|
+
### 4. 让 AI 怎么说
|
|
79
|
+
|
|
80
|
+
可直接复制的提示词见 [docs/07-ai-prompts.md](./docs/07-ai-prompts.md):审计、只出报告、新项目、重构评审、架构设计、模式选型、脚手架、Design System 审计。
|
|
81
|
+
|
|
82
|
+
提示词只负责「怎么说」;模式、范围和规则仍以 `docs/` 为准。
|
|
83
|
+
|
|
78
84
|
## 三种模式
|
|
79
85
|
|
|
80
86
|
| 模式 | 是否改文件 | 对应命令 |
|
|
@@ -182,7 +188,7 @@ A4(单一收口)属于结构判断,由 review 与项目门禁负责,不
|
|
|
182
188
|
## 目录
|
|
183
189
|
|
|
184
190
|
```text
|
|
185
|
-
docs/ 宪法、族卡、AI
|
|
191
|
+
docs/ 宪法、族卡、AI 契约、风格总图、模式、架构、AI 提示词、门禁
|
|
186
192
|
scenarios/ 新项目 / 旧项目审计 / 只出报告 / 重构评审
|
|
187
193
|
adapters/ generic / Trae / Claude 入口
|
|
188
194
|
prompts/ 输出格式
|
package/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.0.
|
|
1
|
+
1.0.2
|
package/adapters/README.md
CHANGED
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
# AI 使用提示词(Prompts)
|
|
2
|
+
|
|
3
|
+
> 用途:给使用者一份可以直接复制的说法,让 AI 按 Codecraft 的模式工作。
|
|
4
|
+
> 读法:先看「最小开场」,再按场景复制;提示词不替代规则,规则正文仍在 `docs/`。
|
|
5
|
+
> 关系:入口见 `adapters/`;输出格式见 `prompts/output.md`;约束见 `02-ai-contract.md`。
|
|
6
|
+
|
|
7
|
+
## 1. 先让 AI 找到 Codecraft
|
|
8
|
+
|
|
9
|
+
在项目的 agent 入口里留一条指针,不要复制规则:
|
|
10
|
+
|
|
11
|
+
- Trae:项目 `.trae/rules/codecraft.md`
|
|
12
|
+
- Claude:`CLAUDE.md`
|
|
13
|
+
- 通用:`AGENTS.md`
|
|
14
|
+
|
|
15
|
+
```md
|
|
16
|
+
代码任务先读 <Codecraft 仓库路径>/codecraft/adapters/<平台>/...
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
平台对应:Trae → `adapters/trae/SKILL.md`,Claude → `adapters/claude/SKILL.md`,其他 → `adapters/generic/AGENTS.md`。
|
|
20
|
+
|
|
21
|
+
## 2. 最小开场
|
|
22
|
+
|
|
23
|
+
任何任务都可以先用这段,再补场景:
|
|
24
|
+
|
|
25
|
+
```text
|
|
26
|
+
使用 Codecraft(<Codecraft 仓库路径>/codecraft)。
|
|
27
|
+
模式:Audit / Plan / Apply。
|
|
28
|
+
范围:<目录 / 包 / 文件 / diff>。
|
|
29
|
+
任务:<一句话>。
|
|
30
|
+
要求:先读 docs/00-constitution.md 和相关族卡;Audit / Plan 不改文件;按 prompts/output.md 输出。
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
模式:
|
|
34
|
+
|
|
35
|
+
- **Audit**:只读,出报告。
|
|
36
|
+
- **Plan**:只读,出计划。
|
|
37
|
+
- **Apply**:改代码 + 跑门禁,先确认范围。
|
|
38
|
+
|
|
39
|
+
## 3. 场景模板
|
|
40
|
+
|
|
41
|
+
### 3.1 旧项目审计(Audit)
|
|
42
|
+
|
|
43
|
+
```text
|
|
44
|
+
使用 Codecraft(<路径>/codecraft)。
|
|
45
|
+
模式:Audit,只读,不改文件。
|
|
46
|
+
范围:当前仓库。
|
|
47
|
+
任务:按 scenarios/audit-existing.md 做一次体检。
|
|
48
|
+
要求:逐条对照 A1–A21,标 pass / warn / fail;每条结论给文件路径、行号和 A-ID;最后给差距清单和分阶段升级计划。
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### 3.2 只出报告(Report Only)
|
|
52
|
+
|
|
53
|
+
```text
|
|
54
|
+
使用 Codecraft(<路径>/codecraft)。
|
|
55
|
+
模式:Audit。
|
|
56
|
+
范围:<目录>。
|
|
57
|
+
任务:只出 findings,不做升级计划,不写文件。
|
|
58
|
+
要求:按 scenarios/report-only.md 输出;每条 finding 有 severity、证据、影响、一句话建议;附版本号和扫描范围。
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### 3.3 新项目设计(Plan)
|
|
62
|
+
|
|
63
|
+
```text
|
|
64
|
+
使用 Codecraft(<路径>/codecraft)。
|
|
65
|
+
模式:Plan,只读。
|
|
66
|
+
输入:业务目标 <...>;端 <mp/app/web/admin>;团队规模 <...>;交付周期 <...>。
|
|
67
|
+
任务:按 scenarios/new-project.md 设计架构。
|
|
68
|
+
要求:先选规模档位(L0/L1/L2),再选环节、目录、契约;给分阶段计划,每阶段一个可验收的垂直切片。
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### 3.4 重构 / 评审(Review / Apply)
|
|
72
|
+
|
|
73
|
+
```text
|
|
74
|
+
使用 Codecraft(<路径>/codecraft)。
|
|
75
|
+
模式:Review(只评审)或 Apply(执行)。
|
|
76
|
+
范围:<diff / 文件 / 模块>。
|
|
77
|
+
任务:按 scenarios/refactor-review.md 评审。
|
|
78
|
+
要求:先列问题(边界 / 状态 / 错误 / 命名 / 注释 / 生成物),再给最小改动计划;能不改就不改;Apply 后跑门禁。
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### 3.5 架构设计
|
|
82
|
+
|
|
83
|
+
```text
|
|
84
|
+
使用 Codecraft(<路径>/codecraft)。
|
|
85
|
+
模式:Plan。
|
|
86
|
+
任务:按 docs/06-architecture.md 给候选架构。
|
|
87
|
+
要求:先定档位和边界,再给 2–3 个候选方案与代价表;不要直接替我做决定;需要时用 ADR 记录取舍。
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### 3.6 模式选型
|
|
91
|
+
|
|
92
|
+
```text
|
|
93
|
+
使用 Codecraft(<路径>/codecraft)。
|
|
94
|
+
模式:Plan。
|
|
95
|
+
任务:在 <场景> 下按 docs/05-patterns.md 选型。
|
|
96
|
+
要求:先说明要解决的「力」(变化点 / 约束 / 代价),再给候选模式;不要按模式名字反推需求。
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
### 3.7 脚手架
|
|
100
|
+
|
|
101
|
+
CLI:
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
npx @ultime/codecraft init --root . --name <name>
|
|
105
|
+
npx @ultime/codecraft init --root . --name <name> --apply
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
对 AI 说:
|
|
109
|
+
|
|
110
|
+
```text
|
|
111
|
+
使用 Codecraft(<路径>/codecraft)。
|
|
112
|
+
模式:Apply。
|
|
113
|
+
任务:按 codecraft init 的 app / library 骨架创建 <name>;先给 dry-run 清单,确认后再 --apply;已存在路径不覆盖。
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
### 3.8 Design System 审计
|
|
117
|
+
|
|
118
|
+
CLI:
|
|
119
|
+
|
|
120
|
+
```bash
|
|
121
|
+
npx @ultime/codecraft check --pack design-system --root .
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
对 AI 说:
|
|
125
|
+
|
|
126
|
+
```text
|
|
127
|
+
使用 Codecraft(<路径>/codecraft)。
|
|
128
|
+
模式:Audit。
|
|
129
|
+
范围:packages/。
|
|
130
|
+
任务:按 design-system pack 审计包依赖、生成物标记、密钥和公开文档路径。
|
|
131
|
+
要求:不要改文件;按 A2 / A11 / A21 归类;给最小修复计划。
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
## 4. 说法上的要点
|
|
135
|
+
|
|
136
|
+
- 先说模式,不要让 AI 猜。
|
|
137
|
+
- 给范围:目录 / 包 / 文件 / diff。
|
|
138
|
+
- 要求「先读后做」,只读相关族卡,不要一次加载全部。
|
|
139
|
+
- 要求证据和验证命令;结论要能反解到 A-ID。
|
|
140
|
+
- 不要用「优化一下」「看着改」这类没有范围的说法。
|
|
141
|
+
- 安全红线不可豁免;发现密钥立即停止并提示轮换。
|
|
142
|
+
|
|
143
|
+
## 5. 参考
|
|
144
|
+
|
|
145
|
+
- [02-ai-contract.md](./02-ai-contract.md)
|
|
146
|
+
- [04-gates.md](./04-gates.md)
|
|
147
|
+
- [../prompts/output.md](../prompts/output.md)
|
|
148
|
+
- [../scenarios/](../scenarios/)
|