Vue 3 项目怎么使用 Husky 和 Commitlint 规范 Git 提交信息

浅静君_3207

浅静君_3207

2026-09-24

187人浏览

原创

vue 3 项目中通过 husky + commitlint 强制规范 git 提交信息格式,安装 husky 并初始化钩子,配置 commitlint 使用 conventional commits 规则,挂载到 commit-msg 钩子拦截非法提交,并可选集成 commitizen 提供交互式提交降低门槛。

vue 3 项目怎么使用 husky 和 commitlint 规范 git 提交信息

Vue 3 项目中用 Husky + Commitlint 规范提交信息,核心是:让每次 git commit 都必须符合预设格式(比如 feat: 添加登录按钮),否则直接拦截。这不是“建议”,而是强制执行的工程纪律。

安装与初始化 Husky

确保项目已初始化 Git 仓库(git init)。推荐使用 pnpm(兼容性好、速度快):

  • 安装 Husky:pnpm add -D husky@7
  • 初始化钩子目录:npx husky install(生成 .husky/ 文件夹)
  • 注册 prepare 脚本(自动在 install 后运行):pnpm set-script prepare "husky install",再执行 pnpm run prepare

配置 Commitlint 检查规则

Commitlint 不自己定规矩,它靠规则集驱动。最常用的是 Conventional Commits 规范:

  • 安装依赖:pnpm add -D @commitlint/cli @commitlint/config-conventional
  • 创建配置文件 commitlint.config.mjs(注意后缀是 .mjs,适配 Vue 3 默认 ESM 环境):

export default { extends: ['@commitlint/config-conventional'] };

vue3-ant-design-vue-component-skill
vue3-ant-design-vue-component-skill

封装基于 Vue 3 + Ant Design Vue 的通用业务组件,提供标准化模板与最佳实践。

下载

该配置默认启用 featfixdocs 等标准类型,并要求 header 行不超过 72 字符。

把 Commitlint 挂到 commit-msg 钩子上

Husky 的 commit-msg 钩子会在提交信息写完、真正提交前触发,正是检查的最佳时机:

  • 执行命令:npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'
  • 这会在 .husky/commit-msg 中生成一行脚本,每次提交都调用 commitlint 校验你写的 message
  • 如果格式错误(如只写 fix 没冒号和描述),终端会报错并中止提交

(可选但推荐)搭配 Commitizen 降低使用门槛

手动写 feat(api): 优化请求超时逻辑 容易出错。用 Commitizen 提供交互式菜单,新手也能一次写对:

  • 安装:pnpm add -D commitizen cz-git
  • 创建 cz-config.mjs(内容含 type 列表、提示文案、跳过 body/footer 等)
  • package.json 中添加:"config": { "commitizen": { "path": "cz-git" } }
  • 之后提交改用:git add . && npx cz,全程键盘选择即可

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

相关专题

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

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

2023.08.11

2063

5

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

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

2023.10.09

4423

6

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

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

2024.03.19

5530

13

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

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

2024.03.22

4998

10

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

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

2024.05.22

703

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

1594

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

11642

5

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

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

2026.02.10

256

23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Vue 教程
Vue 教程

共42课时 | 16.7万人学习

国外Web开发全栈课程全集
国外Web开发全栈课程全集

共12课时 | 1.4万人学习

Vue.js 微实战--十天技能课堂
Vue.js 微实战--十天技能课堂

共18课时 | 1.6万人学习