目录一、前言二、Cursor 介绍2.1 Cursor 是什么2.2 Cursor 核心特性2.3 Cursor与传统IDE区别2.4 Cursor与传统IDE核心差异总结2.5 Cursor 规则介绍2.4.1 什么是 Cursor Rules2.4.2 Cursor 规则文件作用2.4.3 Cursor Rules 分级与存放位置三、Cursor 规则配置与使用3.1 Cursor 用户规则介绍与使用3.1.1 什么是用户 Rule规则3.1.2 用户 Rule与项目Rule 比较3.1.3 用户 Rule创建与使用3.2 Cursor mdc 格式语法3.2.1 什么是mdc文件格式3.2.2 mdc 文件结构与规范3.3 Cursor 项目规则配置与使用3.3.1 Cursor 规则文件创建方式3.3.2 Cursor 规则文件编写规范3.3.3 创建规则文件3.3.4 规则应用3.3.5 规则文件使用示例3.3.6 规则文件如何编写3.3.7 Cursor 规则使用技巧补充3.3.8 Cursor 进阶规则使用技巧3.3.9 最佳实践建议四、写在文末一、前言在过去的很长一段时间里Cursor 被誉为最全能的 AI 工具它不仅是一个编程 Agent更是一个几乎可以替换掉任何对话工具的全能 AI。Cursor 的出现让很多软件工程师大开眼界从而打开了一扇从传统编程进入到AI编程的新时代可以说只要你能想到的场景Cursor 都能帮你自动化完成。借助Cursor 不仅可以大大提升编程效率而且对着技术的发展Cursor 的功能也越来越完善不仅可以做AI编程在更多的领域都展示出了强大的能力本篇将详细介绍Cursor 中自定义规则的配置与使用。二、Cursor 介绍2.1 Cursor 是什么Cursor是一个类VSCode的智能编程IDE集成了GPT-4、Claude3.5等先进大语言模型(LLM)本质上是一个内置AI助手的VSCode。它不仅支持自然语言编程还提供从代码编写、调试、重构到部署的智能辅助。你可以像和人交流一样与AI协作大幅提升开发效率和代码质量。官网https://cursor.com/2.2 Cursor 核心特性Cursor 主要包括如下核心特点AI原生设计:从底层架构就融入了AI能力而非后期添加的插件智能代码生成:通过自然语言描述快速生成代码片段上下文感知:深度理解项目结构和代码关系实时协助:在编程过程中提供即时的建议和优化多模型支持:集成了多种先进的大语言模型2.3 Cursor与传统IDE区别Cursor与传统IDE主要有下面的区别功能特性传统IDECursor代码补全基于语法分析和已有代码的静态补全AI驱动的智能补全理解上下文和意图代码生成依靠预设模板和代码片段通过自然语言描述生成完整代码逻辑问题解决需要手动查找文档、Stack Overflow等内置AI助手即时解答编程问题代码理解提供语法高亮和基础结构分析深度理解代码逻辑提供详细解释重构优化手动操作依赖开发者经验AI智能分析并建议最佳重构方案学习支持需要外部资料和文档内置技术知识实时学习辅导错误处理显示编译错误和基础语法检查预测潜在问题提供修复建议和解释2.4 Cursor与传统IDE核心差异总结与传统的IDE相比具有如下的核心差异对比维度传统IDECursor交互方式基于菜单、快捷键的工具操作自然语言对话传统操作学习曲线需要记忆大量快捷键和功能位置通过对话快速上手降低学习门槛开发效率依赖开发者经验和熟练度AI辅助显著提升编码速度代码质量主要依靠开发者技能水平AI持续提供最佳实践建议知识获取需要主动搜索和学习被动接收AI推荐和解释问题诊断基于错误信息手动排查AI分析问题根源并提供解决方案创新能力受限于开发者知识范围AI提供多样化解决思路适用人群需要一定编程基础适合各个水平的开发者2.5 Cursor 规则介绍2.4.1 什么是 Cursor RulesCursor Rules中文翻译过来是 Cursor 规则。就是给Cursor制定一系列规则约束AI生成的代码。Cursor 的规则系统是让 AI 按照你的技术栈、代码规范和项目架构来生成代码的关键。通过配置.cursor/rules/*.mdc文件你可以告诉 AI 你是谁、项目用什么技术以及代码该怎么写当一条规则被触发后规则中的内容会被附加到提示词中为 AI 提供参考无论是在自动补全、 代码生成、重构还是错误修复时都能遵循这些规范2.4.2 Cursor 规则文件作用规则文件具有下面的作用指明项目所使用的技术栈Vue 3, Element Plus, Pinia, TypeScript, Vite明确项目约定组件/文件命名、CSS 命名、导入顺序避免误判减少 Cursor 提供的错误补全或重复实现已有功能提升智能度帮助 AI 生成符合项目风格、结构规范、命名约定的代2.4.3 Cursor Rules 分级与存放位置之前接触过Claude Code 的同学应该不陌生Claude Code中的规则配置分全局和项目级别在 Cursor 当中也不例外它支持两种级别的规则全局规则User Rules针对所有项目通用的规则项目规则Project Rules存放于项目目录下的 .cursor/rules 中只用于约束当前项目规则文件放在项目根目录下的.cursor/rules/文件夹中使用.mdc格式your-project/ ├── .cursor/ │ └── rules/ │ ├── typescript.mdc # TypeScript 规范 │ ├── components.mdc # 组件规范 │ └── api.mdc # API 规范 ├── src/ └── ...⚠️ 注意旧的.cursorrules单文件方式已不再推荐新项目请使用.cursor/rules/多文件方式。对上面的规则文件目录位置做一些补充说明 路径固定必须为 .cursor/rules/ 扩展名固定必须为 .mdc✅文件可以有多个每个规则建议单独拆分主题编写如 unocss-guidelines.mdc, project-structure.mdc, naming-conventions.mdc 等三、Cursor 规则配置与使用从大的方面划分Cursor 规则可以划分为用户规则和项目规则下面分别通过实际操作做详细介绍。3.1 Cursor 用户规则介绍与使用3.1.1 什么是用户 Rule规则用户 Rule 是一组配置规则用于定义系统在执行任务或操作时的行为约束特别是在 AI 编程、自动化任务、操作代理Agent执行环境等场景中用于控制哪些操作允许、哪些禁止、如何处理异常等。用户规则是全局的不受项目规则配置的限制即用户规则在所有项目中生效3.1.2 用户 Rule与项目Rule 比较Cursor 用户 Rule与项目Rule 的对比差异如下类型作用范围存储位置适用场景User Rules全局规则所有项目生效Cursor Settings → Rules个人编码偏好如始终用中文回复、偏好函数式编程Project Rules项目规则仅当前项目.cursor/rules/目录团队统一规范如必须使用 Vue 3 Composition API、API 请求统一放在src/api下 版本提示早期版本使用根目录下的.cursorrules单文件。新版本v0.12推荐使用.cursor/rules/目录下的.mdc文件支持多规则拆分和更精细的控制。3.1.3 用户 Rule创建与使用在Cursor 中配置用户规则在设置那里如下图展示了3个不同规则的TAB页用户规则就在User那里如果你需要新增规则点击New在下面新增的输入框中输入你要编写的用户规则比如我在这里需要新增下面的规则3.2 Cursor mdc 格式语法想必使用过Claude Code 或者 codex 的同学应该还有印象在这两种AI编程模型中他们都有自己的项目规则文件不过他们统一都是.md格式文件即markdown格式的但是在Cursor 中采用了叫 mdc结尾的格式文件虽然后缀不太一样但是整体用法是相似的为了后续深入学习和了解Cursor规则有必要了解一下mdc 的语法格式使用。3.2.1 什么是mdc文件格式.mdcMarkdown with Configuration是一种扩展的 Markdown 文件格式专为 Cursor等智能开发工具设计用于编写规则、配置、教学任务等内容。它结合了 Markdown 的可读性与结构化的前置元数据Frontmatter使得开发者可以在统一语法中定义文件适用范围启用方式自动、手动配套文件引用规则说明、注释、命令等3.2.2 mdc 文件结构与规范每个 .mdc 文件由两部分组成前置元数据Frontmatter用三横线---包裹定义规则的描述和适用范围。规则正文使用Markdown格式编写具体指令1前置元数据Frontmatter使用三横线 --- 包裹采用 YAML 格式主要用于声明规则的元信息。常见字段如下字段说明description对规则的简要描述便于用户理解该规则的意图。globs规则应用的文件匹配范围支持通配符。例如src/**/*.tsx。alwaysApply是否始终自动应用规则。true 表示无需用户确认自动生效。applyMode可选控制应用方式如 intelligent, manual, specificFiles。--- description: 在 React 项目中使用 TypeScript 和 Tailwind CSS globs: - src/**/*.tsx alwaysApply: true ---2正文Markdown格式正文使用标准 Markdown 编写可以包含标题、列表、代码块、注释、引用文件等。是实际执行规则或说明内容的主体。常用语法支持标题用于结构化说明列表项用于列出规范细则file表示要引用的外部文件路径command表示要执行的指令例如用于脚手架如下给出一个比较完整的示例--- description: 在 React 项目中使用 TypeScript 和 Tailwind CSS globs: - src/**/*.tsx alwaysApply: true --- # 项目基础说明 - 本项目基于 Vue 3 TypeScript Element Plus Pinia Vite 搭建。 - 采用组合式 APIscript setup langts进行开发。 - 状态管理使用 Pinia模块化组织。 - 路由使用 Vue Router采用权限动态路由配置。 - 接口请求统一封装在 /utils/request.ts 中使用 Axios。 - 表格、表单页面基于 Element Plus 封装通用组件提高复用性。 # 组件和文件命名规范 - 组件文件名使用 PascalCase 格式例如UserTable.vue, LoginForm.vue - 公共组件放置在 src/components/ 下业务组件可放在 src/views/模块/components/ 中 - 文件夹名和非组件 .ts/.scss 文件使用 kebab-case 格式例如user-api.ts, login form.scss - 页面文件命名与路由保持一致使用 kebab-case例如user-list.vue, role-edit.vue # 样式和 CSS 使用约定 - **优先使用原子类** 使用 UnoCSS 提供的原子类进行布局和样式例如常见的 flex 布局flex justify-center items-center 等。样式语义明确便于维护。 - **常用组合提取为全局快捷方式** 对于**频繁使用**的原子类组合应在 unocss.config.ts 中 通过 shortcuts 定义全局组合类。例如将 flex justify-center items-center 定义为 flex-center这样可以在整个项目中复用。组合类命名应简洁且语义化反映布局或功能意图。 - **非常用组合使用局部类** 对于特定组件中使用但不常见的、超过3个的原子类组合应该在组件内使 用局部CSS类使用style scoped块避免过多的全局组合污染全局命名空间。 - **避免重复代码** 不论是通过全局shortcuts还是局部CSS类都应避免在多个地方重复编写相同 的原子类列表保持代码 DRYDont Repeat Yourself原则。 - **样式优先级** 优先考虑 UnoCSS 解决方案原子类或组合类其次才是传统 CSS。当需要使用传 统 CSS 时遵循 BEM 命名规范即 block__element--modifier 格式。 # 导入顺序规范保持统一结构 1. Vue 相关 API如 ref, computed, onMounted 2. 第三方库如 element-plus, axios 3. 工具函数如 /utils/* 4. 状态管理如 /store/* 5. 项目内部组件、模块如 /components, /views 6. 样式文件 # 开发注意事项 - 使用 TypeScript避免使用 any - 组件职责单一保持结构清晰 - 所有组件必须使用组合式 API - 适当添加注释提升 AI 理解。3.3 Cursor 项目规则配置与使用3.3.1 Cursor 规则文件创建方式Cursor 有两种主要创建规则的方式使用命令推荐直接在 Cursor 的聊天框中输入/create-rule然后描述你的需求AI 会帮你生成规则文件并保存到正确位置。手动创建在项目根目录下创建.cursor/rules文件夹并在其中新建.mdc文件按照上述格式编写即可。3.3.2 Cursor 规则文件编写规范为了让 AI 更好地理解和执行编写规则内容时有几个技巧1明确角色与约束像给新人布置任务一样清晰地说明要求和“禁区”。例如一个 Vue 3 项目的规则可以这样写--- globs: **/*.vue alwaysApply: false --- # 角色 你是一名精通 Vue 3 的高级前端工程师。 # 【权重最高】禁止事项 - 严格禁止使用 Options API必须使用 Composition API 和 script setup 语法。 - 禁止使用 var 关键字变量声明统一使用 const 或 let。 - 禁止在 template 中编写复杂逻辑应使用 computed。 # 推荐做法 - 组件命名使用 PascalCaseProps 命名使用 camelCase。 - 对于复杂类型优先使用 TypeScript 的 interface 而非 type。2提供示例模板直接给 AI 一个代码模板比用文字描述“组件应该怎么组织”高效得多## Vue 组件模板 请严格按照以下结构组织代码 vue script setup langts // 1. Props 定义 interface Props { title: string } const props definePropsProps() // 2. Emits 定义 const emit defineEmits{ close: [] }() // 3. 响应式状态与计算属性 const isActive ref(false) // 4. 方法 /script template !-- 模板内容 -- /template这种方法能确保 AI 生成的代码结构一致性大幅提升3最佳实践技巧推荐规则宜精不宜多保持每条规则清晰、聚焦。如果规则超过500行考虑将其拆分为多个更具体的规则文件。善用.cursorignore可以创建一个.cursorignore文件让 AI 忽略node_modules、dist等构建目录避免不必要的信息干扰。把设计文档放进.cursor/将项目架构图、技术方案等文档放在.cursor/文件夹下AI 在生成代码时可以主动引用这些内容更好地理解项目全局。团队共享规则将.cursor/rules目录提交到 Git 仓库整个团队就能共享一套统一的 AI 开发规范。企业版用户还可以在后台设置强制生效的团队规则。3.3.3 创建规则文件可以手动创建规则文件也可以通过内置的命令创建手动创建方式如下说明文件名可自定义扩展名必须为 .mdc# 第一步创建规则文件的目录 mkdir -p .cursor/rules #创建规则文件 touch .cursor/rules/project-guidelines.mdc如果是自动创建打开Cursor 的编辑器Chat窗口输入 / 并选择弹出的 Generate Cursor Rules 选项即可自动生成 .cursor/rules/ 目录及默认的规则文件我们用第二种方式来尝试一下按照上一步选中了 / create-rule 之后在后面输入下面的提示词经过一会儿的等待后Cursor 读懂了我制定模块的项目为我生成了项目介绍文档并且是mdc格式的3.3.4 规则应用规则文件创建出来后进入规则文件可以看到上面有个下拉框提供了几个选项这几个选项的含义如下Always始终应用规则想始终生效Auto Attached当匹配 globs 模式的文件被引用时自动附加规则想自动触发用Agent Requested根据 AI 代理的判断决定是否应用规则需要提供规则说明想让 AI 自己决定是否用Manual仅在提示中显式使用 规则名 时附加规则。想手动调用规则3.3.5 规则文件使用示例首先让Cursor 读懂项目之后生成一个API 设计规则然后基于这个规则编写接口给出如下提示词读懂 gh-pda 模块的项目开发规范然后生成一个API 接口设计规范后续我就与你共同持续完善这个接口设计文档最后Cursor 为我们生成了我指定模块的api接口设计规范实际使用时还需要人工进行二次校对、完善这个文档打开这份文档后我选择了手动引用然后在对话框那里可以看到已经可以看到上述创建成功的文件了接下来基于创建的API设计规则文件让Cursor 生成接口补充说明通过自然语言提示词让Cursor 生成规则的方式更多适合于那种工程结构比较规范的场景Cursor在生成规则文件时会自动理解项目然后生成符合项目要求的规则生成出来的规则文件还需要人工做二次校对比如调整其中有语法错误的内容有明显逻辑漏洞的内容甚至不符合要求的内容同时再根据实际要求补充一些Cursor 没有想到的而全新的项目则可以借助其他比较成熟完善的配置规则然后在此基础上做一些调整适配即可使用规则文件有多种可以分目录存放比如有项目描述规则文件API接口设计规范文件组件使用规则SQL编写规范等访问 cursor.directory上面有大量针对不同技术栈React、Vue、Python、Rust等的现成规则复制下来稍作修改即可使用。3.3.6 规则文件如何编写在上述案例操作中演示了项目规则文件如何从0到1创建出来事实上如果你的项目已经比较成熟稳定上面这种方式是最快捷的如果你的项目还在规划、设计和成型中可以手动编写可以先制定API接口设计规范后续再进行丰富完善即可而规则文件内部的内容网上有很多资料首先文档格式必须为.mdc 结尾本质就是Markdown 文档但具有特殊结构。以下以开源项目 vue3-element-admin 为例给出适用于 Vue 3 TypeScript 项目的推荐规则模板写法可做参考# 项目基础说明 - 本项目基于 Vue 3 TypeScript Element Plus Pinia Vite 搭建。 - 采用组合式 APIscript setup langts进行开发。 - 状态管理使用 Pinia模块化组织。 - 路由使用 Vue Router采用权限动态路由配置。 - 接口请求统一封装在 /utils/request.ts 中使用 Axios。 - 表格、表单页面基于 Element Plus 封装通用组件提高复用性。 # 组件和文件命名规范 - 组件文件名使用 PascalCase 格式例如UserTable.vue, LoginForm.vue - 公共组件放置在 src/components/ 下业务组件可放在 src/views/模块/components/ 中 - 文件夹名和非组件 .ts/.scss 文件使用 kebab-case 格式例如user-api.ts, login form.scss - 页面文件命名与路由保持一致使用 kebab-case例如user-list.vue, role-edit.vue # 样式和 CSS 使用约定 - **优先使用原子类** 使用 UnoCSS 提供的原子类进行布局和样式例如常见的 flex 布局flex justify-center items-center 等。样式语义明确便于维护。 - **常用组合提取为全局快捷方式** 对于**频繁使用**的原子类组合应在 unocss.config.ts 中 通过 shortcuts 定义全局组合类。例如将 flex justify-center items-center 定义为 flex-center这样可以在整个项目中复用。组合类命名应简洁且语义化反映布局或功能意图。 - **非常用组合使用局部类** 对于特定组件中使用但不常见的、超过3个的原子类组合应该在组件内使 用局部CSS类使用style scoped块避免过多的全局组合污染全局命名空间。 - **避免重复代码** 不论是通过全局shortcuts还是局部CSS类都应避免在多个地方重复编写相同 的原子类列表保持代码 DRYDont Repeat Yourself原则。 - **样式优先级** 优先考虑 UnoCSS 解决方案原子类或组合类其次才是传统 CSS。当需要使用传 统 CSS 时遵循 BEM 命名规范即 block__element--modifier 格式。 # 导入顺序规范保持统一结构 1. Vue 相关 API如 ref, computed, onMounted 2. 第三方库如 element-plus, axios 3. 工具函数如 /utils/* 4. 状态管理如 /store/* 5. 项目内部组件、模块如 /components, /views 6. 样式文件 # 开发注意事项 - 使用 TypeScript避免使用 any - 组件职责单一保持结构清晰 - 所有组件必须使用组合式 API - 适当添加注释提升 AI 理解。3.3.7 Cursor 规则使用技巧补充下面再结合实际经验补充一些常用的使用技巧拆分规则主题 可以为不同模块分别写规则比如 style-guidelines.mdc、project-structure.mdc、component-conventions.mdc让 AI 更易查阅上下文越具体越好 你越明确规则Cursor 越能准确给出符合你期望的代码。避免废话和废规则 Focuson 可执行、可操作、可验证的规则。比如“命名要清晰”不如“类名采用 BEM 规范并用小写字母连接” 具体有效随项目迭代更新规则 规则应当与代码保持同步更新特别是引入新的库、工具、编码风格变更时3.3.8 Cursor 进阶规则使用技巧对于复杂项目建议采用三层结构职责分离下面给出一个示例参考规范配置结构.cursor/rules/ ├── ai.mdc # AI 协作总纲定义执行流程 ├── basic/ # 基础规范层 │ ├── typescript.mdc │ ├── code-quality.mdc │ └── naming.mdc ├── modules/ # 模块规范层 │ ├── components.mdc │ ├── service.mdc │ └── hooks.mdc └── workflow/ # 流程规范层 ├── curd-page.mdc └── log.mdc3.3.9 最佳实践建议下面结合实践中的操作给出一些最佳实践建议实践规则说明从小开始发现问题再添加规则不要提前写一堆每条规则 500 行避免占用过多 context token使用 glob 限定范围组件规则只在.tsx文件中生效节省 token提交到 Git团队共享规则保持一致定期审查删除过时或冗余的规则四、写在文末本文通过较大的篇幅详细介绍了Curosr 中自定义配置规则的使用并通过项目实际操作演示了具体的用法希望对看到的同学有帮助本篇到此结束感谢观看。