cz-blvd
是一个方便优雅地约束前端开发者在 Git 提交信息中遵循 commitizen 标准格式的工具库。它可以自定义问题列表,帮助开发者提交规范的 commit message。
本文将带领大家了解 cz-blvd
的用法,并给出具体的使用示例。
安装
首先,我们需要通过 npm 安装 cz-blvd
:
npm install -g cz-blvd
配置
安装好 cz-blvd
之后,我们需要对其进行配置。我们可以在项目根目录中新建 .czrc
文件,添加以下内容:
{ "path": "cz-blvd" }
或者在 package.json
中添加以下配置:
{ "config": { "commitizen": { "path": "cz-blvd" } } }
这里我们选择使用 .czrc
文件的方式来配置。
使用
安装并配置好 cz-blvd
后,我们就可以使用它来生成规范的 commit message 了。
在使用 Git 提交代码时,可以直接使用以下命令进行提交:
$ git cz
这会弹出给定的问题列表,我们可以根据提示一步步回答,最终就会得到一个符合 commitizen 标准格式的 commit message。
自定义问题列表
默认情况下,cz-blvd
提供了一份默认的问题列表。如果我们需要自定义问题列表,可以在项目根目录下新建 .cz-config.js
文件,并可以按照以下格式来编写问题列表:
-- -------------------- ---- ------- -------------- - - ------ - - ------ ------- ----- ------ ------- -- - ------ ------ ----- ----- ---- ---- -- - ------ ------- ----- ------ ----- -- - ------ -------- ----- ------- ------------------ -- - ------ ----------- ----- ---------- --------- --- ------- -- - ------ ------- ----- ------ --------- -- - ------ ------- ----- ------ --------------- -- - ------ -------- ----- ------- ------------------ - -- --------- - ----- -------------- ------ -------------------- -------- --------------- ----- -------------------- --- -------- --------- ------------------------------ ------- --- ---- ----------------------- ----- -- ------------------ ----- -------------- -------- ----------- ---------- -- ----- ------- ------ ------------- --- --
自定义问题列表的格式与 commitizen
的问题格式是一致的,开发者可以根据自己的需求自由定义问题列表。
结尾
通过 cz-blvd
工具库,我们可以方便地约束开发者提交规范的 commit message,最终使得 Git 历史记录更加清晰易读。本文详细介绍了 cz-blvd
的安装、配置和使用,并给出了自定义问题列表的示例代码。
希望本文能够帮助到大家,更多 Git 相关的内容敬请关注后续文章。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055cb481e8991b448da22f