Vue 3 项目初始化怎么配置 Commitlint 提交规范

秋敏同学_2628

秋敏同学_2628

2026-11-14

923人浏览

原创

Vue 3 项目配置 Commitlint 的核心是通过 husky 的 commit-msg 钩子自动校验提交信息是否符合 Conventional Commits 标准(如 feat:、fix: 等),需安装 @commitlint/cli 和 @commitlint/config-conventional,创建 commitlint.config.mjs 并配置 type-enum 等规则,再用 npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"' 接入钩子,推荐搭配 cz-git + Commitizen 实现交互式提交。

vue 3 项目初始化怎么配置 commitlint 提交规范

Vue 3 项目初始化时配置 Commitlint 提交规范,核心是让每次 git commit 前自动校验提交信息是否符合 Conventional Commits 标准(如 feat:、fix: 等前缀),避免随意填写的 commit message 污染历史记录。

安装并初始化 Commitlint

使用 pnpm(推荐)执行:

  • pnpm add @commitlint/cli @commitlint/config-conventional -D
  • 在项目根目录新建 commitlint.config.mjs(注意是 .mjs,适配 Vue 3 默认的 ESM 环境):
export default {
  extends: ['@commitlint/config-conventional'],
  rules: {
    'type-enum': [
      2,
      'always',
      ['feat', 'fix', 'docs', 'style', 'refactor', 'perf', 'test', 'chore', 'revert', 'build']
    ],
    'subject-empty': [2, 'never'],
    'header-max-length': [2, 'always', 72],
    'scope-case': [0],
    'subject-case': [0]
  }
};

接入 Husky 的 commit-msg 钩子

Commitlint 本身不自动运行,需通过 Husky 在提交时触发:

Springboot Vue Builder
Springboot Vue Builder

从零开始编排 SpringBoot+Vue 全栈项目工作流,适用于新建全栈项目或完整脚手架请求,触发后依次调用 product‑spec‑builder(需求调研)等模块。

下载
  • 确保已安装并初始化 Husky(如未配置,先运行 npx husky-init && pnpm install)
  • 添加 commit-msg 钩子:npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'
  • 该命令会在 .husky/commit-msg 文件中写入校验逻辑,每次 git commit 都会读取并验证 $1(即 COMMIT_EDITMSG 文件路径)

搭配 Commitizen + cz-git 实现交互式提交(可选但推荐)

手动写规范格式易出错,建议同步配置交互式提交工具:

  • 安装:pnpm add commitizen cz-git -D
  • 在项目根目录创建 cz-config.mjs,定义类型、提示文案和跳过项(如跳过 body 和 footer)
  • 在 package.json 中添加脚本:"commit": "cz"
  • 之后用 npm run commit 或 pnpm commit 替代 git commit -m,自动引导选择 type、scope、subject 等

验证是否生效

完成配置后测试:

  • 执行 git add . 后运行 git commit -m "test: something" → 应被拒绝(因 test 不在 type 白名单中)
  • 改用 git commit -m "feat: add login button" → 应成功提交
  • 若使用 Commitizen,运行 pnpm commit 应出现菜单选择界面

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

相关文章

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

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

下载

相关标签:

vue.js vue vue 3

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

相关专题

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

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

2023.08.11

3003

5

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

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

2023.10.09

6583

6

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

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

2024.03.19

7430

13

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

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

2024.03.22

7338

10

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

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

2024.05.22

1043

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

1774

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

12642

5

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

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

2026.02.10

336

23

热门下载

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

精品课程

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

共42课时 | 17.5万人学习

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

共12课时 | 1.4万人学习

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

共18课时 | 1.7万人学习