当前位置: 首页 > news >正文

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 - 事件名使用 camelCase

2.3 头部字段说明

字段类型作用
descriptionstring规则的简要描述(显示在规则选择器中)
globsstring文件匹配模式,如**/*.tssrc/**/*.vue
alwaysApplyboolean设为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 接入后的效果

  1. Cursor 自动扫描.cursor/rules/目录
  2. alwaysApply: true的规则在每次对话中都生效
  3. globs的规则在打开匹配文件时自动生效
  4. AI 生成的代码会自动遵守这些规则

总结

维度核心要点
概念Rules = AI 的交通规则,简短的编码约束,始终或按文件类型执行
编写创建.mdc文件,配好 description + globs/alwaysApply 头部,正文 < 50 行
接入放到.cursor/rules/目录下即可自动生效,随仓库共享给团队
http://www.cnnetsun.cn/news/1956922.html

相关文章:

  • 动手学深度学习(二十八)——微调实战:从理论到高效调参
  • 零代码基础:用Retinaface+CurricularFace镜像快速实现人脸相似度计算
  • Qwen3-0.6B-FP8高算力适配:RTX 4090D上FP8推理性能优化教程
  • 用于显示器防眩光面板的板材有哪些尺寸?采购前必须确认这几点
  • 基于logcat日志查找卡顿
  • 万象视界灵坛环境部署:OpenShift平台容器化部署与RBAC权限控制
  • Element-UI表单进阶:精准校验单个与多个字段的实战指南
  • 深入Transformer架构:利用Mirage Flow解析与可视化模型注意力机制
  • C语言存在的问题及Zig语言如何改进,差异对比全在这
  • 6 文件保存功能优化
  • 解读核心Maintainer观点|Presto 不只是版本升级!从查询引擎到湖仓执行层,AI Infra 新方向
  • 解析CSV文件处理中的常见问题与解决方案
  • 为什么你的浏览器下载需要Motrix WebExtension?终极效率提升指南
  • Visual C++运行库终极解决方案:三步告别DLL缺失烦恼
  • 通义千问2.5-7B-Instruct新手入门:无需代码基础搭建智能对话系统
  • S2-Pro大模型VMware虚拟机Ubuntu环境配置一站式指南
  • Wan2.2-I2V-A14B开发者指南:基于API封装私有视频生成SaaS服务
  • Qwen3.5-9B零基础部署:5分钟本地跑通,笔记本也能玩转原生多模态
  • Pixel Epic · Wisdom Terminal 物联网(IoT)后端开发:处理海量传感器数据的智能分析平台
  • 写HTML就能出视频?HyperFrames安装使用教程及资源分享
  • Pixel Couplet Gen惊艳案例:海外华人社区用Pixel Couplet Gen传播春节文化
  • Golang go mod vendor怎么用_Golang vendor教程【必备】
  • Z-Image Turbo实战指南:4步生成高清图像全流程
  • 告别虚拟机黑窗口:VSCode Remote-SSH直连OpenEuler 20.03 LTS开发环境搭建全记录
  • 福瑞康系统APP开发功能实例分析
  • AbMole 丨 FIN56 通过降解 GPX4 与调控 CoQ10 诱导铁死亡
  • 谁有GdiView工具呀
  • 共探智能医疗与人工智能的新时代 | IHAI 2026
  • 不锈钢彩涂板哪家信誉好
  • 告别printf调试:用NRF52832的UART串口实现高效日志输出(附SDK15.3配置)