类别 | 描述 | 示例 |
项目信息 | 提供项目的基本信息,例如项目名称、描述、版本等。 | # 项目名称:电商平台
# 描述:基于 Next.js 的电商网站,支持多语言和多货币 |
编码规范 | 定义项目的编码风格、命名约定、代码格式等。 | |
技术栈 | 指定项目中使用的主要技术、框架、库等。 | |
开发流程 | 规定项目的开发流程、测试要求、性能优化指南等。 | - 使用 Jest 和 React Testing Library 编写单元测试和集成测试
- 测试覆盖率达到 80% 以上
- 使用 React.memo 对纯组件进行性能优化
- 对列表渲染使用 key 属性 |
错误与文档 | 定义项目的错误处理机制、文档编写规范等。 | - 使用 try...catch 语句捕获和处理异常
- 对异步操作使用 Promise 或 async/await
- 使用 JSDoc 编写函数注释
- 每个组件必须包含 README.md 文件,说明组件的用途和 API |
Cursor Rulers 参考
提供了各种主流语言和框架的.cursorrules
文件模板,你可以直接复制粘贴到你的项目中,或者根据你的需求进行修改。
收集了许多优秀的.cursorrules
文件示例,涵盖了不同的应用场景和技术栈,你可以从中学习和借鉴。