怎样实现 Vue 项目的自动化代码规范格式化?

冷漠man

冷漠man

2026-07-09

985人浏览

原创

vue项目自动化代码规范的核心是eslint(质量检查)、prettier(格式化)、husky(git钩子)与lint-staged(暂存区校验)协同:eslint检测错误并配合prettier统一风格,husky在pre-commit时触发lint-staged对js/vue/ts文件执行--fix和--write,实现提交前自动修复。

怎样实现 vue 项目的自动化代码规范格式化?

在 Vue 项目中实现自动化代码规范格式化,核心是把 ESLint + Prettier + Husky + lint-staged 串联起来,让代码在提交前自动检查并修复常见问题,避免人工反复调整。

配置 ESLint 和 Prettier 统一规则

ESLint 负责代码质量与潜在错误检测,Prettier 负责代码风格(缩进、引号、换行等)统一。二者需协同工作,避免冲突:

  • 安装依赖:npm install -D eslint prettier eslint-config-prettier eslint-plugin-prettier @vue/eslint-config-typescript @vue/eslint-config-prettier
  • .eslintrc.cjs 中启用 plugin:prettier/recommended,并确保它放在 extends 数组末尾(覆盖优先级最高)
  • 新建 .prettierrc 显式定义风格偏好,例如:
    { "semi": false, "singleQuote": true, "tabWidth": 2 }
  • 添加 .eslintignore 排除 node_modules/dist/public/ 等目录

用 lint-staged + Husky 在提交前自动修复

仅靠手动运行 eslint --fixprettier --write 效率低,容易遗漏。通过 Git 钩子自动触发才是可持续方案:

Vue-router参考手册
Vue-router参考手册

Vue-router参考手册下载

下载
  • 安装:npm install -D husky lint-staged
  • 初始化 Husky:npx husky install,并设置 package.json 的 prepare 脚本:
    "prepare": "husky install"
  • 添加 pre-commit 钩子:npx husky add .husky/pre-commit "npx lint-staged"
  • lint-staged 配置中指定对 *.{js,vue,ts} 文件执行:
    "eslint --fix"
    "prettier --write"

编辑器实时提示与保存自动格式化(可选但推荐)

开发过程中及时反馈能减少后期修复成本。VS Code 用户可配合插件提升体验:

  • 安装插件:ESLintPrettier
  • 在 VS Code 设置中开启:
    "editor.codeActionsOnSave": { "source.fixAll.eslint": true }
  • 确保项目根目录有 .vscode/settings.json,内容包含:
    "editor.formatOnSave": true,
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  • 注意:若 ESLint 和 Prettier 规则冲突,保存时可能反复修改——务必按上一步先统一配置

补充:Vue SFC 特殊处理(如

Vue 单文件组件的 <template></template> 默认不被 Prettier 支持,需额外配置:

  • 安装:npm install -D @prettier/plugin-pug(如用 pug)或更通用的 @prettier/plugin-vue
  • .prettierrc 中加入:
    "plugins": ["@prettier/plugin-vue"]
  • 确保 vue/multi-word-component-names 等 Vue 特有规则由 @vue/eslint-config-typescript 提供,并在 ESLint 配置中启用 plugin:vue/vue3-essential 或对应版本

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

相关文章

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

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

下载

相关标签:

vue 代码规范

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

相关专题

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

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

2023.08.11

1111

5

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

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

2023.10.09

2262

6

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

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

2024.03.19

2132

13

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

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

2024.03.22

2322

10

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

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

2024.05.22

336

5

vue2.0和3.0区别
vue2.0和3.0区别

vue2.0和3.0区别:vue2的响应式原理是利⽤“Object.defineProperty()”对数据进⾏劫持结合发布订阅模式的⽅式来实现,vue3中使⽤了es6的proxy API对数据代理,实现对数据的监控。本专题为大家提供vue2.0和3.0区别的相关的文章、下载、课程内容,供大家免费下载体验。

2023.07.17

887

5

vue3的生命周期有哪些
vue3的生命周期有哪些

vue3的生命周期:1、beforecreate;2、created;3、beforemount;4、mounted;5、beforeupdate;6、updated;7、beforedestroy;8、destroyed;9、activated;10、deactivated等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.02.23

10619

5

Vue3组合式API与组件开发实战
Vue3组合式API与组件开发实战

本专题讲解 Vue 3 组合式 API 的核心概念与应用技巧,深入分析响应式系统、生命周期管理、组件设计与复用策略。通过完整项目案例,指导前端开发者实现高性能、结构清晰的 Vue 应用,提升开发效率与代码可维护性。

2026.02.10

153

23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
uni-app快速上手
uni-app快速上手

共0课时 | 0人学习

Vue 教程
Vue 教程

共42课时 | 15.6万人学习

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

共26课时 | 2.2万人学习