Cursor Rules怎么配置前端项目规范?

裘德小鎮的故事

裘德小鎮的故事

2026-07-29

306人浏览

原创

必须在项目根目录配置.cursorrules文件,否则cursor ai无法识别vue3技术栈、目录结构和编码规范,生成代码将与项目脱节;需定义框架版本、目录结构、命名规则、typescript/composition api约束及代码风格,并执行eslint自动修复。

☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

cursor rules怎么配置前端项目规范?

要让Cursor AI在Vue3项目中自动生成符合团队规范的代码,必须在项目根目录配置.cursorrules文件,否则AI无法识别技术栈、目录结构和编码习惯,生成的代码大概率与项目实际脱节。

创建.cursorrules文件并写入基础技术栈

在项目根目录新建纯文本文件,命名为 .cursorrules(注意开头是英文点号,无后缀)。

用任意编辑器打开,粘贴以下内容(根据你真实项目调整框架版本和库名):

# 技术栈约束
frameworks:
  - vue: 3.4+
  - ui: element-plus@2.4+
languages:
  - typescript: '>=5.1'
features:
  - composition-api: required
  - script-setup: required

这一步必须做,否则AI会默认按通用JavaScript逻辑补全,比如把defineProps()写成Options API风格的props: {},直接导致编译报错。

定义前端目录结构与文件命名规则

在.cursorrules文件末尾追加结构声明,明确告诉AI“你的src下每个文件夹是干什么的”:

# 目录结构
src/
  views/: 页面级组件,文件名小写中划线,如 user-list.vue
  components/: 可复用原子组件,文件名PascalCase,如 UserProfileCard.vue
  composables/: 组合式函数,必须以use开头,如 useTablePagination.ts
  stores/: Pinia store,文件名小写中划线,如 user-store.ts
  api/: 请求封装,按模块分组,如 api/user/index.ts
  router/: 路由配置,仅包含 router/index.ts

⚠️ 注意:views/ 和 components/ 的命名规则完全相反——前者强制小写中划线(便于URL映射),后者强制PascalCase(Vue组件注册要求)。AI若混淆这两条,生成的组件名会触发Vue运行时警告。

嵌入TypeScript与Composition API硬性规范

方法一:直接写进.cursorrules主文件

## TypeScript规范
- 禁止使用 any,必须用 unknown + 类型守卫或具体接口
- 所有 defineProps() 必须带泛型参数,如 defineProps()
- 组件导出必须标注类型:export default defineComponent({}) as ComponentPublicInstance

面向设计的AXUI前端框架表单
面向设计的AXUI前端框架表单

面向设计的AXUI前端框架表单是一款包含表格、列表、弹窗等的AXUI前端框架表单下载。

下载

方法二:为.vue文件单独设规则(推荐)

在项目根目录新建 .cursor/rules/vue-component.rules 文件,内容为:

filetype: .vue
rules:
  - 模板中所有绑定属性必须用双引号,如 :class="xxx"
  - <script setup> 中必须用 import type { XXX } from 'xxx' 声明类型<br> - 响应式变量必须用 ref() 或 reactive() 显式声明,禁止 let xxx = {}</script>

这种拆分方式能让AI对.vue文件的理解精度提升,尤其避免它把ref()误写成reactive()后导致模板响应失效。

设置代码风格与自动修复项

第一步:确认项目已安装 eslint-config-prettier 和 @typescript-eslint/eslint-plugin

第二步:在.cursorrules中添加格式化指令

## 代码风格
- 所有字符串统一用单引号,除HTML属性值
- 函数参数超过3个必须换行,每行一个参数
- import语句按三段式排序:第三方包 → @/别名路径 → 相对路径
- 禁止在组件内写 console.log,调试必须用 useLogger() 组合式函数

第三步:关键操作——在项目根目录执行:npm run lint -- --fix

这一步必须做,因为Cursor的Rules不接管ESLint自动修复,只影响AI生成逻辑。若本地未开启--fix,AI生成的代码即使符合规则,也会被pre-commit钩子拒绝提交。

前端入门到VUE实战笔记:立即使用
在学习笔记中,你将探索 前端 的入门与实战技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1086

5

前端如何实现即时通讯
前端如何实现即时通讯

实现即时通讯的方法有WebSocket、Long Polling、Server-Sent Events、WebRTC等等。详细介绍:1、WebSocket,它可以在客户端和服务器之间建立持久连接,实现实时的双向通信,前端可以使用 WebSocket API来创建WebSocket连接,并通过发送和接收消息来实现即时通讯;2、Long Polling,是一种模拟实时通信的技术等等。

2023.10.09

2210

6

前端和后端的区别
前端和后端的区别

前端关注的是用户界面的设计和交互,而后端则注重数据处理和逻辑控制。想了解更多前端后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

2104

13

php和前端的关联介绍
php和前端的关联介绍

php既可以作为前端语言,也可以作为后端语言。想了解更多php和前端的相关内容,可以阅读本专题下面的文章。

2024.03.22

2275

10

前端外包工作内容有哪些
前端外包工作内容有哪些

前端外包工作内容包括:1. 网站和应用程序开发;2. 用户界面和交互设计;3. 用户体验优化;4. 设计和视觉开发;5. 跨浏览器兼容性;6. 性能优化;7. 维护和更新;8. 项目管理和沟通。想了解更多前端的相关内容,可以阅读本专题下面的文章。

2024.05.22

334

5

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1086

5

前端如何实现即时通讯
前端如何实现即时通讯

实现即时通讯的方法有WebSocket、Long Polling、Server-Sent Events、WebRTC等等。详细介绍:1、WebSocket,它可以在客户端和服务器之间建立持久连接,实现实时的双向通信,前端可以使用 WebSocket API来创建WebSocket连接,并通过发送和接收消息来实现即时通讯;2、Long Polling,是一种模拟实时通信的技术等等。

2023.10.09

2210

6

前端和后端的区别
前端和后端的区别

前端关注的是用户界面的设计和交互,而后端则注重数据处理和逻辑控制。想了解更多前端后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

2104

13

php和前端的关联介绍
php和前端的关联介绍

php既可以作为前端语言,也可以作为后端语言。想了解更多php和前端的相关内容,可以阅读本专题下面的文章。

2024.03.22

2275

10

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Cursor 使用手册
Cursor 使用手册

共0课时 | 0人学习

Vue3.x 工具篇--十天技能课堂
Vue3.x 工具篇--十天技能课堂

共26课时 | 2.2万人学习