Cursor Rules 概念、编写与接入指南

Cursor Rules 概念、编写与接入指南第一步Rules 是什么一句话定义Rules规则是放在项目中的简短约束文件让 Cursor AI 在编码时始终遵守你团队的标准和惯例。类比理解把 Rules 想象成交通规则没有交通规则时每个司机凭自己的判断开车混乱且危险有了交通规则后所有人遵循统一标准高效有序Rules 就是给 AI 定的交通规则——简短、明确、始终执行。Rules vs Skills vs MCP 对比┌────────────┬──────────────────────┬──────────────────────┐ │ │ 触发方式 │ 典型用途 │ ├────────────┼──────────────────────┼──────────────────────┤ │ Rules │ 始终生效 / 按文件匹配 │ 编码标准、命名约定 │ │ Skills │ AI 按场景自动加载 │ 代码审查、报告生成 │ │ MCP │ AI 按需调用 │ 查询数据库、调用API │ └────────────┴──────────────────────┴──────────────────────┘核心特点简短精炼建议 50 行一个规则文件只关注一个关切点可以全局生效也可以只对特定文件类型生效第二步Rules 编写流程2.1 文件格式规则文件是.mdc后缀的 Markdown 文件由YAML 头部正文组成。2.2 两种模式模式一始终生效适用于全项目通用的编码标准--- description: 项目核心编码标准 alwaysApply: true --- # 编码标准 - 使用 TypeScript strict 模式 - 禁止使用 any 类型 - 函数最大行数不超过 50 行 - 必须处理所有错误禁止空 catch模式二按文件类型生效适用于特定文件的专属规则--- description: Vue 组件开发规范 globs: **/*.vue alwaysApply: false --- # Vue 组件规范 - 使用 Composition API setup 语法糖 - Props 必须定义类型 - 组件名使用 PascalCase - 事件名使用 camelCase2.3 头部字段说明字段类型作用descriptionstring规则的简要描述显示在规则选择器中globsstring文件匹配模式如**/*.ts、src/**/*.vuealwaysApplyboolean设为true则每次对话都生效2.4 编写关键原则一个文件一个关切点不要把错误处理和命名规范混在一起控制在 50 行以内简短才能保证 AI 始终执行提供正反例用 “BAD / GOOD” 对比让 AI 一目了然可操作写法像清晰的内部文档不是抽象的设计理念正反例最佳实践--- description: 错误处理规范 globs: **/*.ts alwaysApply: false --- # 错误处理 \\\typescript // BAD try { await fetchData(); } catch (e) {} // GOOD try { await fetchData(); } catch (e) { logger.error(Failed to fetch, { error: e }); throw new DataFetchError(Unable to retrieve data, { cause: e }); } \\\第三步接入方式3.1 存放位置规则文件统一放在项目根目录下的.cursor/rules/中your-project/ └── .cursor/ └── rules/ ├── coding-standards.mdc # 通用编码标准alwaysApply: true ├── typescript-conventions.mdc # TS 专属globs: **/*.ts ├── vue-patterns.mdc # Vue 专属globs: **/*.vue └── api-conventions.mdc # API 专属globs: src/api/**/*.ts不需要额外的配置文件放到目录里即可自动识别。3.2 globs 常用模式模式匹配范围**/*.ts所有 TypeScript 文件**/*.vue所有 Vue 组件src/api/**/*.tssrc/api 目录下所有 TS 文件**/*.test.ts所有测试文件*.md根目录的 Markdown 文件3.3 接入后的效果Cursor 自动扫描.cursor/rules/目录alwaysApply: true的规则在每次对话中都生效有globs的规则在打开匹配文件时自动生效AI 生成的代码会自动遵守这些规则总结维度核心要点概念Rules AI 的交通规则简短的编码约束始终或按文件类型执行编写创建.mdc文件配好 description globs/alwaysApply 头部正文 50 行接入放到.cursor/rules/目录下即可自动生效随仓库共享给团队