.cursorrules 是cursor提供的一种特殊的配置文件,它允许开发者通过简单的文本指令来定制和控制AI助手的行为。这个文件通常放置在项目根目录,对整个项目生效,也可以放在子目录中对特定的模块生效。其他的IDE也有类似的功能,例如trea,使用的是markdown文件,放置在 .trea/rules 下,可以在 设置>>规则中配置 。详情可以看 trea的官方文档

项目规则存放处

1
2
3
4
5
6
项目根目录/
┝ .cursorrules # 全局规则文件
┝ src/
| ┝ .cursorrules # 仅对src目录生效的规则
| ┝ components/
┝ ...

传统AI编程助手存在的主要问题

  • 上下文理解有限:不了解项目特定的架构和规范
  • 知识边界模糊:对业务领域只是缺乏理解
  • 行为不一致:不同开发者得到不同风格的代码
  • 质量难保证:生成的代码可能不符合团队的标准

.cursorrules文件解决这些问题

  • 项目只是注入:让 AI 理解项目架构和业务领域

  • 行为标准化:确保所有团队成员获得一致的 AI 响应

  • 质量保障:强制执行代码规范和最佳实践

  • 效率提升:减少重复指导 AI 的时间成本

规则文件的基本结构

  1. 角色定义

    你是一名专注于React前端开发的资深工程师,擅长组建设计和性能优化。

    你熟悉本项目的架构和代码规范,会严格按照项目要求提供建议。

  2. 知识注入

    本项目采用Clean Architecture架构,分为以下层次

    1. Presentation Layer:React组建和Hooks
    2. Domain Layer:业务逻辑和实体模型
    3. Data Layer:API调用和数据处理
  3. 行为规则

    • 所有组件必须使用函数式组件
    • 使用typescript类型定义
    • 状态管理有限使用React Context和Hooks
    • 样式采用Css Modules方案
  4. 响应格式

    回答问题时,请遵循以下结构

    1. 简要总结问题
    2. 提供解决方案
    3. 解释实现原理
    4. 给出完整代码示例