docs: 重构项目规则与技能文档结构并更新开发指南

This commit is contained in:
augushong
2026-02-01 13:13:03 +08:00
parent 180d9291a3
commit 28267ff1c0
8 changed files with 272 additions and 107 deletions

View File

@@ -0,0 +1,75 @@
---
name: "ulthon-scheme-curd-workflow"
description: "指导使用 Scheme 与 CURD 的标准开发流程。需要新增/调整表结构并生成模块基础代码时调用。"
---
# Scheme + CURD 标准工作流
## 何时调用
- 新增业务表、调整字段、补充索引/注释,并希望保持“代码 <-> 数据库”一致。
- 准备生成控制器/模型/视图等基础 CRUD 代码。
## 关键原则
- CURD 生成前Scheme 与数据库表结构必须完全一致,否则会被拒绝。
- 业务 Scheme 代码统一放在 `app/admin/scheme/`
- 表结构设计遵循项目数据库规范:表名小写下划线、字段注释完整、避免 ENUM。
- 一旦你开始在生成代码上做业务改造,就应默认“正式目录不可被覆盖”,后续结构变更需要走“临时生成 + 按需合并”。
## 推荐流程
### A. 以代码为准(推荐)
1.`app/admin/scheme/` 新建或修改对应表的 Scheme 类。
2. 执行同步,将代码结构同步到数据库:
```bash
php think scheme:sync
```
3. 生成 CURD先生成到临时目录确认更稳妥
```bash
php think curd -t {table} -r
```
4. 初次接入(代码还未做业务改造)可选择正式生成或覆盖:
```bash
php think curd -t {table}
php think curd -t {table} -f
```
### A2. 已经做过业务改造时的推荐做法(临时生成 + 按需合并)
适用场景:你已经修改过 CURD 生成的控制器/模型/视图/JS 等代码,此时再次 `-f` 覆盖会丢失业务改动。
1. 先完成结构同步(`scheme:sync``scheme:make`),确保与数据库一致。
2. 始终生成到临时目录:
```bash
php think curd -t {table} -r
```
3. 对比临时目录与正式目录的差异,仅把“新增字段/新增校验/新增表单项/新增列表列”等结构性变更按需合并回正式代码。
4. 合并后再做一次功能自测,重点验证新增字段的新增/编辑/列表/详情与校验链路。
### B. 以数据库为准
1. 在数据库中创建/修改表结构。
2. 反向生成 Scheme 代码:
```bash
php think scheme:make -t {table}
```
3. 再执行 CURD
```bash
php think curd -t {table} -r
```
## 交互提示
- 命令行工具通常支持 `--force-force``-ff`)跳过交互确认。