@wneng/create-keel 0.4.1 → 0.4.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/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/templates/welcome-html/files/WELCOME.md +39 -0
- package/src/templates/welcome-html/files/keel-README.md +28 -0
- package/src/templates/welcome-html/files/welcome.html +644 -0
- package/src/templates/welcome-html/fragment.yaml +14 -0
package/package.json
CHANGED
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# 👋 欢迎 — <%= it.options.projectName %>
|
|
2
|
+
|
|
3
|
+
本项目由 [keel](https://gitee.com/wangneng521/keel) 框架（@wneng/create-keel <%= it.scaffolderVersion %>）生成。
|
|
4
|
+
|
|
5
|
+
## 🚀 第一次进项目，先看这个
|
|
6
|
+
|
|
7
|
+
打开 [`.keel/welcome.html`](.keel/welcome.html) — 这是一份**面向新成员的可视化指南**，含：
|
|
8
|
+
|
|
9
|
+
- 目录速查 / 关键概念（Tier、Doc Weight、Contract First）
|
|
10
|
+
- 按任务找入口（修 bug / 加 API / 重构 / 升级依赖）
|
|
11
|
+
- 常用命令（按本项目实际选型生成）
|
|
12
|
+
- AI 协作规则
|
|
13
|
+
- 常见问题
|
|
14
|
+
|
|
15
|
+
> 双击文件即可在浏览器打开；IDE 里也能 Open in Browser。完全离线，不依赖外部 CDN。
|
|
16
|
+
|
|
17
|
+
## 📚 给开发者 / AI 的入口
|
|
18
|
+
|
|
19
|
+
| 看什么 | 进哪儿 |
|
|
20
|
+
|---|---|
|
|
21
|
+
| AI 协作总纲 | [`AGENTS.md`](AGENTS.md) |
|
|
22
|
+
| 文档门户（人类） | [`docs/README.md`](docs/README.md) |
|
|
23
|
+
| 契约（机器真值） | [`contracts/README.md`](contracts/README.md) |
|
|
24
|
+
| 治理细则 | [`docs/governance/`](docs/governance/) |
|
|
25
|
+
| 变更分级 | [`docs/governance/change-tiers.md`](docs/governance/change-tiers.md) |
|
|
26
|
+
<% if (it.options.database !== 'none') { %>| 数据库目录 | [`docs/governance/database.md`](docs/governance/database.md) |
|
|
27
|
+
<% } %>
|
|
28
|
+
|
|
29
|
+
## 🧑💻 想直接动手？
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
<% if (it.options.backend === 'node') { %>cd server && npm install && npm test
|
|
33
|
+
<% } else if (it.options.backend === 'java') { %>cd server && mvn -B verify
|
|
34
|
+
<% } else if (it.options.backend === 'python') { %>cd server && python -m venv .venv && source .venv/bin/activate && pip install -e ".[dev]" && pytest -q
|
|
35
|
+
<% } else if (it.options.backend === 'go') { %>cd server && go mod download && go test ./...
|
|
36
|
+
<% } %><% if (it.options.frontend === 'react' || it.options.frontend === 'vue') { %>cd web && npm install && npm run dev
|
|
37
|
+
<% } %>```
|
|
38
|
+
|
|
39
|
+
完整命令见 `.keel/welcome.html` §5。
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# .keel/
|
|
2
|
+
|
|
3
|
+
keel 框架的**元数据 / 资料目录**，与 `.kiro/` `.github/` 等 IDE / 平台目录区分开。
|
|
4
|
+
|
|
5
|
+
## 文件清单
|
|
6
|
+
|
|
7
|
+
| 文件 | 用途 |
|
|
8
|
+
|---|---|
|
|
9
|
+
| `welcome.html` | 面向新成员的可视化指南（双击打开）。包含目录速查、关键概念、任务入口、常用命令、FAQ |
|
|
10
|
+
| `README.md` | 本文件 |
|
|
11
|
+
|
|
12
|
+
> 项目根的 `.scaffolder.json` 是 keel scaffolder 的**机器元数据**，不在本目录——它要保持在仓库根才能让升级 / 校验工具找到。
|
|
13
|
+
|
|
14
|
+
## 是否要进版本控制？
|
|
15
|
+
|
|
16
|
+
`.keel/` 目录建议**进**版本控制：
|
|
17
|
+
|
|
18
|
+
- `welcome.html` 是面向**全团队**的入门资料，不是个人偏好
|
|
19
|
+
- 升级 keel 后 `welcome.html` 会被新生成的版本覆盖；如果你做过本地修改要备份
|
|
20
|
+
- 不要把任何机密、个人 IDE 配置放进 `.keel/`
|
|
21
|
+
|
|
22
|
+
## 想自己改 welcome.html？
|
|
23
|
+
|
|
24
|
+
`welcome.html` 是单文件、内联 CSS / JS、无外部依赖的纯静态页面，可以直接改。
|
|
25
|
+
但下次跑 `npx @wneng/create-keel ...` 升级会覆盖它。如要保护本地改动：
|
|
26
|
+
|
|
27
|
+
- 选项 1：把改动写进 `docs/` 下的对应 markdown，让 welcome.html 仍是"上游版本"
|
|
28
|
+
- 选项 2：在文件顶部加 `<!-- keep-local -->`（未来 scaffolder 升级时会跳过覆盖；目前是约定，未自动化）
|