在前端开发中，代码规范是非常重要的。使用 Git 提交代码时，遵循规范化的提交信息格式能够提高团队协作效率和代码可维护性。cz-customizable 是一个可以自定义提交信息模板的 npm 包，使得项目的提交信息格式更加清晰易读。
安装
可以通过 npm 进行全局或者局部安装：
# 局部安装 npm install cz-customizable --save-dev # 全局安装 npm install -g cz-customizable
使用
- 配置
package.json:
添加以下内容：
{
"config": {
"commitizen": {
"path": "./node_modules/cz-customizable"
}
}
}这将会告诉 commitizen 使用 cz-customizable 作为提交信息模板。
- 在项目根目录下创建
.cz-config.js文件，并添加以下内容：
-- -------------------- ---- -------
-------------- - -
------ -
- ------ ------- ----- ------ ----- --
- ------ ------ ----- ----- -- ---- --
- ------ ------- ----- ------ ----- --
- ------ -------- ----- ------- ------------------------ --
- ------ ----------- ----- ---------- ------------------- --
- ------ ------- ----- ------ ----- --
- ------ ------- ----- ------ ----------------- --
- ------ -------- ----- ------- ----------------- --- - ---- ---- --
- ------ --------- ----- -------- -------- -
--
-- ----------- -----
------- -
- ----- --------- --
- ----- ---------- --
- ----- -------- -
--
-- --- ---------------------
--------- -
----- --------------
------ ------------ -------
------------ ------------
-------- -------
----- ---------------------
--------- --------- ------------------
------- ----------------------
-------------- ---------
--
-- ------- -------- ------- ------
--------------------- -------- -------
-- -------------------
------------- -
---- ----
----- ----
------ ----
--------- ----
----- ----
----- ----
----- ----
------ ----
------- ---
-
--- 运行
npm run commit：
npm run commit
这将会启动 commitizen，让你输入提交信息。
示例代码
比如我们新增了一个登录页面，可以这样提交：
-- -------------------- ---- ------- - --- --- ------ ---------------------- ------------------------------- - ----------- ----- ---- - --------- ----- -------- - ---- ------ - ---------------- - ------------------------ - - -------- -------------- - - ----------------- --------------- ------ ------------------------
总结
通过使用 cz
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/44166