add-coder 0.1.0 → 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 +59 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
# add-coder
|
|
2
2
|
|
|
3
|
+
[codein2027](https://github.com/xiaomingming92/codein2027) 项目配套工具包——将 ADD 范式从"公司内部方法论"落地为"任何人 `npx` 即可体验的开源工具"。
|
|
4
|
+
|
|
3
5
|
一键初始化 ADD（Audit-Driven Development）范式工作流模板，支持 Claude Code、Qoder、VS Code 三端。
|
|
4
6
|
|
|
5
|
-
ADD 范式将 AI 开发从"口述代码"升级为"可审计工程"——DPS/RAHS 双质量闸门 + ADD-7 审计追踪 + policy-update-loop
|
|
7
|
+
ADD 范式将 AI 开发从"口述代码"升级为"可审计工程"——DPS/RAHS 双质量闸门 + ADD-7 审计追踪 + policy-update-loop 运行时自适应。详见 [codein2027/README.md §"ADD 范式与商业化路径"](https://github.com/xiaomingming92/codein2027#add-paradigm)。
|
|
6
8
|
|
|
7
9
|
## 快速开始
|
|
8
10
|
|
|
@@ -10,7 +12,30 @@ ADD 范式将 AI 开发从"口述代码"升级为"可审计工程"——DPS/RAHS
|
|
|
10
12
|
npx add-coder init
|
|
11
13
|
```
|
|
12
14
|
|
|
13
|
-
自动检测 IDE
|
|
15
|
+
首次 init 自动检测 IDE，交互式引导完成 Prisma 初始化、User 模型注入、ADD 模板部署。
|
|
16
|
+
|
|
17
|
+
### 完整初始化流程
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
# ① 首次执行（自动：prisma init + User 模型 + add.prisma + 模板部署）
|
|
21
|
+
npx add-coder init
|
|
22
|
+
# → 是否执行 prisma init？[Y/n] y
|
|
23
|
+
# → 已将 DATABASE_URL 迁移到 .env.development
|
|
24
|
+
# → 已注入 User 模型
|
|
25
|
+
# → 已复制 add.prisma
|
|
26
|
+
# → Core 模板: 55 文件 + adapter 模板已就位
|
|
27
|
+
|
|
28
|
+
# ② 编辑 .env.development 配置数据库连接串
|
|
29
|
+
DATABASE_URL="postgresql://user:pass@localhost:5432/mydb?schema=public"
|
|
30
|
+
|
|
31
|
+
# ③ 第二次执行（自动：prisma migrate + generate）
|
|
32
|
+
npx add-coder init --yes
|
|
33
|
+
# → prisma migrate dev（创建 DevOperation + AuditLog 表）
|
|
34
|
+
# → prisma generate
|
|
35
|
+
# → ADD 治理模型已就绪 ✓
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
> **环境文件优先级**：`.env.development.local` > `.env.development` > `.env.local` > `.env`
|
|
14
39
|
|
|
15
40
|
## 命令
|
|
16
41
|
|
|
@@ -20,6 +45,22 @@ npx add-coder init
|
|
|
20
45
|
| `sync` | 增量同步缺失文件 |
|
|
21
46
|
| `status` | 检查模板完整性 |
|
|
22
47
|
|
|
48
|
+
### init 内部流程
|
|
49
|
+
|
|
50
|
+
`npx add-coder init` 按以下步骤执行：
|
|
51
|
+
|
|
52
|
+
| 步骤 | 动作 | 说明 |
|
|
53
|
+
|------|------|------|
|
|
54
|
+
| ① | 检测 IDE | 扫描 `.qoder/` `.claude/` `.vscode/` 存在性，或通过 `--adapter` 指定 |
|
|
55
|
+
| ② | 加载配置 | 交互式问答 > `add-coder.config.ts` > 自动检测 > 默认值 |
|
|
56
|
+
| ③ | Prisma 注入 | 检测 Prisma → 引导安装 → 注入 User 模型 → 复制 `add.prisma` → 迁移 |
|
|
57
|
+
| ④ | 渲染模板 | 55 个 core 模板文件（skills/agents/templates/plans/specs/scripts…） |
|
|
58
|
+
| ⑤ | 部署适配 | 将 core 内容复制到 `.add/` `.qoder/` `.claude/` 三目录，补 IDE 专属 hooks/mcp |
|
|
59
|
+
| ⑥ | 写入文件 | 交互/yes/force/dry-run 四种模式，`.sh` 脚本自动 `chmod` |
|
|
60
|
+
| ⑦ | 输出摘要 | 新建/跳过/覆盖统计 + 下一步提示 |
|
|
61
|
+
|
|
62
|
+
> **Prisma 注入说明**：ADD-7 审计需要 `DevOperation` + `AuditLog` 两张表。首次 `init` 自动引导 `prisma init` 并注入 `User` 模型，第二次 `init` 执行 `prisma migrate dev` 完成建表。
|
|
63
|
+
|
|
23
64
|
### init 选项
|
|
24
65
|
|
|
25
66
|
| 选项 | 说明 |
|
|
@@ -43,8 +84,22 @@ npx add-coder init
|
|
|
43
84
|
|
|
44
85
|
npm 包提供模板和 MCP 工具链骨架。Report 体系（gateway.md 边界监测）和 policy-update-loop 运行时自适应由宿主项目实现，不在 npm 包覆盖范围内。
|
|
45
86
|
|
|
87
|
+
> 🚧 **即将上线**：ADD 范式项目案例仓库——沉淀真实 ADD 项目案例讲解Report 体系（gateway.md 边界监测）和 policy-update-loop 运行时自适应
|
|
88
|
+
|
|
46
89
|
## 前置条件
|
|
47
90
|
|
|
48
91
|
- Node.js >= 20
|
|
49
|
-
- Prisma >= 6.9
|
|
50
|
-
- PostgreSQL（MCP
|
|
92
|
+
- Prisma >= 6.9 / ^7.0（`init` 时自动检测，无则引导安装）
|
|
93
|
+
- PostgreSQL（MCP 工具链依赖 DevOperation + AuditLog 表）
|
|
94
|
+
|
|
95
|
+
> **推荐**：使用 Podman/Docker 运行 PostgreSQL，参考配置：
|
|
96
|
+
> ```yaml
|
|
97
|
+
> postgres:
|
|
98
|
+
> image: docker.io/postgres:16-alpine
|
|
99
|
+
> ports: ["127.0.0.1:5433:5432"]
|
|
100
|
+
> environment:
|
|
101
|
+
> POSTGRES_DB: mydb
|
|
102
|
+
> POSTGRES_USER: admin
|
|
103
|
+
> POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
|
|
104
|
+
> ```
|
|
105
|
+
> 数据卷建议挂载到 `~/data/your_project/postgres/`，避免容器销毁丢失数据。
|