如何校验 commit message 是否符合规范，这有四种方式

沐爸muba

已于 2024-09-25 22:53:00 修改

阅读量1.4k

点赞数 32

分类专栏：前端工程化文章标签：前端

于 2024-07-25 11:38:44 首次发布

本文链接：https://blog.csdn.net/m0_37943716/article/details/140685527

版权

前端工程化专栏收录该内容

3 篇文章 0 订阅

订阅专栏

你好同学，我是沐爸，欢迎点赞、收藏、评论和关注！

Git Commit 规范是什么？

Git Commit 规范常常参考 Angular 社区提交规范，该规范规定 message 的提交须符合一定的格式，即：<type>: <subject>，type 为 commit 类别，subject 为简短描述。注意：冒号后面有空格，结尾不加句号（.）

type 只允许使用下面7个标识：

feat：新功能（feature）
fix：修补bug
docs：文档（documentation）
style：格式（不影响代码运行的变动）
refactor：重构（即不是新增功能，也不是修改bug的代码变动）
test：增加测试
chore：构建过程或辅助工具的变动

校验 Commit Message 的四种方式

如何规定统一的 commit message 格式？以下有四种方式：

第一种：后台设置

后台设置后，每次执行 git push 推送代码时，如果 commit message 不符合规范，则会报错。

1.码云 Gitee 后台设置：

2.Gitlab 设置：

第二种：手动修改.git中的hooks

将代码 clone 到本地后，将 .git/hooks 中的 commit-msg.sample 文件改为 commit-msg，然后配置以下内容：

#!/bin/sh
 
# 检查commit message是否符合规定的格式
 
# 提供commit-msg文件的路径作为参数
COMMIT_MSG_FILE=$1
 
# 定义commit message的正则表达式规则
COMMIT_MSG_PATTERN="^(feat|fix|docs|style|refactor|test|chore|ci)(\(.+\))?: .{1,100}"
 
# 读取commit message文件的内容
COMMIT_MSG=$(cat "$COMMIT_MSG_FILE")
 
# 使用正则表达式匹配commit message
if ! echo "$COMMIT_MSG" | grep -E -q "$COMMIT_MSG_PATTERN"; then
  echo "-------------------------------------------------------------------"
  echo "提交失败！commit message 不符合规范，请修改后重试"
  echo "请遵循格式：^(feat|fix|docs|style|refactor|test|chore|ci)(\(.+\))?: .{1,100}"
  echo "-------------------------------------------------------------------"
  exit 1
fi
 
# 如果commit message符合规定的格式，脚本返回0作为成功的退出码
exit 0

当然，正则和错误提示可以自定义。注意：因为 commit-msg 文件并不会提交，所以这种方式只会影响你自己本地仓库。

第三种：husky 结合 git hooks

Git Hooks，即Git 钩子，每个钩子对应一个 Git 操作，比如git commit、git push。husky 是 git hooks 工具，用于在 Git 操作前自动运行脚本，比如代码格式化。这有助于保持代码风格的一致性，提高代码的质量和可维护性。

安装 husky

npm i husky -D

初始化 husky

npx husky-init

初始化后会在根目录下生成个一个 .husky 目录，目录下有个 pre-commit 文件，文件中的命令会在 git commit 时执行。

生成hook commit-msg

npx husky add .husky/commit-msg

提示：add 命令已被禁用，运行以上命令可能会提示“add command is DEPRECATED”。解决方法是，可以将 .husky/_ 目录中的 commit-msg 文件拷贝到 .husky 目录下，将第二种方法中的 commit-msg 配置拷贝并粘贴到 .husky/commit-msg 文件的最下方。

将第二种方法中的 commit-msg 配置拷贝并粘贴到 husky/commit-msg 文件的最下方。

到这里就完成了，就是这么简单。