简介
Git 是开发者日常使用最为频繁的工具之一，而 git commit message 则是重要的开发文档，标准的 commit message 可以方便日后的维护和查阅。然而，不同开发者对于 commit message 的书写习惯不同，导致项目的 commit message 风格不统一。为了解决这个问题，我们可以使用 git-linter 这个 NPM 包。
git-linter 是一款 Git commit message 校验工具，可以帮助程序员强制遵守 commit message 的书写规范，从而使得 commit message 风格统一，有利于后期代码维护和阅读。git-linter 安装和使用都很简单，下面将对它的使用做一个介绍。
安装
使用 npm 进行安装：
npm install -g git-linter
使用
安装完成后，在使用 git commit 命令时，git-linter 会自动检查 commit message 是否符合规范。
git commit -m "add new feature" # 提交信息不符合规范，会提示错误信息 git commit -m "feat: add new feature" # 提交信息符合规范，通过提交
此时，如果 commit message 不符合规范，则会被标记为错误。
我们可以通过 git-linter --help 查看所有命令行参数。
-- -------------------- ---- ------- ------ ---------- --------- -------- --- --------- ------ --- ------- ------ --- ------------- ------ --- - -------- ------------- ---- --- ------- ------- --- ----- --------- ----- -- -------- -------- --- ------------ ----- --- ------- ---- ----- --- --- ------------- --- ------------------- -------- - --- -- ------ ----- ---- ----- ------------ --- ------ ------- ---- --- -------
其中， -f 参数可以用于指定 git-linter 的配置文件。
配置文件
git-linter 的配置文件相对简单，我们可以在项目中根目录下新建 .gitlinter.json 文件来配置自定义规则。示例如下：
-- -------------------- ---- -------
-
---------
------------------ --- --------- ----
------------ --- --------- -------- --------
-------------- --- ---------
-------------------- --- -------- -----
--------------- --- --------- -----------------
--------------------- --- ----------
----------------------- --- --------- ----
----------------------- --- ----------
------------------------- --- --------- ---
-
-其中，"type-max-length" 配置了 type 的最大长度； "type-enum" 规定了 type 合法的取值； "subject-full-stop" 规定了 subject 不以句号结尾等自定义规则。
总结
通过使用 git-linter，我们可以强制统一团队的 commit message 规范，从而使得代码更加清晰易懂。在开发过程中，我们应该遵守一些编码规范，并且注重项目的代码风格，这样有利于后期的代码维护和开发。最后，希望本篇文章能够对你有所启发，谢谢！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005591a81e8991b448d68bf