Browse Source

📝 docs(architecture): 重构项目文档架构并迁移开发规范

- 创建新的开发规范文档 docs/architecture/development-standards.md
- 从CLAUDE.md迁移开发环境说明和项目规范到新文档
- 更新编码标准文档,添加.roo/rules规范文件引用
- 重构文档索引,添加开发规范导航条目
- 调整Vite配置,忽略docs目录的文件监视

📝 docs(workflow): 整合Claude Code开发工具配置到开发工作流

- 将开发工具配置从CLAUDE.md迁移到开发工作流文档
- 添加包管理器、类型检查、数据库访问等工具配置说明
- 完善测试相关配置文档,包括Vitest和E2E测试说明
yourname 2 months ago
parent
commit
0015eb9109

+ 46 - 40
CLAUDE.md

@@ -2,43 +2,49 @@
 
 This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
 
-### 开发环境说明
-- 多八多云端开发容器环境
-- Node.js 20.19.2
-- MySQL 8 (默认数据库: d8dai)
-- Redis 7
-- MinIO(默认存储桶: d8dai)
-- 所有服务使用默认参数连接,正式环境参数相同
-- 默认开放8080端口供外网访问
-
-## Project Standards & Rules
-- @.roo/rules/01-general.md - 通用开发规范
-- @.roo/rules/02-typescript.md - TypeScript规范
-- @.roo/rules/03-modules.md - 模块化规范
-- @.roo/rules/04-api.md - API开发规范
-- @.roo/rules/05-database.md - 数据库规范
-- @.roo/rules/06-service-di.md - 服务与依赖注入规范
-- @.roo/rules/07-openapi.md - OpenAPI规范
-- @.roo/rules/08-rpc.md - RPC调用规范
-- @.roo/rules/09-logging.md - 日志规范
-- @.roo/rules/10-entity.md - 实体定义规范
-- @.roo/rules/11-admin-frontend.md - 管理前端规范
-- @.roo/rules/11-custom-crud.md - 自定义CRUD规范
-- @.roo/rules/11-entity-creation.md - 实体创建规范
-- @.roo/rules/11-home-frontend.md - 首页前端规范
-- @.roo/rules/11-standard-crud.md - 标准CRUD规范
-- @.roo/rules/12-generic-crud.md - 通用CRUD规范
-- @.roo/rules/14-crud-filtering.md - CRUD筛选规范
-- @.roo/rules/15-user-tracking.md - 用户追踪规范
-
-## Claude Code
-- use pnpm
-- 检查类型错误直接用pnpm typecheck检查整个项目,不要单独检查单个文件
-- 数据库在同一容器组的另一个容器中,需要运行 mysql -h 127.0.0.1 -u root 来访问
-- vitest中,只有console.debug会显示,其他的都屏蔽了
-- vitest中,用import 来配合 vi.mocked,而不是require
-- e2e测试平常只运行 pnpm test:e2e:chromium 就行
-- e2e测试失败时先查看页面结构 test-results/**/error-context.md
-- 前端是 hono/client  hc  rpc 的,不是直接fetch
-- bmad-core dir is in .bmad-core
-- 必须用中文回答
+## 项目文档架构
+
+本项目已按照BMAD架构规范重新组织文档结构。所有开发规范、技术栈和架构文档已迁移到 `docs/architecture/` 目录中。
+
+### 主要架构文档
+- **主架构文档**: `docs/architecture.md` - 完整的架构概述和索引
+- **分片架构文档**: `docs/architecture/` - 详细的架构分片文档
+- **开发时始终加载**:
+  - `docs/architecture/coding-standards.md` - 编码标准
+  - `docs/architecture/tech-stack.md` - 技术栈
+  - `docs/architecture/source-tree.md` - 源码树结构
+
+### 开发规范文档
+详细的开发规范已整合到 `docs/architecture/development-standards.md`,包含:
+- 开发环境说明
+- 项目标准和规范(引用 `.roo/rules/` 目录中的规范文件)
+- Claude Code开发工具配置
+
+### 开发工作流
+开发工作流和命令参考 `docs/architecture/development-workflow.md`
+
+## Claude Code特定配置
+
+### 语言要求
+- 必须用中文回答
+
+### 项目结构
+- BMAD核心目录在 `.bmad-core`
+
+### 包管理器
+- 使用 `pnpm` 作为包管理器
+
+### 类型检查
+- 检查类型错误直接用 `pnpm typecheck` 检查整个项目,不要单独检查单个文件
+
+### 数据库访问
+- 数据库在同一容器组的另一个容器中,需要运行 `mysql -h 127.0.0.1 -u root` 来访问
+
+### 测试相关
+- **Vitest配置**: 只有 `console.debug` 会显示,其他的都屏蔽了
+- **Mock导入**: 用 `import` 来配合 `vi.mocked`,而不是 `require`
+- **E2E测试**: 平常只运行 `pnpm test:e2e:chromium` 就行
+- **E2E调试**: 测试失败时先查看页面结构 `test-results/**/error-context.md`
+
+### 前端开发
+- 前端使用 `hono/client` 的 `hc` RPC 调用,不是直接 `fetch`

+ 11 - 0
docs/architecture/coding-standards.md

@@ -5,6 +5,17 @@
 |------|------|------|------|
 | 2.4 | 2025-09-20 | 与主架构文档版本一致 | Winston |
 | 2.5 | 2025-09-24 | 更新技术栈信息,修正数据库类型 | Winston |
+| 2.6 | 2025-09-28 | 添加.roo/rules规范文件引用 | Claude Code |
+
+## 详细开发规范
+
+本项目遵循详细的开发规范,所有规范文件位于 `.roo/rules/` 目录中。详细规范请参考:[开发规范文档](./development-standards.md)
+
+### 主要规范类别
+- **基础规范**: 项目结构、技术栈、模块化组织
+- **API开发规范**: DTO定义、数据库操作、依赖注入
+- **高级开发规范**: OpenAPI、RPC调用、日志管理
+- **实体和CRUD规范**: 实体定义、前端开发、CRUD实现
 
 ## 现有标准合规性
 - **代码风格**: TypeScript严格模式,一致的缩进和命名

+ 70 - 0
docs/architecture/development-standards.md

@@ -0,0 +1,70 @@
+# 开发规范
+
+## 版本信息
+| 版本 | 日期 | 描述 | 作者 |
+|------|------|------|------|
+| 1.0 | 2025-09-28 | 从CLAUDE.md和.roo/rules迁移开发规范 | Claude Code |
+
+## 开发环境说明
+
+### 多八多云端开发容器环境
+- **Node.js版本**: 20.19.2
+- **数据库**: MySQL 8 (默认数据库: d8dai)
+- **缓存**: Redis 7
+- **对象存储**: MinIO (默认存储桶: d8dai)
+- **连接配置**: 所有服务使用默认参数连接,正式环境参数相同
+- **网络访问**: 默认开放8080端口供外网访问
+
+## 项目标准和规范
+
+本项目遵循以下开发规范,所有规范文件位于 `.roo/rules/` 目录中:
+
+### 基础规范
+- [通用开发规范](../.roo/rules/01-general.md) - 项目结构、技术栈、目录组织
+- [TypeScript规范](../.roo/rules/02-typescript.md) - 严格模式、类型检查
+- [模块化规范](../.roo/rules/03-modules.md) - 模块组织原则
+
+### API开发规范
+- [API开发规范](../.roo/rules/04-api.md) - DTO定义、API响应格式
+- [数据库规范](../.roo/rules/05-database.md) - 迁移管理、实体映射
+- [服务与依赖注入规范](../.roo/rules/06-service-di.md) - 依赖注入原则
+
+### 高级开发规范
+- [OpenAPI规范](../.roo/rules/07-openapi.md) - Hono OpenAPI集成规范
+- [RPC调用规范](../.roo/rules/08-rpc.md) - 类型安全RPC调用
+- [日志规范](../.roo/rules/09-logging.md) - 前后端统一日志管理
+
+### 实体和CRUD规范
+- [实体定义规范](../.roo/rules/10-entity.md) - 数据库实体规范
+- [管理前端规范](../.roo/rules/11-admin-frontend.md) - 管理后台页面开发
+- [自定义CRUD规范](../.roo/rules/11-custom-crud.md) - 复杂业务逻辑CRUD
+- [实体创建规范](../.roo/rules/11-entity-creation.md) - 新实体创建流程
+- [首页前端规范](../.roo/rules/11-home-frontend.md) - 前台页面开发
+- [标准CRUD规范](../.roo/rules/11-standard-crud.md) - 简单数据模型CRUD
+- [通用CRUD规范](../.roo/rules/12-generic-crud.md) - 通用CRUD实现
+- [CRUD筛选规范](../.roo/rules/14-crud-filtering.md) - 增强筛选功能
+- [用户追踪规范](../.roo/rules/15-user-tracking.md) - 操作人ID字段配置
+
+## Claude Code开发工具配置
+
+### 包管理器
+- 使用 `pnpm` 作为包管理器
+
+### 类型检查
+- 检查类型错误直接用 `pnpm typecheck` 检查整个项目,不要单独检查单个文件
+
+### 数据库访问
+- 数据库在同一容器组的另一个容器中,需要运行 `mysql -h 127.0.0.1 -u root` 来访问
+
+### 测试相关
+- **Vitest配置**: 只有 `console.debug` 会显示,其他的都屏蔽了
+- **Mock导入**: 用 `import` 来配合 `vi.mocked`,而不是 `require`
+- **E2E测试**: 平常只运行 `pnpm test:e2e:chromium` 就行
+- **E2E调试**: 测试失败时先查看页面结构 `test-results/**/error-context.md`
+
+### 前端开发
+- 前端使用 `hono/client` 的 `hc` RPC 调用,不是直接 `fetch`
+
+### 项目结构
+- BMAD核心目录在 `.bmad-core`
+- 必须用中文回答

+ 25 - 0
docs/architecture/development-workflow.md

@@ -5,6 +5,31 @@
 |------|------|------|------|
 | 2.4 | 2025-09-20 | 与主架构文档版本一致 | Winston |
 | 2.5 | 2025-09-24 | 更新技术栈信息,修正数据库类型 | Winston |
+| 2.6 | 2025-09-28 | 整合Claude Code开发工具配置 | Claude Code |
+
+## Claude Code开发工具配置
+
+### 包管理器
+- 使用 `pnpm` 作为包管理器
+
+### 类型检查
+- 检查类型错误直接用 `pnpm typecheck` 检查整个项目,不要单独检查单个文件
+
+### 数据库访问
+- 数据库在同一容器组的另一个容器中,需要运行 `mysql -h 127.0.0.1 -u root` 来访问
+
+### 测试相关
+- **Vitest配置**: 只有 `console.debug` 会显示,其他的都屏蔽了
+- **Mock导入**: 用 `import` 来配合 `vi.mocked`,而不是 `require`
+- **E2E测试**: 平常只运行 `pnpm test:e2e:chromium` 就行
+- **E2E调试**: 测试失败时先查看页面结构 `test-results/**/error-context.md`
+
+### 前端开发
+- 前端使用 `hono/client` 的 `hc` RPC 调用,不是直接 `fetch`
+
+### 项目结构
+- BMAD核心目录在 `.bmad-core`
+- 必须用中文回答
 
 ## 实际开发命令
 ```bash

+ 5 - 0
docs/architecture/index.md

@@ -39,10 +39,15 @@
   - [开发工作流](./development-workflow.md)
     - [实际开发命令](./development-workflow.md#实际开发命令)
     - [环境配置](./development-workflow.md#环境配置)
+    - [Claude Code开发工具配置](./development-workflow.md#claude-code开发工具配置)
   - [编码标准和测试策略](./coding-standards.md)
+    - [详细开发规范](./coding-standards.md#详细开发规范)
     - [现有标准合规性](./coding-standards.md#现有标准合规性)
     - [增强特定标准](./coding-standards.md#增强特定标准)
     - [关键集成规则](./coding-standards.md#关键集成规则)
+  - [开发规范](./development-standards.md)
+    - [开发环境说明](./development-standards.md#开发环境说明)
+    - [项目标准和规范](./development-standards.md#项目标准和规范)
   - [安全集成](./security-integration.md)
     - [现有安全措施](./security-integration.md#现有安全措施)
     - [增强安全要求](./security-integration.md#增强安全要求)

+ 6 - 1
vite.config.ts

@@ -17,7 +17,12 @@ export default defineConfig({
     })
   ],
   server: {
-    allowedHosts:true
+    allowedHosts:true,
+    watch:{
+      ignored:[
+        'docs'
+      ]
+    }
   },
   // 配置 @ 别名
   resolve: {