讲师中心 微信公众号

工具推荐

视频效率加速
Laper
Laper

剧本策划到成片协作

updream

一键生成高质量推广成片

AniShort
AniShort

AI短剧协同制作平台

剧云
剧云

中文短剧剧本制作平台

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

秋敏同学_2628

秋敏同学_2628

发布时间:2026-11-14 10:04:05

|

923人浏览过

|

来源于php中文网

原创

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 应出现菜单选择界面

热门AI工具

更多
VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

Flowith
Flowith Hot

Flowith是一款基于画布和智能体工作流的 AI 协作工作空间。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

相关专题

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

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

3003

2023.08.11

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

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

6583

2023.10.09

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

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

7430

2024.03.19

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

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

7338

2024.03.22

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

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

1043

2024.05.22

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

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

1774

2023.07.17

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

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

12642

2024.02.23

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

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

336

2026.02.10

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

20

2026.11.12

热门下载

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

精品课程

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

共42课时 | 17.5万人学习

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

共12课时 | 1.4万人学习

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

共18课时 | 1.7万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn