一、git commit 规范

常见规范:angular 提交规范 - 约定式规范

1644204474(1).jpg

二、使用 commitizen

通过使用git cz 来代替git commit
image.png

1.全局安装 commitizen

  1. npm install -g commitizen@4.2.4

2.在项目中安装 cz-customizable 插件

(1)安装cz-customizable插件

(2)在package.json中添加配置
  1. "config":{
  2. "commitizen":{
  3. "path" : "node_modules/cz-customizable"
  4. }
  5. }

(3)在项目根目录中添加.cs-config.js文件
  1. module.exports = {
  2. //可选类型
  3. types:[],
  4. //步骤
  5. message:[]
  6. }

可选类型:
1644204603(1).jpg
步骤
image.png
可以通过配置来跳过某些步骤
image.png

三、使用过程
1.通过命令行弹出界面操作来提交符合规范的内容image.png
image.png
完成界面操作后,会显示规范的提交内容
image.png
git log查看提交记录
image.png

三、使用git hooks来校验提交规范

git hooks是git 钩子函数,可以进行一些操作,例如提交规范代码检查
image.png
commit-msg:用来规范提交标准格式,指定是否拒绝本次提交
pre-commit提交前调用,(可用于代码检查)可以指定是否拒绝本次提交

1.commitlint - 提交规范检验工具

(1)安装commitlint依赖

(2)创建commitlint.config.js文件

(3)增加配置项

image.png
image.png

2.husky - git hooks工具

image.png

(1)安装husky

(2)创建.husky文件夹

(3)在package.json中生成并执行prepare命令

(4)在.husky文件夹中,添加commit-msg文件夹,在commit-msg钩子函数中使用commitlint进行提交规范校验

image.png
commit-msg文件代码
image.png
不规范的commit会报错并终止提交
image.png