1. 项目概述一个为 Cursor 编辑器量身定制的规则集合如果你和我一样日常重度依赖 Cursor 这款 AI 驱动的代码编辑器那你一定对它的.cursorrules文件又爱又恨。爱的是它能通过一套精妙的规则精准地“调教”AI 助手让它生成更符合你团队规范、项目风格或个人习惯的代码恨的是从零开始编写一套高效、全面的规则既考验对 Cursor 规则引擎的理解又需要大量的实践和试错过程相当磨人。kszongic/cursor-rules-collection这个项目就是来解决这个痛点的。它不是一个简单的规则示例而是一个经过精心设计、分类和实战检验的.cursorrules规则集合库。你可以把它理解为一个为 Cursor 编辑器准备的“规则模版库”或“最佳实践集”。它的核心价值在于将散落在各个角落的规则编写经验系统化地整理出来让开发者无论是个人还是团队都能快速上手直接复用或在其基础上进行微调从而极大提升使用 Cursor 进行 AI 编程的效率和代码质量。这个项目适合所有 Cursor 用户对于新手它是绝佳的学习范本能让你快速理解规则能做什么、怎么写对于有一定经验的用户它提供了大量现成的、解决特定场景的规则省去了重复造轮子的时间对于团队技术负责人它更是建立统一编码规范和 AI 协作流程的基石。接下来我将带你深入拆解这个项目看看它如何设计以及如何将它应用到你的日常开发中。2. 项目整体设计与思路拆解2.1 核心目标从“能用”到“好用”的 AI 编程体验跃迁使用原生 Cursor 的 AI 助手无论是 Claude 还是 GPT 模型时它生成的代码往往是“通用正确”的。但“通用”往往意味着不贴合具体项目。比如它可能用双引号而你项目要求单引号它可能生成async/await而你的老项目还在用.then/.catch它可能建议一个庞大的第三方库而你的项目只需要一个轻量级方案。cursor-rules-collection项目的根本目标就是通过规则来约束和引导 AI使其输出从“通用正确”变为“项目特定正确”。这不仅仅是代码风格如缩进、引号更深入到架构模式、依赖管理、安全实践、性能考量等层面。项目的设计思路非常清晰模块化、场景化、可组合。2.2 架构解析分层与分类的规则组织打开项目仓库你会发现它的结构并非一个巨大的.cursorrules文件而是按功能和场景进行了细致的分类。这是一种非常明智的设计它带来了几个显著好处可维护性单个文件不会膨胀到难以阅读和修改。当需要调整“代码风格”相关规则时你只需关注对应的模块。可复用性你可以像搭积木一样根据当前项目的技术栈如 React TypeScript和需求如需要 ESLint 规则选取对应的规则模块进行组合。可读性清晰的分类让后来者或未来的你能快速理解整套规则的意图和覆盖范围。典型的分类可能包括根据项目实际内容推断基础代码风格缩进、分号、引号、命名约定等。框架特定规则针对 React、Vue、Next.js 等框架的最佳实践例如组件结构、Hooks 使用规则。语言增强规则针对 TypeScript、Python、Go 等语言的特定约束如类型严格性、错误处理模式。安全与质量规则避免常见安全漏洞如 SQL 注入风险提示、禁止使用不安全的函数或模式。项目上下文管理如何让 AI 更好地理解项目结构、优先使用的库、避免的库等。交互流程规则定义与 AI 对话时的上下文长度、响应格式等。这种架构体现了作者对 Cursor 规则系统的深刻理解规则不仅是静态的代码约束更是动态的、与项目上下文和开发流程紧密结合的“智能合约”。2.3 规则引擎原理浅析.cursorrules文件如何工作要真正用好这个集合有必要简单了解 Cursor 规则引擎的工作原理。.cursorrules文件本质上是一个配置文件它使用一种特定的语法通常是 YAML 或类似结构来定义规则。每条规则通常包含几个关键部分模式定义规则匹配的条件。这可以是文件路径**/*.ts、代码片段console.log或对话中的关键词。指令当模式匹配时给 AI 的明确指令。这是规则的核心例如“始终使用const而不是let除非变量需要重新赋值”、“为 React 组件编写 PropTypes 或 TypeScript 接口”。描述/原因解释这条规则的目的帮助 AI和开发者理解其重要性。严重程度提示、警告或错误影响 AI 对规则优先级的判断。Cursor 的 AI 在生成代码或回答问题时会实时参考这些规则并尝试使其输出符合所有激活的规则。cursor-rules-collection项目的价值就在于它提供了大量经过验证的、有效的“模式-指令”对覆盖了常见开发场景。注意规则不是万能的它通过自然语言指令引导 AI并不能像编译器一样进行强制语法检查。过于复杂或矛盾的规则可能导致 AI 困惑。因此规则集的设计需要平衡约束力和灵活性。3. 核心规则模块深度解析与实操要点3.1 代码风格与一致性规则这是最基础也是最常用的模块。其目标是消除项目中的风格分歧让 AI 生成的代码“开箱即用”无需手动调整格式。核心规则示例与解析引号与缩进# 规则示例强制使用单引号和 2 空格缩进 - pattern: **/*.{js,ts,jsx,tsx} instruction: | 在此项目中请始终使用单引号定义字符串而不是双引号。 使用 2 个空格进行缩进不要使用制表符Tab。 description: 统一代码风格提高可读性和维护性。实操要点这条规则的模式pattern限定了它只对 JavaScript/TypeScript 及相关文件生效。指令instruction非常明确。你需要根据自己项目的.eslintrc或.prettierrc配置来调整这些细节。如果团队使用双引号和 4 空格就在这里修改。分号使用- pattern: **/*.{js,ts} instruction: 请在所有语句末尾添加分号;。 description: 遵循明确的语句终止风格避免自动分号插入ASI可能带来的意外错误。避坑技巧关于分号的争论由来已久。选择“始终添加”或“永不添加”都可以关键是要在整个规则集中保持一致。如果你选择“永不添加”需要额外添加规则来指导 AI 处理可能引起 ASI 问题的特定情况如以[、(开头的行。命名约定- pattern: **/*.{js,ts,jsx,tsx} instruction: | - 变量和函数名使用 camelCase小驼峰。 - 类名和 React 组件名使用 PascalCase大驼峰。 - 常量全大写使用 SNAKE_CASE。 - 私有成员如果使用以单个下划线 _ 开头。 description: 建立统一的命名规范使代码意图更清晰。注意事项命名规则需要与项目现有的代码库风格高度一致。在引入规则集前最好先扫描一下现有代码确定主流的命名风格。对于混合了不同风格的老项目规则可以设定得宽松一些或者针对新文件src/**/*.ts启用更严格的规则。3.2 框架特定规则以 React 为例这个模块的规则极具价值它能将框架的最佳实践和团队约定“固化”下来让 AI 成为你团队中的“资深框架开发者”。核心规则示例与解析组件结构- pattern: **/*.{jsx,tsx} instruction: | 编写 React 函数组件时请遵循以下结构 1. 首先导入 React如果需要和其他依赖。 2. 定义组件的 Props 类型TypeScript或 PropTypes。 3. 组件函数声明。 4. 在函数顶部使用解构获取 props。 5. 然后是任何 Hook 调用useState, useEffect 等请遵守 Rules of Hooks。 6. 再是任何逻辑计算。 7. 最后返回 JSX。 8. 在组件底部可以定义内部辅助函数或默认 props。 description: 保持组件结构一致提升代码可读性和可维护性。实操心得这条规则通过描述一个理想的代码组织顺序来训练 AI。实测下来这能显著减少“Hooks 在条件语句中调用”这类低级错误并让不同开发者或 AI写的组件看起来像同一个人写的极大降低了阅读成本。Hooks 使用规范- pattern: **/*.{jsx,tsx} instruction: | - 使用 useState 时如果初始状态需要计算请使用函数式初始化useState(() heavyComputation())。 - 为 useEffect 的依赖项数组提供所有必要的外部变量。如果依赖项是对象或数组考虑使用 useMemo 或 useCallback 来稳定引用。 - 优先使用 useCallback 包装传递给子组件的事件处理函数。 description: 引导 AI 遵循 React Hooks 的性能优化最佳实践。为什么重要AI 有时会生成看似能工作但存在性能隐患的代码比如在每次渲染时都创建新的对象或函数导致子组件不必要的重渲染。这条规则能主动引导 AI 避免这些陷阱。状态管理提示- pattern: **/store/**/*.{js,ts} # 假设状态管理逻辑在 store 目录 instruction: | 本项目使用 Zustand 进行状态管理。当需要创建全局状态时 1. 请在 src/store 目录下创建新的 store 文件。 2. 使用 create 函数定义 store状态更新应使用 set 函数。 3. 对于异步操作请在 store 内部定义异步函数。 请优先考虑使用现有的 store而不是创建新的。 description: 将 AI 引导至项目特定的状态管理方案和目录约定。应用场景这条规则完美展示了如何利用规则管理项目上下文。它告诉 AI 项目的技术选型Zustand、文件组织方式并鼓励复用避免了 AI 随意推荐 Redux、MobX 或创建混乱的 Context。3.3 语言增强与安全规则这个模块旨在提升代码的健壮性和安全性防患于未然。核心规则示例与解析TypeScript 严格性- pattern: **/*.{ts,tsx} instruction: | - 请避免使用 any 类型。如果暂时无法确定类型优先使用 unknown 并进行类型守卫。 - 为函数返回值明确指定类型即使可以推断。 - 使用 interface 定义对象形状除非需要联合类型或元组则使用 type。 description: 提高 TypeScript 代码的类型安全性充分利用静态检查的优势。避坑技巧禁止any是提升 TS 项目质量最有效的单条规则之一。但有时在处理第三方库或复杂泛型时AI 可能会被“逼”出奇怪的类型体操。你可以为某些特定文件如**/legacy/**或通过注释// ts-ignore临时豁免此规则但应在规则描述中说明原因。错误处理- pattern: **/*.{js,ts} instruction: | 进行异步操作或可能失败的操作时请使用 try-catch 块进行错误处理。 在 catch 块中至少应将错误记录到控制台console.error或发送到监控服务。 不要吞掉错误空的 catch 块。 对于预期内的错误应抛出具有清晰信息的自定义 Error 类型。 description: 强制实施基本的错误处理实践提高应用稳定性。为什么需要AI 生成的代码片段常常专注于“快乐路径”忽略错误处理。这条规则能提醒 AI 补全这部分关键逻辑虽然生成的错误处理可能比较基础但至少提供了一个必须填充的框架开发者可以在此基础上细化。安全警示- pattern: **/*.{js,ts} instruction: | 当代码涉及以下操作时请给出明确的安全警告 - 将用户输入直接拼接到 SQL 查询字符串中提示使用参数化查询或 ORM。 - 使用 eval() 或 Function 构造函数执行动态代码。 - 将敏感信息如密钥硬编码在代码中。 - 实现文件上传功能时未检查文件类型和大小。 在生成相关代码后请以注释形式添加安全警告和建议的缓解措施。 description: 在代码生成阶段植入安全思维预防常见漏洞。注意事项安全规则更多是“提示性”而非“强制性”的。它不能替代安全审计但能在开发早期在 AI 生成代码的环节就拉起一道提醒防线对于提升团队的安全意识非常有帮助。4. 实操过程集成与定制化你的规则集4.1 基础集成步骤获取规则集将kszongic/cursor-rules-collection仓库克隆到本地或者直接下载你需要的规则模块文件。git clone https://github.com/kszongic/cursor-rules-collection.git项目初始化在你的项目根目录下创建或编辑.cursorrules文件。模块化引入不建议直接复制整个大文件。最佳实践是采用“引用”或“组合”的方式。由于 Cursor 的.cursorrules本身可能不支持import你可以手动将需要的规则块复制进去。建议按以下结构组织你自己的.cursorrules文件# .cursorrules version: 1 # 1. 基础风格规则 # 从集合中复制“代码风格”部分到这里 - pattern: ... instruction: ... # 2. 框架规则 (例如 React) # 从集合中复制“React 特定规则”部分到这里 - pattern: ... instruction: ... # 3. 语言规则 (例如 TypeScript) # 从集合中复制“TypeScript 增强规则”部分到这里 - pattern: ... # 4. 项目特定规则 (你自己定义的) - pattern: **/* instruction: | 本项目的主要入口文件是 src/main.tsx。 我们优先使用以下库axios 用于 HTTP 请求date-fns 用于日期处理clsx 用于 className 合并。 请避免建议使用以下库moment.js体积大jQuery已淘汰。 description: 提供项目上下文信息引导 AI 做出更相关的建议。4.2 规则定制与调试一套规则不可能适合所有项目。定制化是关键。优先级调整规则是按顺序生效的吗通常更具体的pattern会覆盖更通用的。你可以通过调整规则在文件中的顺序来微调优先级。将最重要的、最具体的规则放在前面。模式匹配精调pattern使用 glob 语法。利用它来精确控制规则范围。**/*.ts所有 TypeScript 文件。src/components/**/*.tsx仅src/components目录下的 React 组件。!**/*.test.ts排除所有测试文件如果规则语法支持取反。指令的清晰度给 AI 的指令务必清晰、无歧义。使用肯定句“请始终…”避免模糊表述“最好…”。复杂的指令可以分点列出。测试与迭代创建测试用例在项目中建立一个rules-test目录里面放一些你想让 AI 生成代码的“需求描述”文件.txt或.md。使用 Cursor Chat在 Cursor 中打开测试文件向 AI 描述需求观察生成的代码是否符合规则。记录偏差如果 AI 的输出不符合预期分析是指令不清晰还是模式不匹配或是规则间有冲突。然后回头修改.cursorrules文件。渐进式采用不要一次性启用所有规则。可以先从代码风格和 1-2 个核心框架规则开始让团队适应再逐步添加更复杂的规则。4.3 团队协作与规则共享对于团队项目统一的.cursorrules文件至关重要。版本控制将.cursorrules文件纳入 Git 仓库。这样所有团队成员都使用同一套规则。文档化在README或专门的RULES.md文件中解释你们团队为什么采用某些特定规则例如“我们禁用any以提升类型安全”。这能帮助新成员理解和遵守。规则评审在团队代码评审中有时也可以“评审” AI 生成的代码是否符合规则。这可以作为引入新规则或修改现有规则的一个契机。中央化规则库进阶可以仿照cursor-rules-collection建立团队内部的规则仓库。不同项目可以像引入 npm 包一样选择性地继承基础规则集然后覆盖项目特定的部分。这需要一些自动化脚本的支持。5. 常见问题与排查技巧实录在实际使用和定制规则集的过程中你肯定会遇到各种问题。下面是我踩过的一些坑和解决方案。5.1 规则不生效或效果不明显问题现象设置了规则但 AI 生成的代码似乎完全忽略了它。排查步骤检查文件位置确认.cursorrules文件在项目的根目录下。Cursor 可能不会在子目录中递归查找。检查模式匹配你的pattern是否匹配了当前正在编辑的文件尝试使用一个更通用的模式如**/*来测试规则是否被加载。检查规则语法YAML 对缩进非常敏感。确保缩进是空格而不是制表符并且层级正确。可以使用在线 YAML 校验器检查语法。简化测试创建一条极其简单、明确的规则来测试。例如设置一个规则让 AI 在所有文件顶部添加一个特定注释。如果这条规则生效说明系统是工作的问题出在其他更复杂的规则上。重启 Cursor有时 Cursor 可能没有热重载规则文件尝试重启编辑器。5.2 规则冲突导致 AI 行为异常问题现象AI 的回复变得混乱、自相矛盾或者直接拒绝执行某些操作。原因分析多条规则可能定义了相互矛盾的指令。例如一条规则说“用let”另一条说“始终用const”。解决方案审查规则集仔细阅读所有规则查找明显的矛盾点。特别是通用规则和特定规则之间。利用模式特异性用更具体的pattern来限定冲突规则的适用范围。比如关于变量声明的通用规则可以排除测试文件pattern: “!**/*.test.*”而在测试文件规则中允许使用let。优先级排序将你认为更重要的规则放在文件更靠前的位置如果 Cursor 按顺序处理。合并规则将相关规则合并成一条更复杂的指令明确各种情况下的优先级。例如“对于变量声明默认使用const。只有在变量需要重新赋值的情况下才使用let。永远不要使用var。”5.3 AI 过度遵守规则导致代码僵化问题现象AI 生成的代码虽然符合所有规则但显得笨拙、不优雅或者为了遵守规则而引入了不必要的复杂度。解决方案规则不是法律记住规则是指导方针而非绝对律法。允许一些合理的例外。可以在指令中加入“除非有更清晰、更可读的替代方案”这样的弹性条款。提供正反例在规则的description或通过注释向 AI 解释为什么这条规则存在并给出“好”和“不好”的代码示例。这能帮助 AI 理解规则的精神而非死记字面。分层规则建立基础规则必须遵守和推荐规则建议遵守。对于推荐规则可以使用“请优先考虑…”这样的措辞而非“必须”。人工干预最终决策权在开发者。AI 是强大的助手但不是替代品。对于生成的代码进行必要的人工审查和润色。5.4 如何为特定库或 API 编写高效规则挑战想让 AI 按照特定方式使用某个库如始终用axios.create创建实例或按特定格式使用date-fns。技巧模式匹配导入语句可以编写规则当检测到import axios from ‘axios’时触发一系列关于如何使用 axios 的指令。- pattern: “**/*.{js,ts}” instruction: | 如果代码中导入了 axios请 1. 优先使用从 src/utils/request.js 导出的已配置好的 request 实例。 2. 如果必须创建新实例请使用 axios.create() 并配置 baseURL 和超时时间。 3. 对响应进行错误拦截使用 try-catch 或 .catch。提供代码片段在指令中直接嵌入一小段符合要求的代码作为示例AI 的模仿学习能力很强。结合上下文Cursor 支持在规则中引用其他文件。你可以创建一个api-patterns.md文件里面写满最佳实践示例然后在规则中用引用它让 AI 去学习。5.5 规则集维护与更新问题随着项目演进和技术栈变化规则集可能过时。最佳实践定期复审每个季度或主要版本更新前团队花一点时间回顾.cursorrules文件移除过时的规则添加对新工具或模式的支持。链接到文档在规则描述中可以添加链接指向更详细的内网或外网文档。例如“关于此状态管理规则的详细讨论请参阅[内部 Wiki 链接]。”收集反馈鼓励团队成员在遇到 AI 生成不符合预期的代码时不只是手动修改而是思考“是否应该添加或修改一条规则来避免未来出现同样问题”。建立一个简单的流程如 GitHub Issue来收集规则改进建议。我个人在多个项目中应用类似规则集的经验是初期投入时间进行调试和定制是值得的。它就像为你的 AI 结对编程伙伴进行了一次全面的上岗培训。一旦规则集稳定下来它带来的代码一致性提升和心智负担减轻会远远超过最初的设置成本。最关键的是要从简单的规则开始逐步迭代让它与你的项目和团队共同成长。
Cursor AI编辑器规则集：提升代码质量与团队协作效率
1. 项目概述一个为 Cursor 编辑器量身定制的规则集合如果你和我一样日常重度依赖 Cursor 这款 AI 驱动的代码编辑器那你一定对它的.cursorrules文件又爱又恨。爱的是它能通过一套精妙的规则精准地“调教”AI 助手让它生成更符合你团队规范、项目风格或个人习惯的代码恨的是从零开始编写一套高效、全面的规则既考验对 Cursor 规则引擎的理解又需要大量的实践和试错过程相当磨人。kszongic/cursor-rules-collection这个项目就是来解决这个痛点的。它不是一个简单的规则示例而是一个经过精心设计、分类和实战检验的.cursorrules规则集合库。你可以把它理解为一个为 Cursor 编辑器准备的“规则模版库”或“最佳实践集”。它的核心价值在于将散落在各个角落的规则编写经验系统化地整理出来让开发者无论是个人还是团队都能快速上手直接复用或在其基础上进行微调从而极大提升使用 Cursor 进行 AI 编程的效率和代码质量。这个项目适合所有 Cursor 用户对于新手它是绝佳的学习范本能让你快速理解规则能做什么、怎么写对于有一定经验的用户它提供了大量现成的、解决特定场景的规则省去了重复造轮子的时间对于团队技术负责人它更是建立统一编码规范和 AI 协作流程的基石。接下来我将带你深入拆解这个项目看看它如何设计以及如何将它应用到你的日常开发中。2. 项目整体设计与思路拆解2.1 核心目标从“能用”到“好用”的 AI 编程体验跃迁使用原生 Cursor 的 AI 助手无论是 Claude 还是 GPT 模型时它生成的代码往往是“通用正确”的。但“通用”往往意味着不贴合具体项目。比如它可能用双引号而你项目要求单引号它可能生成async/await而你的老项目还在用.then/.catch它可能建议一个庞大的第三方库而你的项目只需要一个轻量级方案。cursor-rules-collection项目的根本目标就是通过规则来约束和引导 AI使其输出从“通用正确”变为“项目特定正确”。这不仅仅是代码风格如缩进、引号更深入到架构模式、依赖管理、安全实践、性能考量等层面。项目的设计思路非常清晰模块化、场景化、可组合。2.2 架构解析分层与分类的规则组织打开项目仓库你会发现它的结构并非一个巨大的.cursorrules文件而是按功能和场景进行了细致的分类。这是一种非常明智的设计它带来了几个显著好处可维护性单个文件不会膨胀到难以阅读和修改。当需要调整“代码风格”相关规则时你只需关注对应的模块。可复用性你可以像搭积木一样根据当前项目的技术栈如 React TypeScript和需求如需要 ESLint 规则选取对应的规则模块进行组合。可读性清晰的分类让后来者或未来的你能快速理解整套规则的意图和覆盖范围。典型的分类可能包括根据项目实际内容推断基础代码风格缩进、分号、引号、命名约定等。框架特定规则针对 React、Vue、Next.js 等框架的最佳实践例如组件结构、Hooks 使用规则。语言增强规则针对 TypeScript、Python、Go 等语言的特定约束如类型严格性、错误处理模式。安全与质量规则避免常见安全漏洞如 SQL 注入风险提示、禁止使用不安全的函数或模式。项目上下文管理如何让 AI 更好地理解项目结构、优先使用的库、避免的库等。交互流程规则定义与 AI 对话时的上下文长度、响应格式等。这种架构体现了作者对 Cursor 规则系统的深刻理解规则不仅是静态的代码约束更是动态的、与项目上下文和开发流程紧密结合的“智能合约”。2.3 规则引擎原理浅析.cursorrules文件如何工作要真正用好这个集合有必要简单了解 Cursor 规则引擎的工作原理。.cursorrules文件本质上是一个配置文件它使用一种特定的语法通常是 YAML 或类似结构来定义规则。每条规则通常包含几个关键部分模式定义规则匹配的条件。这可以是文件路径**/*.ts、代码片段console.log或对话中的关键词。指令当模式匹配时给 AI 的明确指令。这是规则的核心例如“始终使用const而不是let除非变量需要重新赋值”、“为 React 组件编写 PropTypes 或 TypeScript 接口”。描述/原因解释这条规则的目的帮助 AI和开发者理解其重要性。严重程度提示、警告或错误影响 AI 对规则优先级的判断。Cursor 的 AI 在生成代码或回答问题时会实时参考这些规则并尝试使其输出符合所有激活的规则。cursor-rules-collection项目的价值就在于它提供了大量经过验证的、有效的“模式-指令”对覆盖了常见开发场景。注意规则不是万能的它通过自然语言指令引导 AI并不能像编译器一样进行强制语法检查。过于复杂或矛盾的规则可能导致 AI 困惑。因此规则集的设计需要平衡约束力和灵活性。3. 核心规则模块深度解析与实操要点3.1 代码风格与一致性规则这是最基础也是最常用的模块。其目标是消除项目中的风格分歧让 AI 生成的代码“开箱即用”无需手动调整格式。核心规则示例与解析引号与缩进# 规则示例强制使用单引号和 2 空格缩进 - pattern: **/*.{js,ts,jsx,tsx} instruction: | 在此项目中请始终使用单引号定义字符串而不是双引号。 使用 2 个空格进行缩进不要使用制表符Tab。 description: 统一代码风格提高可读性和维护性。实操要点这条规则的模式pattern限定了它只对 JavaScript/TypeScript 及相关文件生效。指令instruction非常明确。你需要根据自己项目的.eslintrc或.prettierrc配置来调整这些细节。如果团队使用双引号和 4 空格就在这里修改。分号使用- pattern: **/*.{js,ts} instruction: 请在所有语句末尾添加分号;。 description: 遵循明确的语句终止风格避免自动分号插入ASI可能带来的意外错误。避坑技巧关于分号的争论由来已久。选择“始终添加”或“永不添加”都可以关键是要在整个规则集中保持一致。如果你选择“永不添加”需要额外添加规则来指导 AI 处理可能引起 ASI 问题的特定情况如以[、(开头的行。命名约定- pattern: **/*.{js,ts,jsx,tsx} instruction: | - 变量和函数名使用 camelCase小驼峰。 - 类名和 React 组件名使用 PascalCase大驼峰。 - 常量全大写使用 SNAKE_CASE。 - 私有成员如果使用以单个下划线 _ 开头。 description: 建立统一的命名规范使代码意图更清晰。注意事项命名规则需要与项目现有的代码库风格高度一致。在引入规则集前最好先扫描一下现有代码确定主流的命名风格。对于混合了不同风格的老项目规则可以设定得宽松一些或者针对新文件src/**/*.ts启用更严格的规则。3.2 框架特定规则以 React 为例这个模块的规则极具价值它能将框架的最佳实践和团队约定“固化”下来让 AI 成为你团队中的“资深框架开发者”。核心规则示例与解析组件结构- pattern: **/*.{jsx,tsx} instruction: | 编写 React 函数组件时请遵循以下结构 1. 首先导入 React如果需要和其他依赖。 2. 定义组件的 Props 类型TypeScript或 PropTypes。 3. 组件函数声明。 4. 在函数顶部使用解构获取 props。 5. 然后是任何 Hook 调用useState, useEffect 等请遵守 Rules of Hooks。 6. 再是任何逻辑计算。 7. 最后返回 JSX。 8. 在组件底部可以定义内部辅助函数或默认 props。 description: 保持组件结构一致提升代码可读性和可维护性。实操心得这条规则通过描述一个理想的代码组织顺序来训练 AI。实测下来这能显著减少“Hooks 在条件语句中调用”这类低级错误并让不同开发者或 AI写的组件看起来像同一个人写的极大降低了阅读成本。Hooks 使用规范- pattern: **/*.{jsx,tsx} instruction: | - 使用 useState 时如果初始状态需要计算请使用函数式初始化useState(() heavyComputation())。 - 为 useEffect 的依赖项数组提供所有必要的外部变量。如果依赖项是对象或数组考虑使用 useMemo 或 useCallback 来稳定引用。 - 优先使用 useCallback 包装传递给子组件的事件处理函数。 description: 引导 AI 遵循 React Hooks 的性能优化最佳实践。为什么重要AI 有时会生成看似能工作但存在性能隐患的代码比如在每次渲染时都创建新的对象或函数导致子组件不必要的重渲染。这条规则能主动引导 AI 避免这些陷阱。状态管理提示- pattern: **/store/**/*.{js,ts} # 假设状态管理逻辑在 store 目录 instruction: | 本项目使用 Zustand 进行状态管理。当需要创建全局状态时 1. 请在 src/store 目录下创建新的 store 文件。 2. 使用 create 函数定义 store状态更新应使用 set 函数。 3. 对于异步操作请在 store 内部定义异步函数。 请优先考虑使用现有的 store而不是创建新的。 description: 将 AI 引导至项目特定的状态管理方案和目录约定。应用场景这条规则完美展示了如何利用规则管理项目上下文。它告诉 AI 项目的技术选型Zustand、文件组织方式并鼓励复用避免了 AI 随意推荐 Redux、MobX 或创建混乱的 Context。3.3 语言增强与安全规则这个模块旨在提升代码的健壮性和安全性防患于未然。核心规则示例与解析TypeScript 严格性- pattern: **/*.{ts,tsx} instruction: | - 请避免使用 any 类型。如果暂时无法确定类型优先使用 unknown 并进行类型守卫。 - 为函数返回值明确指定类型即使可以推断。 - 使用 interface 定义对象形状除非需要联合类型或元组则使用 type。 description: 提高 TypeScript 代码的类型安全性充分利用静态检查的优势。避坑技巧禁止any是提升 TS 项目质量最有效的单条规则之一。但有时在处理第三方库或复杂泛型时AI 可能会被“逼”出奇怪的类型体操。你可以为某些特定文件如**/legacy/**或通过注释// ts-ignore临时豁免此规则但应在规则描述中说明原因。错误处理- pattern: **/*.{js,ts} instruction: | 进行异步操作或可能失败的操作时请使用 try-catch 块进行错误处理。 在 catch 块中至少应将错误记录到控制台console.error或发送到监控服务。 不要吞掉错误空的 catch 块。 对于预期内的错误应抛出具有清晰信息的自定义 Error 类型。 description: 强制实施基本的错误处理实践提高应用稳定性。为什么需要AI 生成的代码片段常常专注于“快乐路径”忽略错误处理。这条规则能提醒 AI 补全这部分关键逻辑虽然生成的错误处理可能比较基础但至少提供了一个必须填充的框架开发者可以在此基础上细化。安全警示- pattern: **/*.{js,ts} instruction: | 当代码涉及以下操作时请给出明确的安全警告 - 将用户输入直接拼接到 SQL 查询字符串中提示使用参数化查询或 ORM。 - 使用 eval() 或 Function 构造函数执行动态代码。 - 将敏感信息如密钥硬编码在代码中。 - 实现文件上传功能时未检查文件类型和大小。 在生成相关代码后请以注释形式添加安全警告和建议的缓解措施。 description: 在代码生成阶段植入安全思维预防常见漏洞。注意事项安全规则更多是“提示性”而非“强制性”的。它不能替代安全审计但能在开发早期在 AI 生成代码的环节就拉起一道提醒防线对于提升团队的安全意识非常有帮助。4. 实操过程集成与定制化你的规则集4.1 基础集成步骤获取规则集将kszongic/cursor-rules-collection仓库克隆到本地或者直接下载你需要的规则模块文件。git clone https://github.com/kszongic/cursor-rules-collection.git项目初始化在你的项目根目录下创建或编辑.cursorrules文件。模块化引入不建议直接复制整个大文件。最佳实践是采用“引用”或“组合”的方式。由于 Cursor 的.cursorrules本身可能不支持import你可以手动将需要的规则块复制进去。建议按以下结构组织你自己的.cursorrules文件# .cursorrules version: 1 # 1. 基础风格规则 # 从集合中复制“代码风格”部分到这里 - pattern: ... instruction: ... # 2. 框架规则 (例如 React) # 从集合中复制“React 特定规则”部分到这里 - pattern: ... instruction: ... # 3. 语言规则 (例如 TypeScript) # 从集合中复制“TypeScript 增强规则”部分到这里 - pattern: ... # 4. 项目特定规则 (你自己定义的) - pattern: **/* instruction: | 本项目的主要入口文件是 src/main.tsx。 我们优先使用以下库axios 用于 HTTP 请求date-fns 用于日期处理clsx 用于 className 合并。 请避免建议使用以下库moment.js体积大jQuery已淘汰。 description: 提供项目上下文信息引导 AI 做出更相关的建议。4.2 规则定制与调试一套规则不可能适合所有项目。定制化是关键。优先级调整规则是按顺序生效的吗通常更具体的pattern会覆盖更通用的。你可以通过调整规则在文件中的顺序来微调优先级。将最重要的、最具体的规则放在前面。模式匹配精调pattern使用 glob 语法。利用它来精确控制规则范围。**/*.ts所有 TypeScript 文件。src/components/**/*.tsx仅src/components目录下的 React 组件。!**/*.test.ts排除所有测试文件如果规则语法支持取反。指令的清晰度给 AI 的指令务必清晰、无歧义。使用肯定句“请始终…”避免模糊表述“最好…”。复杂的指令可以分点列出。测试与迭代创建测试用例在项目中建立一个rules-test目录里面放一些你想让 AI 生成代码的“需求描述”文件.txt或.md。使用 Cursor Chat在 Cursor 中打开测试文件向 AI 描述需求观察生成的代码是否符合规则。记录偏差如果 AI 的输出不符合预期分析是指令不清晰还是模式不匹配或是规则间有冲突。然后回头修改.cursorrules文件。渐进式采用不要一次性启用所有规则。可以先从代码风格和 1-2 个核心框架规则开始让团队适应再逐步添加更复杂的规则。4.3 团队协作与规则共享对于团队项目统一的.cursorrules文件至关重要。版本控制将.cursorrules文件纳入 Git 仓库。这样所有团队成员都使用同一套规则。文档化在README或专门的RULES.md文件中解释你们团队为什么采用某些特定规则例如“我们禁用any以提升类型安全”。这能帮助新成员理解和遵守。规则评审在团队代码评审中有时也可以“评审” AI 生成的代码是否符合规则。这可以作为引入新规则或修改现有规则的一个契机。中央化规则库进阶可以仿照cursor-rules-collection建立团队内部的规则仓库。不同项目可以像引入 npm 包一样选择性地继承基础规则集然后覆盖项目特定的部分。这需要一些自动化脚本的支持。5. 常见问题与排查技巧实录在实际使用和定制规则集的过程中你肯定会遇到各种问题。下面是我踩过的一些坑和解决方案。5.1 规则不生效或效果不明显问题现象设置了规则但 AI 生成的代码似乎完全忽略了它。排查步骤检查文件位置确认.cursorrules文件在项目的根目录下。Cursor 可能不会在子目录中递归查找。检查模式匹配你的pattern是否匹配了当前正在编辑的文件尝试使用一个更通用的模式如**/*来测试规则是否被加载。检查规则语法YAML 对缩进非常敏感。确保缩进是空格而不是制表符并且层级正确。可以使用在线 YAML 校验器检查语法。简化测试创建一条极其简单、明确的规则来测试。例如设置一个规则让 AI 在所有文件顶部添加一个特定注释。如果这条规则生效说明系统是工作的问题出在其他更复杂的规则上。重启 Cursor有时 Cursor 可能没有热重载规则文件尝试重启编辑器。5.2 规则冲突导致 AI 行为异常问题现象AI 的回复变得混乱、自相矛盾或者直接拒绝执行某些操作。原因分析多条规则可能定义了相互矛盾的指令。例如一条规则说“用let”另一条说“始终用const”。解决方案审查规则集仔细阅读所有规则查找明显的矛盾点。特别是通用规则和特定规则之间。利用模式特异性用更具体的pattern来限定冲突规则的适用范围。比如关于变量声明的通用规则可以排除测试文件pattern: “!**/*.test.*”而在测试文件规则中允许使用let。优先级排序将你认为更重要的规则放在文件更靠前的位置如果 Cursor 按顺序处理。合并规则将相关规则合并成一条更复杂的指令明确各种情况下的优先级。例如“对于变量声明默认使用const。只有在变量需要重新赋值的情况下才使用let。永远不要使用var。”5.3 AI 过度遵守规则导致代码僵化问题现象AI 生成的代码虽然符合所有规则但显得笨拙、不优雅或者为了遵守规则而引入了不必要的复杂度。解决方案规则不是法律记住规则是指导方针而非绝对律法。允许一些合理的例外。可以在指令中加入“除非有更清晰、更可读的替代方案”这样的弹性条款。提供正反例在规则的description或通过注释向 AI 解释为什么这条规则存在并给出“好”和“不好”的代码示例。这能帮助 AI 理解规则的精神而非死记字面。分层规则建立基础规则必须遵守和推荐规则建议遵守。对于推荐规则可以使用“请优先考虑…”这样的措辞而非“必须”。人工干预最终决策权在开发者。AI 是强大的助手但不是替代品。对于生成的代码进行必要的人工审查和润色。5.4 如何为特定库或 API 编写高效规则挑战想让 AI 按照特定方式使用某个库如始终用axios.create创建实例或按特定格式使用date-fns。技巧模式匹配导入语句可以编写规则当检测到import axios from ‘axios’时触发一系列关于如何使用 axios 的指令。- pattern: “**/*.{js,ts}” instruction: | 如果代码中导入了 axios请 1. 优先使用从 src/utils/request.js 导出的已配置好的 request 实例。 2. 如果必须创建新实例请使用 axios.create() 并配置 baseURL 和超时时间。 3. 对响应进行错误拦截使用 try-catch 或 .catch。提供代码片段在指令中直接嵌入一小段符合要求的代码作为示例AI 的模仿学习能力很强。结合上下文Cursor 支持在规则中引用其他文件。你可以创建一个api-patterns.md文件里面写满最佳实践示例然后在规则中用引用它让 AI 去学习。5.5 规则集维护与更新问题随着项目演进和技术栈变化规则集可能过时。最佳实践定期复审每个季度或主要版本更新前团队花一点时间回顾.cursorrules文件移除过时的规则添加对新工具或模式的支持。链接到文档在规则描述中可以添加链接指向更详细的内网或外网文档。例如“关于此状态管理规则的详细讨论请参阅[内部 Wiki 链接]。”收集反馈鼓励团队成员在遇到 AI 生成不符合预期的代码时不只是手动修改而是思考“是否应该添加或修改一条规则来避免未来出现同样问题”。建立一个简单的流程如 GitHub Issue来收集规则改进建议。我个人在多个项目中应用类似规则集的经验是初期投入时间进行调试和定制是值得的。它就像为你的 AI 结对编程伙伴进行了一次全面的上岗培训。一旦规则集稳定下来它带来的代码一致性提升和心智负担减轻会远远超过最初的设置成本。最关键的是要从简单的规则开始逐步迭代让它与你的项目和团队共同成长。
