3分钟学会Cursor Rules,让AI不再乱改代码!

Cursor Rules创建教程

什么是Cursor Rules?

Cursor Rules本质上是控制AI模型行为的指令,可以理解为”系统级别的Prompt”。它允许开发者为项目编写结构化规则,帮助AI更好地理解项目架构、技术栈、约定和开发习惯。

Cursor Rules的类型

Cursor提供两种设置规则的方式:

  1. 项目级规则(Project Rules):存储在.cursor/rules目录下,适用于特定项目
  2. 全局规则(Global Rules):适用于所有项目,在Cursor设置中配置(Settings > General > Rules for AI)

创建规则文件的方法

方法一:手动创建

  1. 创建规则目录: bashmkdir -p .cursor/rules
  2. 创建规则文件: bashtouch .cursor/rules/project-guidelines.mdc 注意:文件名可自定义,但扩展名必须为.mdc

方法二:使用Cursor快速生成

  1. 在Cursor编辑器中打开Chat窗口
  2. 输入/并选择弹出的Generate Cursor Rules选项
  3. 系统会自动生成.cursor/rules/目录及默认规则文件

方法三:让AI生成规则

  1. 在项目中创建.cursorrules文件
  2. 使用Agent模式生成项目专属规则
  3. 输入”根据项目生成一个规则”,Cursor会根据你的项目生成规则文件

规则文件的结构和格式

规则文件使用MDC(.mdc)格式,支持元数据和内容:

text---
description: 规则描述
globs: [可选的文件匹配模式]
alwaysApply: false
---

- 规则内容1
- 规则内容2

@引用文件路径

规则类型包括:

  • Always:始终包含在模型上下文中
  • Auto Attached:当匹配特定文件模式时包含
  • Agent Requested:AI决定是否包含
  • Manual:仅在使用@ruleName明确提及时包含

规则文件内容建议

一个好的规则文件应包含以下内容:

  1. 项目基础说明:技术栈、框架、API使用方式等
  2. 命名规范:组件命名、文件命名等规则
  3. 样式和CSS使用约定:CSS框架、样式规范等
  4. 导入顺序规范:模块导入的顺序和规则
  5. 开发注意事项:特定的编码要求和注意点

规则文件示例

text---
description: React项目开发规范
globs: ["*.jsx", "*.tsx"]
alwaysApply: true
---

# React开发规范

## 组件命名
- 组件文件名使用PascalCase(如`UserProfile.tsx`)
- 组件名与文件名保持一致
- 函数组件优先使用箭头函数定义

## 样式约定
- 使用styled-components进行样式管理
- 避免内联样式,除非是动态计算的值
- 颜色值使用主题变量,不硬编码

## 导入顺序
1. React相关库
2. 第三方库
3. 自定义组件
4. 工具函数
5. 样式文件

## 状态管理
- 简单组件使用useState和useReducer
- 跨组件状态使用Context API
- 复杂状态管理使用Redux

使用技巧与最佳实践

  1. 拆分规则主题:为不同模块分别写规则,如style-guidelines.mdcproject-structure.mdc
  2. 越具体越好:规则越明确,Cursor生成的代码越符合预期
  3. 避免废话:专注于可执行、可操作、可验证的规则
  4. 随项目迭代更新规则:规则应与代码保持同步更新
  5. 仔细审查模板规则:确保不会引入不需要的技术栈

常见问题解答

如何检查规则是否生效?

可以在Cursor中使用/check-rules命令,查看当前激活的规则。

规则优先级如何?

项目级规则 > 全局规则,如有冲突,以项目级规则为准。

如何在聊天中引用特定规则?

使用@规则名称语法,如@coding-style可以在当前对话中引用该规则。

通过设置合理的Cursor Rules,可以显著提升代码质量、一致性和开发效率,让AI生成的代码更符合项目需求。


© 版权声明
THE END
喜欢就支持一下吧
点赞11 分享
黑帽子的头像- 黑帽星球AI出海
评论 抢沙发

请登录后发表评论

    暂无评论内容