很多开发者在提交 Git 代码时都有使用规范化的 commit message 的习惯，以方便后期代码维护及回退。但是如果不同的开发者习惯不同，规范不同，就会导致提交信息的混乱。这时就需要一个工具来规范化这些提交信息，这就是 validate-git-commit-message 工具。
validate-git-commit-message 是一个用来检查 commit message 的格式是否符合规范的 npm 包，它可以检测出 message 格式不正确的情况，从而提醒开发者使用规范的 commit message。
本文介绍了如何使用 validate-git-commit-message 工具来检测 Git commit message 的规范化情况，并提供了示例代码和实践案例。
安装
使用 npm 镜像源安装 validate-git-commit-message：
npm install validate-git-commit-message --save-dev
使用方法
在项目根目录创建一个 .validate_git_commit_msg.js 文件并写入以下代码：
const validateCommitMessage = require('validate-git-commit-message');
const commitMsgFilePath = process.argv[2];
const commitMsgFileContents = fs.readFileSync(commitMsgFilePath, 'utf8');
validateCommitMessage(commitMsgFileContents.trim());这个文件的作用是读取在 Git 中提交的 commit message 文件，并验证其格式是否符合规范。
并在 package.json 文件中添加 commit-msg 钩子：
-- -------------------- ---- -------
-
------- -------------
---------- --------
---------- -
------- ----- -------- -- ---- ----------- -- ---- --
--
-------- -
-------- -
------------- ----- --------------------------- ---
-
--
------------------ -
------------------------------ --------
-
-其中 husky 是一个为 Git 提供钩子的工具，它提供了一个 commit-msg 钩子来验证提交信息的格式是否符合规范。
这样，当你通过 git commit 提交代码时，validate-git-commit-message 会自动检测 commit message 的格式是否符合规范化要求。
示例代码
下面是一些符合规范化要求的 commit message 格式示例：
-- -------------------- ---- ------- ----- -------- ---- ----- --- ----- ---------- ----- ---- ----- ------ --------- -------- ------ ----- ------ ---- ------ ------------ --- -----------
如果 commit message 不符合规范化，validate-git-commit-message 会提示提交信息修改后再次提交。
实践案例
应用 validate-git-commit-message 工具可以巨大提高代码开发维护的效率、降低维护成本和避免不必要的错误和风险等。
在一些大型项目中，所有提交必须遵守特定的 commit message 格式，而不仅仅是一个习惯。因此在项目中使用 validate-git-commit-message 工具就显得尤为重要。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055eaf81e8991b448dc3bf