docs: 适配企业级编码规范并补充配置
- 新增 docs/standards/coding-standards.md 编码规范文档(16 章节) - 适配当前项目: 单应用+模块化架构(非 Monorepo) - 保留 data-access.ts 模式(非 services/) - 使用 proxy.ts(Next.js 16 重命名) - 保留企业级行数规范(组件 500/800, Actions 800/1000) - 保留 Tailwind v4 CSS 变量设计令牌 - 保留 ActionState<T> 类型 - 含"与原规范的差异说明"附录(10 项差异及原因) - 更新 .trae/rules/project_rules.md: - 新增编码规范章节, 引用 coding-standards.md - 新增架构分层/模块结构/TS规则/命名/组件/Action/Tailwind/安全/提交规范 - 架构文档清单新增解耦路线图 - 新增 .prettierrc 配置(匹配现有代码风格: 双引号/无分号/2空格) - 更新 docs/README.md 新增编码规范章节 - 更新 work_log
This commit is contained in:
@@ -2,6 +2,44 @@
|
||||
|
||||
## 2026-06-17
|
||||
|
||||
### 编码规范适配与配置完善
|
||||
|
||||
#### 问题背景
|
||||
用户提供了一份通用 Next.js 企业级编码规范,需要结合当前项目实际情况进行适配。
|
||||
|
||||
#### 完成工作
|
||||
|
||||
##### 1. 创建适配后的编码规范文档
|
||||
- 新增 `docs/standards/coding-standards.md`(16 章节,全面适配当前项目)
|
||||
- 适配要点:
|
||||
- 项目结构:保留单应用 + 模块化架构(非 Monorepo)
|
||||
- 数据获取层:保留 `modules/[module]/data-access.ts`(非 `services/`)
|
||||
- 中间件:使用 `proxy.ts`(Next.js 16 重命名,非 `middleware.ts`)
|
||||
- 行数限制:保留企业级规范(组件 500/800,Actions 800/1000)
|
||||
- Tailwind:保留 v4 CSS 变量设计令牌方式
|
||||
- ActionState:保留现有 `ActionState<T>` 类型(非 `ActionResult` 联合类型)
|
||||
- 环境变量:保留 `@t3-oss/env-nextjs` + Zod(已实现)
|
||||
- 新增"与原规范的差异说明"附录,列出 10 项差异及原因
|
||||
|
||||
##### 2. 更新项目规则
|
||||
- 更新 `.trae/rules/project_rules.md`:
|
||||
- 新增"编码规范"章节,引用 `docs/standards/coding-standards.md`
|
||||
- 新增架构分层规则、模块标准结构、TypeScript 规则、命名规范、组件规范、Server Action 规范、Tailwind 规范、安全规范、提交规范
|
||||
- 架构文档清单新增解耦路线图
|
||||
- 行数规范新增工具函数 ≤40 行、自定义 Hook ≤80 行
|
||||
|
||||
##### 3. 补充缺失的配置文件
|
||||
- 新增 `.prettierrc`(匹配现有代码风格:双引号、无分号、2 空格、printWidth 100)
|
||||
- 配置 `prettier-plugin-tailwindcss` 插件(已在 devDependencies 中)
|
||||
|
||||
##### 4. 更新文档索引
|
||||
- `docs/README.md` 新增"编码规范"章节,登记 coding-standards.md 和 project_rules.md
|
||||
|
||||
#### 验证
|
||||
- 待验证 lint + tsc
|
||||
|
||||
---
|
||||
|
||||
### 架构全面审查与文档重构
|
||||
|
||||
#### 问题背景
|
||||
|
||||
Reference in New Issue
Block a user