介绍
在开发前端项目的过程中，代码的规范和一致性非常重要。而 git commit message 的规范化可以帮助我们更好地维护和管理版本控制，更加清晰地记录代码修改历史。@commitlint/config-patternplate 是一款方便实用的 npm 包，可以用于规范化 commit message。
安装
在安装 @commitlint/config-patternplate 之前，需要安装 commitlint-cli，确保 NPM 是最新版本：
npm install --save-dev @commitlint/config-patternplate commitlint-cli
使用教程
在使用前需要对 commitlint 进行配置。在根目录下新建文件 commitlint.config.js。
-- -------------------- ---- -------
-------------- - -
-------- ------------------------------------
------ -
--------------- --- -------- ----------------- ------------- -------------- ---------------
-------------------- --- --------- -----
------------- --- ---------
------------ -
--
---------
-
-------
------
-------
--------
-----------
-------
--------
---------
------
-------
--------
-----
--
--
--
--接下来就可以在代码提交时使用 commitlint 规范 commit message：
-- -------------------- ---- ------- -- ----- ----- -- ---- -- --- -- ----- ---- -- ------ -------------- -- --------- ------------------ -- ----- ---- -- ------ ------ -- ------- ----- ------ -- ----------- -- ----- --------- -- ------ --------------- -- --- - -- - -----------------------
示例代码
比如我们提交一个 commit：
git add . git commit -m "feat: 添加按需加载模块"
如果 commit message 符合规范，就可以正常提交代码。如果不符合规范，就会报错提示。
这个简单实用的 npm 包可以在团队开发中解决一些人为因素带来的问题，让代码更加规范化和清晰化。而使用它的具体方案，应该根据团队的实际情况做出适宜改变。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/94245