使用husky和fabric规范git提交的注释

一、背景与意义

在项目开发过程中,有些开发人员有时提交git时注释写得很随意,不方便日后管理和问题回溯。对于JavaScript项目,可以使用husky和fabric规范git提交的注释。

二、引入git注释检查

在JavaScript项目中,安装husky和fabric:

bash 复制代码
npm install husky @umijs/fabric --save-dev

然后初始化husky:

bash 复制代码
npx husky install

运行上面的命令之后,会生成一个 .husky 目录,在 .husky 目录下创建一个commit-msg文件,其内容如下:

bash 复制代码
#!/usr/bin/env sh

# Export Git hook params
export GIT_PARAMS=$*

npx --no-install fabric verify-commit

然后使用git命令执行代码提交:

bash 复制代码
git add .
git commit -m 'test'

执行上述命令时,得到的输出如下:

显然,git注释规范已经生效。如果是按照规范的注释提交:

bash 复制代码
git commit -m 'feat: 引入husky与fabric对git注释做规范'

则可以提交成功。

三、解决代码合并时报错的问题

在合并代码时,其自动生成的注释并不符合规范,无法通过校验。

假设当前是master分支,我们创建一个新的分支:

bash 复制代码
git checkout -b new_branch1

然后随便添加一个提交:

bash 复制代码
echo '' > test.txt
git add .
git commit -m 'feat: first commit in new_branch1'

然后再切回原来的分支,添加一个提交:

bash 复制代码
git checkout master
echo '' > test2.txt
git add .
git commit -m 'feat: first commit in master'

接下来,如果做分支合并:

bash 复制代码
git merge new_branch1

将会报错:

为解决这个问题,需要在 .husky 目录下创建文件 prepare-commit-msg,其内容如下:

bash 复制代码
#!/bin/sh

case "$2" in
  merge)
    MERGING_BRANCH_SHA=$(cat ".git/MERGE_HEAD")
    MERGING_BRANCH_NAME=$(git name-rev --name-only "$MERGING_BRANCH_SHA")
    MERGE_TARGET=$(git rev-parse --abbrev-ref HEAD)

    cat > "$1" <<EOF
feat: 合并分支,将 "${MERGING_BRANCH_NAME}" 分支的内容合并到 "${MERGE_TARGET}" 分支
EOF
  ;;
esac

接下来 git merge new_branch1 执行时就不会报错,合并代码时,自动生成的注释为:

feat: 合并分支,将 "new_branch1" 分支的内容合并到 "master" 分支

相关推荐
涛涛ing7 分钟前
为了快 30 倍,我把构建工具换成了 Rust,结果团队差点连班都加不了
前端
parade岁月1 小时前
SolidJS 2.0 正式发布:异步成为响应式的一部分
前端
SimonKing1 小时前
给Deepseek Harness装上插件市场,从此插件无忧
java·后端·程序员
lcy_241 小时前
防抖节流、并发控制、指数退避重试——我把它收进了一个库 async-concurrency-kit
前端
程序员大阳1 小时前
副队长Vue3教程(5)--事件绑定 v-on
前端·javascript·vue.js·vue3·事件绑定·v-on
艾莉丝努力练剑1 小时前
【AI大模型接入SDK】C++的SessionManager 线程安全
java·开发语言·前端·c++·人工智能·学习·安全
泯泷2 小时前
Vercel AI SDK 6 完整教程系列 - 第二部分:结构化数据与工具调用
前端·javascript
利威尔xu2 小时前
Go Mutex 饥饿模式:正常模式等待者饿死,1ms 阈值自动切换崩溃
开发语言·后端·面试·golang·并发编程
一条Go2 小时前
边缘 Agent:为什么是它连出来,而不是平台连进去
后端·架构·github
huangfuyk2 小时前
前端融入/转后端避坑指南:AI 时代的安全边界、数据防线与实战细节
后端·ai编程