Git自动化利器：使用Node.js脚本定制化提交消息处理

说在前面

Git Hooks是Git版本控制系统中的一种机制，它允许开发人员在特定的Git操作（如提交、合并、推送等）前或后注入自定义的脚本和功能。这些钩子脚本可以用于自动化代码检查、测试运行、日志记录等操作，从而帮助团队维持代码质量、规范性和工作流程的一致性。

Git Hooks主要分为客户端钩子和服务器端钩子两种类型。客户端钩子包括pre-commit（提交前）、prepare-commit-msg（准备提交消息时）、post-commit（提交后）等，而服务器端钩子包括pre-receive（接收前）、update（更新时）、post-receive（接收后）等。

通过合理利用Git Hooks，开发团队可以实现诸如代码风格检查、单元测试自动运行、提交消息规范化等自动化操作，从而增强团队的协作效率和代码质量管理能力。Git Hooks的作用不仅仅局限于个人开发，对于团队协作和持续集成（CI）也有着重要的意义。

一、编写Node.js脚本实现自定义提交消息处理

当你使用 Git 提交代码时，可以通过 Node.js 脚本对提交消息进行自定义处理。下面是一个简单的示例，演示了如何编写一个 Node.js 脚本来实现自定义提交消息的处理：

const fs = require('fs');
const child_process = require('child_process');
// 获取提交消息文件路径
const commitMsgFile = process.argv[2];
// 读取提交消息内容
let commitMsg = fs.readFileSync(commitMsgFile, 'utf8');
// 在提交消息末尾添加自定义内容
commitMsg += '\n自定义内容：这是一个自定义提交消息';
// 将处理后的提交消息写回文件
fs.writeFileSync(commitMsgFile, commitMsg, 'utf8');
// 输出处理后的提交消息
console.log('处理后的提交消息：', commitMsg);
// 提交处理后的提交消息
child_process.execSync('git commit --file=' + commitMsgFile);

上述示例中，我们首先使用 fs 模块读取了提交消息文件的内容，然后对提交消息进行自定义处理，这里我们简单地在提交消息的末尾添加了一行自定义内容。接着使用 fs 模块将处理后的提交消息重新写入提交消息文件中。最后，我们调用 child_process 模块的 execSync 方法执行 git commit 命令，提交处理后的提交消息。

需要注意的是，这只是一个简单的示例，实际应用中你可能需要根据自己的需求对提交消息进行更复杂的处理。另外，对于提交消息的处理涉及到版本控制，务必谨慎操作，避免意外提交不符合预期的内容。

二、整合Node.js脚本与Git Hooks，实现自动化提交消息处理

• 1、创建Node.js脚本：首先编写一个Node.js脚本，用于处理提交消息。示例脚本如下（假设文件名为custom-commit-msg.js）：

const fs = require('fs');
// 获取提交消息文件路径
const commitMsgFile = process.argv[2];
// 读取提交消息内容
let commitMsg = fs.readFileSync(commitMsgFile, 'utf8');
// 在提交消息末尾添加自定义内容
commitMsg += '\n自定义内容：这是一个自定义提交消息';
// 将处理后的提交消息写回文件
fs.writeFileSync(commitMsgFile, commitMsg, 'utf8');

• 2、设置Git提交消息钩子：在Git仓库的.git/hooks目录下，找到commit-msg钩子文件（如果不存在，可以新建）。编辑commit-msg文件，添加以下内容：

#!/bin/sh
node /path/to/custom-commit-msg.js "$1"

确保替换/path/to/custom-commit-msg.js为你实际的Node.js脚本路径。

• 3、设置钩子文件权限：在终端中进入.git/hooks目录，并执行以下命令设置commit-msg文件的执行权限：

chmod +x commit-msg

这样，当你进行Git提交操作时，Git将会自动调用commit-msg钩子，并执行Node.js脚本来处理提交消息。在示例中，我们简单地在提交消息末尾添加了一行自定义内容，你可以根据实际需求对提交消息进行更复杂的处理。

三、实战，根据git分支名自动关联对应issue

#!/usr/bin/env node
const child_process = require("child_process");
const fs = require("fs");
//获取入参
process.argv.shift();
const commit_msg_filepath = process.argv[1];
const commit_type = process.argv[2] || "";
const commit_hash = process.argv[3] || "";
console.log("Type: ", commit_type, "\nHash:", commit_hash);
const command = "git symbolic-ref --short HEAD";
const trimReg = /(\ +)|([ ])|([\r\n])/g;
let branch = child_process.execSync(command).toString().replace(trimReg, "");
if (branch.startsWith("issue-")) {
  console.log("On issue branch:", branch);
  const reg = /(.*)-([0-9]*)$/;
  let result = branch.match(reg);
  let issue_number = result[2];
  let content = fs.readFileSync(commit_msg_filepath);
  fs.writeFileSync(commit_msg_filepath, `${content}#${issue_number}`);
}
process.exit(0);

1、获取入参

脚本首先通过process.argv获取Git提交时传入的参数，包括提交消息的文件路径、提交类型和提交哈希值等信息。

2、获取当前分支

脚本通过调用"git symbolic-ref --short HEAD"命令获取当前的Git分支名称，从而判断当前是否处于特定的分支上。

3、分支判断和处理

如果当前分支名称以"issue-"开头，脚本会提取出问题编号，并将其添加到提交消息的末尾。

4、写入提交消息

脚本使用fs.readFileSync读取提交消息的内容，然后使用fs.writeFileSync将处理后的提交消息内容写回到提交消息文件中。

5、退出脚本

最后，脚本调用process.exit(0)退出，并返回状态码0。

四、安全性和最佳实践注意事项

在设置自动化提交消息处理时，确保遵循以下安全性和最佳实践注意事项：

1、输入验证

在Node.js脚本中，对从提交消息文件读取的内容进行必要的输入验证，确保不会因为恶意输入导致安全漏洞。

2、错误处理

在Node.js脚本中添加适当的错误处理机制，包括异常捕获和错误日志记录，以便及时发现和解决可能出现的问题。

3、权限控制

在设置Git钩子时，确保只有有权限的用户能够修改钩子脚本，避免未经授权的修改和执行。

4、日志记录

在Node.js脚本中添加日志记录功能，记录提交消息的处理过程和结果，以便跟踪处理情况和故障排查。

5、测试和验证

在部署自动化提交消息处理前，进行充分的测试和验证，确保脚本和钩子的功能符合预期，并且不会引入其他问题。

6、审查代码

在编写Node.js脚本和设置Git钩子时，进行代码审查，确保符合最佳实践和安全标准。

7、限制权限

确保只有受信任的用户能够执行Git提交操作，避免恶意提交消息处理脚本被执行。

8、定期审查

定期审查自动化提交消息处理的实现和运行情况，确保安全性和稳定性。

遵循这些安全性和最佳实践注意事项可以帮助你确保自动化提交消息处理的安全性和稳定性。

五、Git自动化定制化的未来展望

未来，Git自动化定制化有望在以下方面取得进展和发展：

1、更强大的钩子支持

Git可能会提供更多类型的钩子，以支持更多不同的自动化定制化需求，比如在合并分支时自动运行特定脚本、提交代码前进行格式检查等。

2、集成机器学习和自然语言处理

通过机器学习和自然语言处理技术，Git可以实现智能化的提交消息处理，比如自动识别提交消息中的问题和任务，并将其关联到对应的问题跟踪系统中。

3、可视化自动化配置界面

提供可视化的界面来配置和管理自动化定制化需求，降低用户的技术门槛，使更多的开发者可以方便地定制他们的Git操作流程。

4、与持续集成/持续部署工具的集成

进一步整合Git与持续集成/持续部署工具，实现更深层次的自动化流程，比如在特定分支合并后自动触发持续集成流程。

5、安全性和审计功能加强

加强Git自动化定制化功能的安全性和审计功能，确保对于自动化定制化操作的可追溯性和可审计性。

6、更丰富的插件生态

支持更丰富的插件生态，让开发者可以根据自己的需求选择和定制更多的自动化定制化功能。

总的来说，未来Git自动化定制化有望变得更加智能、便捷和安全，为开发者提供更好的工作体验和效率。随着技术的不断进步和开发者需求的不断演变，Git自动化定制化将会不断拓展其功能和适用范围。

源码地址

gitee：https://gitee.com/zheng_yongtao/jyeontu-templates.git

公众号

关注公众号『前端也能这么有趣』，获取更多新鲜内容。

说在后面

🎉 这里是 JYeontu，现在是一名前端工程师，有空会刷刷算法题，平时喜欢打羽毛球 🏸 ，平时也喜欢写些东西，既为自己记录 📋，也希望可以对大家有那么一丢丢的帮助，写的不好望多多谅解 🙇，写错的地方望指出，定会认真改进 😊，偶尔也会在自己的公众号『前端也能这么有趣』发一些比较有趣的文章，有兴趣的也可以关注下。在此谢谢大家的支持，我们下文再见 🙌。