什么是cursor rules?
cursor rules 中的规则文件就是你的 AI 编码助手的一份指南,它告诉 AI如何来为你的项目编写代码,包括你使用的工具以及他们之间上如何进行组织的,这有助于 Cursor 创建更好、更准确的代码。
直白点讲就是让cursor按照拟定的规则来生成代码,防止cursor偏离原来想达到的目的。cursor是通过大模型进行返回的,大模型返回的内容不一定符合项目的规范或者公司制定的一些规范。这时候就需要用自定义的这些规则,来约束cursor进行回答。
比如在写后端代码,返回值统一定义为这种结构:
{"error" : 0,"message:""data": {}
}
配置cursor rules
打开cursor的设置,在设置中可以看到Rules的配置,上面为用户配置,是每次cursor都会执行的配置。下面是Project Rules,是当前工程的配置。
新建项目Rules
cursor会提示输入一个Rule的名称,名称输入完成后,会在项目中多出来rules的目录,里面就是当前项目所对应的rules。
这个位置是用来写rule具体内容的地方
Rule Type分四个类别,它用来设置该规则什么情况下被触发。
Always:该规则始终生效,适合全局强制规范。
Auto Attached:制定触发的文件类型,比如所有的js文件会触发这个规则 ,那配置就是*.js
Agent Requested:让cursor自动去判断是否引用该规则,本次对话可能会使用到,也可能未被使用到。
Manual:手动调用该规则,否则不会被应用。如下图所示:
通用Rules和自定义Rules
通用Rules
通用Rules更聚焦在框架上,比如springboot框架,Vue框架等等。
这种规则,已经有比较多的开源数据,可以直接用别人写好的。
https://github.com/sanjeed5/awesome-cursor-rules-mdc/tree/main
这里面几乎包含了市面上常用的前后端框架的Rules,比如搜VUE3
自定义Rules
自定义Rules更聚焦在自己的开发规范,比如可以给自己的开发小组制定规则。