本质:git cz 相当于是一个对于 git commit 的提交命令的加强版
作用:使 git commit 规范化提交
安装:
第一步:
安装 Commitizen (Commitizen是一个格式化commit message的工具,git cz 是依赖于Commitizen )
npm install -g commitizen
hint:上述安装出错,可尝试通过以管理员身份运行 Windows PowerShell 安装。
第二步:
安装changelog,生成changelog的工具
npm install -g conventional-changelog conventional-changelog-cli
第三步:
在自己的项目目录下进行配置 (配置出现问题可以尝试使用管理员身份运行或者在结尾加上 --force 字段)
commitizen init cz-conventional-changelog --save-dev --save-exact
到这里我们就完成git cz的安装了。第一步和第二步每台设备(台式机,笔记本)只需要操作一次就可以了,第三步每个项目拉取下来都要操作一次。
最后就可以使用git cz代替git commit来提交专业的commit了。
![](https://img-blog.csdnimg.cn/img_convert/44c2cc26e5134402b865e5899274e4bc.png)
使用
commit message 提交后的记录格式如下
<type>(<scope>): <subject>
//例:<feat>(all): 修改baseurl
提交时用git cz 出现如下:
// 其中 type 的值可以有
# .feat: 新功能
# .fix: 修复bug
# .doc: 文档改变
# .style: 代码格式改变
# .refactor: 某个已有功能重构
# .perf: 性能优化
# .test: 增加测试
# .build: 改变了build工具 如 webpack换成了vite
# .revert: 撤销上一次的 commit
选择好了<type> 之后,需要描述<scope>此次修改的影响范围
// scope: 用来说明此次修改的影响范围
# all: 表示影响面大,如修改了网络框架,会对整个程序产生影响
# component: 修改了组件
# module: 表示会影响某个模块 如登录模块、首页模块、用户管理模块等等
# 文件名: 修改了某个文件
然后再添加<subject> 用来简要描述本次改动
# subject: 用来简要描述本次改动,如果是bug最好带上相应的bug编号
然后其他的可以按 enter 健忽略就行!