# Cursor Rules 迁移总结 ## ✅ 完成的改进 根据 [Cursor 官方文档](https://cursor.com/cn/docs/context/rules) 的最佳实践,已将项目规则系统现代化。 ### 1. 规则拆分 ✨ 原来的 283 行单一文件 `.cursorrules` 已拆分为 **8 个模块化规则**: #### 主规则(`.cursor/rules/`) | 规则文件 | 类型 | 大小 | 说明 | |---------|------|------|------| | `project-overview.mdc` | Always Apply | ~50 行 | 项目概述和技术栈 | | `multi-tenant.mdc` | Always Apply | ~100 行 | ⚠️ 多租户隔离规范(核心安全) | | `backend-architecture.mdc` | Apply to Files | ~200 行 | NestJS 后端架构规范 | | `frontend-architecture.mdc` | Apply to Files | ~250 行 | Vue 3 前端架构规范 | | `database-design.mdc` | Apply to Files | ~200 行 | Prisma 数据库设计规范 | | `code-review-checklist.mdc` | Manual | ~150 行 | 代码审查清单 | #### 嵌套规则 | 规则文件 | 作用域 | 说明 | |---------|--------|------| | `backend/.cursor/rules/backend-specific.mdc` | backend/ | 后端特定规范和脚本 | | `frontend/.cursor/rules/frontend-specific.mdc` | frontend/ | 前端特定规范和组件 | ### 2. 使用 MDC 格式 📝 所有规则文件使用标准 MDC 格式,支持元数据: ```md --- description: 规则描述 globs: - "backend/**/*.ts" alwaysApply: false --- # 规则内容... ``` ### 3. 智能应用策略 🎯 - **Always Apply**: 关键规则(项目概述、多租户)始终生效 - **File Matching**: 后端/前端规则仅在相关文件时应用 - **Nested Rules**: 子目录规则只在该目录下生效 - **Manual**: 代码审查清单按需引用 `@code-review-checklist` ### 4. 创建 AGENTS.md 🚀 添加了简化版快速参考文件: - 纯 Markdown 格式,无元数据 - 包含最重要的规则和快速参考 - 易于阅读和分享 ### 5. 完整文档 📚 创建了详细的使用指南 `.cursor/RULES_README.md`: - 规则文件结构说明 - 使用方式指导 - 迁移指南 - 最佳实践 ## 📊 改进效果 ### 性能优化 - ✅ 每个规则 < 500 行(符合最佳实践) - ✅ 按需加载,减少不必要的上下文 - ✅ 嵌套规则提高针对性 ### 可维护性 - ✅ 模块化设计,易于更新单个规则 - ✅ 版本控制友好 - ✅ 清晰的职责分离 ### 可扩展性 - ✅ 轻松添加新规则 - ✅ 支持子目录特定规则 - ✅ 规则可以引用其他文件 ## 🎯 使用建议 ### 日常开发 ```bash # 开发时规则自动生效 # 不需要手动操作 # 需要代码审查时 在 Chat 中输入:@code-review-checklist ``` ### 添加新规则 ```bash # 方法 1: 使用命令 Cmd/Ctrl + Shift + P → "New Cursor Rule" # 方法 2: 手动创建 # 在 .cursor/rules/ 创建新的 .mdc 文件 ``` ### 查看规则状态 ```bash # 打开 Cursor Settings Cmd/Ctrl + , # 进入 Rules 选项卡 查看所有规则的状态和类型 ``` ## ⚠️ 重要变更 ### 1. 旧文件状态 - `.cursorrules` 已标记为 DEPRECATED - 文件保留作为备份 - 所有功能已迁移到新系统 ### 2. 多租户规则 - 设为 **Always Apply** - 确保所有生成的代码都包含租户隔离检查 - 这是系统安全的核心保障 ### 3. 嵌套规则生效 - 在 `backend/` 目录工作时,后端特定规则自动应用 - 在 `frontend/` 目录工作时,前端特定规则自动应用 ## 📈 下一步 ### 可选的进一步优化 1. **添加模块特定规则** ``` backend/src/contests/.cursor/rules/ └── contests-specific.mdc ``` 2. **创建模板规则** - 控制器模板 - 服务模板 - 组件模板 3. **团队规则(如果有 Team 计划)** - 在 Cursor Dashboard 配置团队级规则 - 强制执行组织标准 ## 🔗 相关资源 - 📖 [规则使用指南](./.cursor/RULES_README.md) - 🚀 [快速参考](../AGENTS.md) - 📚 [Cursor 官方文档](https://cursor.com/cn/docs/context/rules) ## 💬 反馈 如有问题或建议,可以: 1. 更新规则文件并测试 2. 查看官方文档获取最新功能 3. 分享最佳实践给团队 --- **迁移完成时间**: 2025-11-27 **符合标准**: Cursor Rules Best Practices v1.0