.cursorrules 文件
是 Cursor AI(一款 AI 驱动的代码编辑器)的一个功能,用于定义项目特定的自定义规则。这些规则帮助 AI 根据用户的偏好和项目需求生成更相关、更准确的代码建议。文件通常放置在项目根目录,旨在增强 AI 的上下文感知能力,确保生成的代码符合项目的编码标准和最佳实践。
.cursorrules 设计技巧:
.mdc 文件的格式与结构
Cursor AI 官方文档推荐迁移到新的 Project Rules 系统(存储在 .cursor/rules 目录下),以获得更好的灵活性和控制。
新的 Project Rules 系统使用 .mdc 文件存储在 .cursor/rules 目录下,提供更灵活的路径特定配置。
设计规则时,需创建 .mdc 文件,每个文件包含描述和 glob 模式,内容使用 Markdown 格式。
建议按项目需求组织规则,如前端、后端、测试等,并测试 AI 是否遵循规则。
https://docs.cursor.com/context/rules-for-ai
前置元数据(Frontmatter):
使用 --- 包裹,包含以下字段:
description
:规则的简要描述,例如“前端开发规则”。
globs
:使用 glob 模式指定适用文件或目录,例如 ".ts" 或 "src/components/"。
可选字段:version(版本号,如 1.0.0)、last_updated(最后更新日期,如 2025-03-11)。
示例:
内容部分:
使用 Markdown 格式,建议包括以下部分:
- 标题
:规则的名称,例如“TypeScript 编码标准”。
- 上下文
:解释规则的重要性,例如“TypeScript 提供静态类型检查,提升代码质量”。
- 规则
:具体指令列表,例如“始终使用类型注解”。
- 格式
:格式要求,如“保持一致的缩进”。
- 示例
:代码片段展示规则的应用,例如 TypeScript 函数的类型注解。
- 相关文件
:引用项目文件,如 @file tsconfig.json 或外部文档链接。
- 标题
示例内容:
在 .cursor/rules 目录下创建 .mdc 文件,建议使用命名约定如 NNN_name.mdc(NNN 为 001-299,代表优先级)。
更多资源:
https://github.com/sanjeed5/awesome-cursor-rules-mdc
提供了 879 个 .mdc 文件示例,涵盖多种技术栈(如 React、TypeScript、Python)。这些文件通常遵循上述结构,包含详细的规则和示例。
交流社区:
codenow.wiki
入群可加微信: