简介
Commitizen 是一个用于规范化 Git commit 信息格式的工具,可以通过命令行交互的方式生成符合规范的 commit message。它是基于 AngularJS 团队的规范化提交约定(conventional commits)而开发的,使得我们可以轻松地遵循该标准来记录代码变更历史。
安装
在使用之前,需要先全局安装 Commitizen:
npm install -g commitizen
配置
配置 Commitizen 的方式有两种:
1. 使用预设配置
首先,需要为项目添加这个预设配置:
commitizen init cz-conventional-changelog --save-dev --save-exact
然后,在 package.json
文件中添加以下配置项:
{ "config": { "commitizen": { "path": "node_modules/cz-conventional-changelog" } } }
此时,在提交代码时,可以使用 git cz
命令代替 git commit
。
2. 自定义配置
Commitizen 支持自定义配置,可以按照自己的需求进行修改。只需要创建一个 cz-config.js
文件,然后在其中定义需要的配置项。例如:
-- -------------------- ---- ------- -------------- - - ------ - - ------ ------- ----- ------ ----- -- - ------ ------ ----- ----- -- ---- -- - ------ ------- ----- ------ ----- -- - ------ -------- ----- ------- ------ -- - ------ ----------- ----- ---------- ----- -- - ------ ------- ----- ------ ----- -- - ------ -------- ----- ------- ------------ -- - ------ --------- ----- -------- ----- -- -- ------------------ ----- --------------------- -------- ------- --
使用
使用 Commitizen 的方式非常简单,只需要执行 git cz
命令即可。根据配置的不同,会出现一系列交互式提示,按照提示填写相应信息即可。
例如:
-- -------------------- ---- ------- - --- -- - ------ --- ---- -- ------ ---- ------ ----------- ---- ----- ---- -- ---- -- ------- - ----- ---- ---- -- --- ----- ---- ------ ----- --------- ---- ----- ---- ------ ----------- ------- ---- - ---- -- --- ----- -- ---- ------ ----- --------- -- ---- ------ ------ ----- -- ----- ------------ - ----- - ------ ---------- ----- ----------- -- --- ------ ---- -- ------- --- ------- - - ------- - ------ ----------- -- --- ------- ------ ----- -- ----- ----- ------- - --- --------- ---- ---------- - --- ----- --- -------- -------- -- - ---- ---- ------ ------ --- ---- ------- --
当然,还可以通过参数的方式来直接提交符合规范的 commit message:
$ git cz -t feat -s my-component -m "add feature A"
总结
使用 Commitizen 可以规范化 Git commit 信息格式,使得代码变更历史更加清晰明了。通过本文的介绍,我们了解了如何安装、配置和使用 Commitizen,希望对大家有所帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/49611