我第一次接触 Cursor Rules 时,完全不知道这东西能干什么。当时我只是个刚毕业两个月的后端实习生,每天在公司写 Vue 代码写得头疼不已。导师推荐我用 Cursor 这个编辑器,说它能“读懂你的项目”,但我下载下来后发现它就是个普通的编辑器,没有任何神奇效果。
直到我学会了配置 Cursor Rules。
现在每天上班,我只要打开项目,Cursor 就自动知道这是 Vue3 项目、要用 Composition API、组件命名要用 PascalCase、API 请求必须用 Axios。代码补全命中率从 30% 飙升到 80%,写一个页面从两小时变成四十分钟。
这篇文章就是写给和我当初一样的新手的。我会从零开始,手把手教你配置 Cursor Rules,让你也能体验这种“飞一般的感觉”。
什么是 Cursor Rules?为什么你需要它
Cursor 是一个内置 AI 能力的代码编辑器,你可以把它理解成“装了个超级智能助手的 VS Code”。而 Cursor Rules 就是给这个 AI 助手的“工作手册”——你告诉它项目用什么技术栈、代码风格什么样、哪些事情不能做,它就会按照你的要求来写代码。
举几个我自己的例子:
- 我告诉它“所有组件必须用 TypeScript,必须有完整类型定义”,从此它生成的代码再也没有 any 类型
- 我告诉它“API 接口必须统一加 token 认证”,它写接口时自动带上 Authorization 头
- 我告诉它“React 组件必须用函数式组件”,它再也没给我写过 class 组件
这就是 Cursor Rules 的威力——你定义规则,AI 执行规则。
第一步:获取 API Key(使用 HolySheep AI)
在配置 Cursor Rules 之前,你需要先有一个 AI API Key。我推荐使用 HolySheep AI,原因很简单:
- 价格便宜:人民币直充,汇率 1:1 无损耗,官方兑换价 ¥7.3 = $1,比官方渠道省 85% 以上
- 速度快:国内直连延迟低于 50ms,打开项目秒级响应
- 额度多:注册就送免费额度,够你练手一个月
- 模型全:GPT-4.1 $8/MTok、Claude Sonnet 4.5 $15/MTok、Gemini 2.5 Flash $2.5/MTok、DeepSeek V3.2 $0.42/MTok,主流模型全覆盖
(文字模拟截图提示:浏览器打开 https://www.holysheep.ai,点击右上角“注册”,用手机号完成注册)
注册完成后,进入控制台 → API Keys → 创建新密钥,复制保存好这个 Key。长的这样:hs-xxxxxxxxxxxxxxxxxxxxxxxx,这就是你的“身份证”。
第二步:认识 .cursorrules 文件
Cursor Rules 的配置文件叫 .cursorrules,是一个藏在项目根目录的“隐形文件”。(说它隐形是因为文件名以点开头,在 Windows 资源管理器里默认不显示)
这个文件用 YAML 格式编写,结构很简单:
# 这是我 Vue3 项目的 .cursorrules 文件示例
井号开头的是注释,Cursor 会自动忽略
1. 定义项目基本信息
project:
name: 我的Vue3后台管理系统
framework: Vue3
language: TypeScript
ui-library: Element Plus
2. 定义代码规范
code-style:
- 使用 Composition API (script setup)
- 组件名用 PascalCase
- CSS 类名用 kebab-case
- 优先使用箭头函数
- 所有组件必须有完整的 TypeScript 类型
3. 定义禁止事项
forbidden:
- 不许使用 var,必须用 const 或 let
- 不许写 console.log 调试代码
- 不许在 template 里写内联样式
- 不许使用 jQuery
4. 定义必须遵守的流程
workflow:
- 创建组件前先在 components 文件夹检查是否已存在
- API 请求统一封装在 api 文件夹
- 每个组件必须配套写单元测试
当你把这个文件放进项目根目录后,每次打开项目,Cursor 的 AI 就会自动读取这些规则,成为“懂你项目的 AI 助手”。
第三步:基础规则配置(适合新手的入门配置)
让我们从最简单的配置开始。先在你的项目根目录创建 .cursorrules 文件:
(文字模拟截图提示:在 VS Code 里按 Ctrl+N 新建文件,保存为 .cursorrules,没有后缀名)
3.1 配置项目框架类型
这是最基础的一条——告诉 Cursor 你的项目用什么技术。这能大幅提升代码补全的准确率。
# 告诉 Cursor 这是什么类型的项目
project:
framework: "Vue 3"
language: "TypeScript"
css: "SCSS"
配置后,Cursor 就会知道:“哦,这是一个 Vue3 + TypeScript 项目,我应该用 Vue 的语法来生成代码。”
3.2 配置代码风格规则
我见过太多团队代码风格混乱——有人用双引号有人用单引号,有人加分号有人不加分号。配置统一的代码风格规则,就能彻底解决这个问题。
# 统一代码风格
code-style:
- 缩进使用 2 个空格
- 字符串统一使用单引号
- 每行代码结尾不加分号
- const 声明的变量用大写加下划线命名(常量)
- 组件的 props 必须标注类型
Vue3 特定规则
vue:
- 使用 script setup 语法
- 组件结构:template → script → style
- 必须使用 Pinia 进行状态管理
- 路由必须使用懒加载
3.3 配置 AI 角色定位
你可以给 Cursor 的 AI 定义一个“角色”,让它以特定身份来帮你写代码。
# 定义 AI 角色
role:
name: "资深 Vue3 开发工程师"
experience: "5年前端开发经验,精通 Vue 全家桶"
personality: "严谨、代码洁癖、追求性能优化"
AI 应该遵循的原则
principles:
- 写代码前先理解需求,不要盲目开始
- 优先考虑代码可维护性和可读性
- 性能问题大于代码简洁性
- 重要的逻辑必须加注释说明
第四步:进阶规则配置(提升 10 倍效率)
基础配置只能让你用得“还行”,进阶配置才能让你体验什么叫“起飞”。以下是几个我用了半年、效果最好的进阶配置。
4.1 自动代码审查规则
我配置了这个规则后,Cursor 每次帮我写完代码都会自动检查:有没有安全漏洞、是否有性能问题、是否符合团队规范。
# 代码审查规则
code-review:
security:
- 禁止内联 SQL 查询,必须参数化
- 禁止在前端存储敏感信息(密码、Token 明文)
- 用户输入必须做 XSS 过滤
- API 请求必须验证权限
performance:
- 循环超过 3 层必须优化
- 大数据渲染必须使用虚拟滚动
- 图片必须指定尺寸防止重排
- 避免在 template 中写复杂计算
best-practices:
- 接口返回必须做空值判断
- 异步操作必须加错误处理
- 重要函数必须有 JSDoc 注释
4.2 组件自动生成模板
我定义了一个组件生成模板,以后让 Cursor 创建新组件时,会自动套用这个格式。
# 组件生成模板
component-template: |
<template>
<div class="{{name}}">
<!-- 组件内容 -->
</div>
</template>
<script setup lang="ts">
import { ref, computed } from 'vue'
// Props 定义
interface Props {
title: string
disabled?: boolean
}
const props = withDefaults(defineProps<Props>(), {
disabled: false
})
// Emits 定义
const emit = defineEmits<{
(e: 'update', value: string): void
}>()
// 响应式数据
const loading = ref(false)
// 计算属性
const isActive = computed(() => !props.disabled)
// 方法
const handleClick = () => {
emit('update', 'clicked')
}
</script>
<style scoped lang="scss">
.{{name}} {
padding: 16px;
}
</style>
4.3 API 层自动封装规则
这是我最得意的配置。我定义了一套 API 调用规范,Cursor 每次写接口请求都会自动套用这个模板,再也不会有人写出乱七八糟的 axios 代码了。
# API 层规范
api-rules:
# 统一使用这个基础配置
base-config: |
axios.defaults.baseURL = '/api'
axios.defaults.timeout = 10000
axios.defaults.headers['Content-Type'] = 'application/json'
# 所有请求必须自动携带 Token
auth: |
请求必须从 localStorage 获取 token 并添加到 headers:
headers: { Authorization: 'Bearer ' + localStorage.getItem('token') }
# 响应拦截器配置
response-handler: |
- 状态码 401 自动跳转登录页
- 状态码 500 弹出错误提示
- 统一在 then 中返回 res.data
- 统一在 catch 中做错误上报
# 接口函数模板
function-template: |
// 获取用户列表
export const getUserList = (params: UserQueryDTO) => {
return axios.get('/users', { params })
.then(res => res.data)
.catch(handleError)
}
第五步:连接 HolySheep AI API(国内直连)
配置完 Cursor Rules 后,你需要把 Cursor 连接到 AI 服务商。我推荐用 HolySheep AI,原因刚才说了:速度快(延迟低于 50ms)、价格低(人民币直充汇率 1:1)、额度多(注册送免费额度)。
打开 Cursor → Settings → Models → Custom Model,填入以下配置:
# Cursor API 配置
Base URL: https://api.holysheep.ai/v1
API Key: 你的 HolySheep API Key(格式:hs-xxxxxxxx)
推荐使用的模型
- GPT-4.1(通用能力最强,适合复杂规则理解)
- Claude Sonnet 4.5(代码质量最高,适合代码审查)
- DeepSeek V3.2(性价比最高,适合日常开发)
(文字模拟截图提示:Cursor 界面左下角齿轮图标 → 找到 Models 选项卡 → 选择 Custom → 填入上面配置)
常见报错排查
配置 Cursor Rules 的过程中,新手最容易遇到以下 3 个问题。我当初每个都踩过坑,现在把解决方案分享给你。
错误 1:API Key 无效,报错 "Invalid API Key"
错误表现:Cursor 提示 "Invalid API key" 或 "Authentication failed",无法连接 AI。
原因分析:你复制的 Key 格式不对,或者 Key 已经失效。
解决代码:
# 检查你的 Key 格式是否正确
正确的 HolySheep Key 格式:hs-xxxxxxxxxxxxxxxxxxxxxxxx
如果 Key 不对,去控制台重新生成:
1. 打开 https://www.holysheep.ai/console
2. 进入 API Keys 页面
3. 点击 "Create New Key"
4. 复制新生成的 Key(不要手动输入,容易出错)
检查 API 调用地址是否正确
正确地址:https://api.holysheep.ai/v1
不要用 api.openai.com,那是错的!
如果以上都没问题,检查额度是否用完
进入控制台 → 余额 → 查看是否还有可用额度
错误 2:.cursorrules 文件不生效
错误表现:文件创建了,但 Cursor 没有按规则来生成代码。
原因分析:文件位置不对、文件名错误、或者 YAML 格式有语法问题。
解决代码:
# 1. 确认文件位置
文件必须放在项目根目录,不是 src 目录
正确位置:project-root/.cursorrules
错误位置:project-root/src/.cursorrules
2. 确认文件名
必须叫 .cursorrules,不是 cursorrules.yaml 或 cursor-rules
Windows 用户注意:资源管理器可能不显示这个文件,用命令行创建:
echo. > .cursorrules
3. 检查 YAML 格式
不要用 Tab 缩进,必须用空格(2个空格)
检查引号是否成对出现
检查冒号后面是否有空格
4. 重启 Cursor
有时候配置需要重启编辑器才生效
关闭 Cursor → 重新打开
错误 3:代码风格规则没有生效,AI 还是按自己的风格写
错误表现:配置了代码风格规则,但 Cursor 生成的还是用双引号、分号等不符合规范的内容。
原因分析:规则描述不够精确,或者需要用更强制的方式表达。
解决代码:
# 修改 .cursorrules 文件,用更强硬的语气:
用 MUST / MUST NOT 来强调
code-style:
- MUST use single quotes for strings(必须用单引号)
- MUST NOT use console.log(禁止用 console.log)
- MUST NOT use var keyword(禁止用 var)
用反例来强调
code-style:
- 使用单引号,禁止双引号 ❌
- 字符串统一使用单引号,例如 'hello' ✓
在 workflow 中强调
workflow:
- 写完代码后必须检查是否符合以下规则:
✓ 字符串用单引号
✓ 不用 var,用 const/let
✓ 结尾无分号
✓ 缩进两个空格
- 如果不符合,修正后再提交
我的实战经验总结
用 Cursor Rules 半年多,我总结了几个心得:
第一,规则要慢慢加,不要一口气写 50 条。我一开始恨不得把所有规范都写进去,结果 Cursor 直接“摆烂”,生成代码一塌糊涂。后来我改成每次只加 3-5 条,等稳定了再加新的,效果好很多。
第二,用具体例子比抽象描述更有效。比如与其写“使用 TypeScript 泛型”,不如写“数组操作必须用 Array<T> 类型,不要写 any[]”。Cursor 对具体例子理解更准确。
第三,连接到 HolySheep AI 后,记得选对模型。日常开发用 DeepSeek V3.2 性价比最高($0.42/MTok),做代码审查用 Claude Sonnet 4.5 效果最好($15/MTok 但质量高),写复杂业务逻辑用 GPT-4.1($8/MTok,能力最全面)。
配置好 Cursor Rules 后,我的日均代码产出从 300 行提升到 800 行,代码 Bug 率下降了 60%。更重要的是,我现在写代码不再是“单打独斗”,而是有一个 24 小时在线的“高级工程师”帮我把控代码质量和风格。
现在就去试试吧!👉 免费注册 HolySheep AI,获取首月赠额度