GH

Git Hooks 生成器

提交前的最后一道闸门,脚本可复制即用


                

如何使用本工具

  1. 选钩子类型:提交前查文件选 pre-commit,查提交信息选 commit-msg,推送前拦截选 pre-push。
  2. 勾上要拦的检查项。调试语句、冲突标记、大文件默认开,行尾空白和末尾换行看团队习惯。
  3. 选安装方式。原生 .git/hooks 零依赖;husky 适合前端项目,跟着 npm 依赖走。
  4. 复制脚本存到对应路径,然后 chmod +x 给执行权限——少了这一步钩子不会跑。
  5. commit-msg 模式还能先填一条提交信息试跑,看规则会不会把自己拦住,再决定宽度。

常见问题

Q:钩子加了但没生效?

A:九成是没给执行权限。Git 只执行可执行的钩子文件,没有 +x 位就静默跳过。跑 chmod +x .git/hooks/pre-commit 就行。另外注意路径是 .git/hooks 单数 hook,不是 hooks,也有人把它写成 .git/hook。

Q:.git/hooks 里的脚本会被提交到仓库吗?

A:不会。.git 目录本身就不进版本库,所以每个人的钩子要各自装一遍。团队要统一就得用 husky、pre-commit(Python 生态)或 lefthook 这类工具,它们把钩子配置放在仓库里,装依赖时自动挂到 .git/hooks。

Q:怎么临时跳过钩子?

A:git commit --no-verify 跳过 pre-commit 和 commit-msg,git push --no-verify 跳过 pre-push。这是设计好的逃生口,但别养成习惯——跳过等于把校验让给了 CI,而 CI 反馈慢得多。

Q:pre-commit 为什么只查暂存区?

A:因为提交的只有暂存区。如果拿工作区全量文件去查,git add -p 只挑了一部分改动时,你会被自己没打算提交的代码拦住,或者反过来漏掉问题。git diff --cached --name-only --diff-filter=ACM 正好是这次要进仓库的文件集合,ACM 是新增、复制、修改,删除的文件不用查。

Q:大文件检查为什么按字节而不是按行?

A:因为要拦的通常是二进制资源——图片、视频、数据集、编译产物。这些文件 git 存进对象库后基本删不掉,仓库体积会永久膨胀。真要放就上 Git LFS,或者干脆放对象存储。视频、字体、模型权重是最常见的三个误提交对象。

Q:Conventional Commits 的 ! 是什么?

A:表示破坏性变更,比如 feat(api)!: 移除 v1 接口。等价于在正文里写 BREAKING CHANGE: 说明。语义化版本工具靠这个标记决定要不要升主版本号。只写 feat 不写 !,发布工具就只会升次版本。

Q:husky v9 和 v8 有什么区别?

A:v9 简化了初始化:npx husky init 直接生成 .husky/pre-commit,不再需要 npx husky add,脚本里也不再需要那两行 husky.sh 的 source。所以 v8 的老脚本粘进 v9 会报找不到 husky.sh。

Q:pre-push 里跑测试会不会太慢?

A:会,所以只跑快的。单元测试几十秒可以接受,端到端测试几分钟就让人想加 --no-verify 了。更合理的分层是:pre-commit 查格式和明显错误(亚秒级),pre-push 跑单元测试和类型检查(十秒级),CI 跑全量。