前端工程化-husky+commitizen+ 自定义cz-customizable适配器 git 提交代码规范化

最新推荐文章于 2025-01-19 09:30:35 发布

Quentin_zhao

最新推荐文章于 2025-01-19 09:30:35 发布

阅读量4.7k

点赞数 1

CC 4.0 BY-SA版权

分类专栏：学习笔记文章标签：前端 git javascript

本文链接：https://blog.youkuaiyun.com/Chameleon_zhao/article/details/118546305

该博客详细介绍了如何通过husky、commitizen和cz-customizable来规范前端项目的git提交信息。首先，通过husky安装并设置git hooks，接着添加commitlint进行提交信息的校验，然后在项目级别安装commitizen并配置cz-conventional-changelog，最后讲解如何自定义提交规范，以确保代码提交符合预设的规则。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

1、使用husky添加git hooks（基于husky新版6.0.0进行git hooks）

1、npm install husky --save-dev
2、在package.json中添加prepare脚本

“prepare”: “husky install” 在这里插入图片描述
3、执行npm run prepare，本地会创建.husky目录

4、添加git hooks —（如果不需要git提交进行其他操作，直接跳过）
创建一条 pre-commit hook


npx husky add .husky/pre-commit "npm run test"

会在.husky下找到这个文件，此处可以执行命令
在这里插入图片描述
6，添加commit-msg钩子，规范commit message信息

npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'

创建了hook之后，在每次执行 git commit 时，都会先触发hook，来执行指定命令

2、添加commitlint校验

1，添加对应约束，防止随意提交

npm install --save-dev @commitlint/config-conventional @commitlint/cli

2，在项目根目录下建立配置文件 .commitlint.config.js

module.exports = {
   
   
    extents:[
        "@commitlint/config-conventional"
    ],
    rules:{
   
   
        'body-leading-blank': [1, 'always'],
        'footer-leading-blank': [1, 'always'],
        'header-max-length': [2, 'always', 72],
        'scope-case': [2, 'always', 'lower-case