约定式提交规范 ,我们知道如果严格安装 约定式提交规范, 来手动进行代码提交的话,那么是一件非常痛苦的事情,但是 git 提交规范的处理 又势在必行,那么怎么办呢?
你遇到的问题,也是其他人所遇到的!
经过了很多人的冥思苦想,就出现了一种叫做 git 提交规范化工具 的东西,而我们要学习的 commitizen
就是其中的佼佼者!
commitizen
仓库名为 cz-cli ,它提供了一个 git cz
的指令用于代替 git commit
,简单一句话介绍它:
当你使用
commitizen
进行代码提交(git commit)时,commitizen
会提交你在提交时填写所有必需的提交字段!
这句话怎么解释呢?不用着急,下面我们就来安装并且使用一下 commitizen
,使用完成之后你自然就明白了这句话的意思!
-
全局安装
Commitizen
npm install -g commitizen@4.2.4
-
安装并配置
cz-customizable
插件-
使用
npm
下载cz-customizable
npm i cz-customizable@6.3.0 --save-dev
-
添加以下配置到
package.json
中... "config": { "commitizen": { "path": "node_modules/cz-customizable" } }
-
-
项目根目录下创建
.cz-config.js
自定义提示文件module.exports = { // 可选类型 types: [ { value: 'feat', name: 'feat: 新功能' }, { value: 'fix', name: 'fix: 修复' }, { value: 'docs', name: 'docs: 文档变更' }, { value: 'style', name: 'style: 代码格式(不影响代码运行的变动)' }, { value: 'refactor', name: 'refactor: 重构(既不是增加feature,也不是修复bug)' }, { value: 'perf', name: 'perf: 性能优化' }, { value: 'test', name: 'test: 增加测试' }, { value: 'chore', name: 'chore: 构建过程或辅助工具的变动' }, { value: 'revert', name: 'revert: 回退' }, { value: 'build', name: 'build: 打包' } ], // 消息步骤 messages: { type: '请选择提交类型:', customScope: '请输入修改范围(可选):', subject: '请简要描述提交(必填):', body: '请输入详细描述(可选):', footer: '请输入要关闭的issue(可选):', confirmCommit: '确认使用以上信息提交?(y/n/e/h)' }, // 跳过问题 skipQuestions: ['body', 'footer'], // subject文字长度默认是72 subjectLimit: 72 }
-
使用
git cz
代替git commit
使用git cz
代替git commit
,即可看到提示内容
那么到这里我们就已经可以使用git cz
来代替了 git commit
实现了规范化的提交诉求了,但是当前依然存在着一个问题,那就是我们必须要通过 git cz
指令才可以完成规范化提交!