57 lines
3.6 KiB
Markdown
57 lines
3.6 KiB
Markdown
|
# AI-Coding（AI 取材与约束入口）
|
|||
|
|
|
|||
|
|
> 本目录是“轻量化模板库”形态下的 AI 指南：**不改动现有业务代码**，尽量用文档与规格约束引导 OpenSpec 开发模式的 AI 快速、准确地复用本仓库能力。
|
|||
|
|
|
|||
|
|
## 你应该从这里开始读
|
|||
|
|
|
|||
|
|
1. [00-Quick-Profile.md](00-Quick-Profile.md) —— 30 秒摘要（栈、入口链路、Mock、alias）
|
|||
|
|
2. [01-Directory-Map.md](01-Directory-Map.md) —— 仓库地图（模块在哪、职责是什么）
|
|||
|
|
3. [02-Boot-Sequence.md](02-Boot-Sequence.md) —— 初始化链路（`src/main.ts` / `setupVab`）
|
|||
|
|
4. [10-Theme-System.md](10-Theme-System.md) —— Theme 系统（VabTheme + settings + 变量注入）
|
|||
|
|
5. [11-Plugins-System.md](11-Plugins-System.md) —— Plugins（gp 注入/指令/错误捕获）
|
|||
|
|
6. [12-Settings-Store.md](12-Settings-Store.md) —— Settings Store（主题/布局等全局配置）
|
|||
|
|
7. [13-Component-Inventory.md](13-Component-Inventory.md) —— 组件清单（library/components）
|
|||
|
|
8. [14-Store-Modules.md](14-Store-Modules.md) —— Store 模块清单（src/store/modules）
|
|||
|
|
9. [15-Snippet-Map.md](15-Snippet-Map.md) —— 代码段地图（常用片段稳定来源）
|
|||
|
|
10. [16-Config-Keys.md](16-Config-Keys.md) —— Config keys 地图（高影响开关与使用点）
|
|||
|
|
11. [AI-Reuse-Playbook.md](AI-Reuse-Playbook.md) —— AI 复用操作手册（最小闭包、迁移步骤、验收）
|
|||
|
|
12. [Pitfalls.md](Pitfalls.md) —— 已知陷阱与迁移雷区
|
|||
|
|
|
|||
|
|
## OpenSpec-lite（轻量规格）
|
|||
|
|
|
|||
|
|
- [openspec-lite/project.yaml](openspec-lite/project.yaml) —— 项目级约束（技术栈/目录/禁止项/验收门槛）
|
|||
|
|
- [openspec-lite/manifest.yaml](openspec-lite/manifest.yaml) —— 模块清单（供 AI 选模块与定位）
|
|||
|
|
- [openspec-lite/tasks/](openspec-lite/tasks/) —— 任务模板（AI 按模板输出文件与验收项）
|
|||
|
|
- [openspec-lite/modules/](openspec-lite/modules/) —— 模块规格（按需逐步补全；先从高频模块开始）
|
|||
|
|
|
|||
|
|
推荐从这些高频模块规格开始：
|
|||
|
|
|
|||
|
|
- `setup-vab`：`openspec-lite/modules/setup-vab.yaml`
|
|||
|
|
- `config-system`：`openspec-lite/modules/config-system.yaml`
|
|||
|
|
- `api-system`：`openspec-lite/modules/api-system.yaml`
|
|||
|
|
- `icons`：`openspec-lite/modules/icons.yaml`
|
|||
|
|
- `styles`：`openspec-lite/modules/styles.yaml`
|
|||
|
|
- `access-control`：`openspec-lite/modules/access-control.yaml`
|
|||
|
|
- `layouts`：`openspec-lite/modules/layouts.yaml`
|
|||
|
|
- `ui-components`：`openspec-lite/modules/ui-components.yaml`
|
|||
|
|
- `store-settings`：`openspec-lite/modules/store-settings.yaml`
|
|||
|
|
- `vab-theme`：`openspec-lite/modules/vab-theme.yaml`
|
|||
|
|
- `plugin-vab`：`openspec-lite/modules/plugin-vab.yaml`
|
|||
|
|
- `plop`：`openspec-lite/modules/plop.yaml`
|
|||
|
|
- `plugin-directive`：`openspec-lite/modules/plugin-directive.yaml`
|
|||
|
|
- `plugin-errorlog`：`openspec-lite/modules/plugin-errorlog.yaml`
|
|||
|
|
- `plugin-support`：`openspec-lite/modules/plugin-support.yaml`
|
|||
|
|
- `VabApp`：`openspec-lite/modules/vab-app.yaml`
|
|||
|
|
- `VabMenu`：`openspec-lite/modules/vab-menu.yaml`
|
|||
|
|
- `VabTabs`：`openspec-lite/modules/vab-tabs.yaml`
|
|||
|
|
- `VabHeader`：`openspec-lite/modules/vab-header.yaml`
|
|||
|
|
- `VabSideBar`：`openspec-lite/modules/vab-sidebar.yaml`
|
|||
|
|
|
|||
|
|
更多模块（例如 `store-user` / `store-routes` / `store-tabs` / `store-errorlog`）已收录在 `openspec-lite/manifest.yaml` 中，可按需从清单选取。
|
|||
|
|
|
|||
|
|
## 本目录的“轻量化原则”
|
|||
|
|
|
|||
|
|
- **不要求改代码**：所有约束优先通过文档/规格落地；如必须改代码，应先在规格里写明原因与影响面。
|
|||
|
|
- **先可用，再完美**：优先把“模块定位、最小闭包、验收门槛”写清楚。
|
|||
|
|
- **一切可检索**：每份文档都应包含明确关键词与入口文件路径，方便 AI 语义检索/grep。
|