一、git commit 规范
常见规范:angular 提交规范 - 约定式规范
二、使用 commitizen
1.全局安装 commitizen
npm install -g commitizen@4.2.4
2.在项目中安装 cz-customizable 插件
(1)安装cz-customizable插件
(2)在package.json中添加配置
"config":{
"commitizen":{
"path" : "node_modules/cz-customizable"
}
}
(3)在项目根目录中添加.cs-config.js文件
module.exports = {
//可选类型
types:[],
//步骤
message:[]
}
可选类型:
步骤
可以通过配置来跳过某些步骤
三、使用过程
1.通过命令行弹出界面操作来提交符合规范的内容
完成界面操作后,会显示规范的提交内容
git log查看提交记录
三、使用git hooks来校验提交规范
git hooks是git 钩子函数,可以进行一些操作,例如提交规范和代码检查
commit-msg:用来规范提交标准格式,指定是否拒绝本次提交
pre-commit:提交前调用,(可用于代码检查)可以指定是否拒绝本次提交
1.commitlint - 提交规范检验工具
(1)安装commitlint依赖
(2)创建commitlint.config.js文件
(3)增加配置项
2.husky - git hooks工具
(1)安装husky
(2)创建.husky文件夹
(3)在package.json中生成并执行prepare命令
(4)在.husky文件夹中,添加commit-msg文件夹,在commit-msg钩子函数中使用commitlint进行提交规范校验
commit-msg文件代码
不规范的commit会报错并终止提交