husky: git的各种拦截/git hooks

项目中经常用到的一个小工具

安装

# 基础包安装
yarn add husky --dev
npm pkg set scripts.prepare="husky install"
npm run prepare
# 添加命令
npx husky add .husky/post-merge "npm run build"

用法

添加 prepare 任务
添加 pre-commit 的 hook
做一个测试: 提交一条 message

# 添加 prepare 任务
npm pkg set scripts.prepare="husky install"
npm run prepare
# 添加 pre-commit 的hook
npx husky add .husky/pre-commit "npm test"
git add .husky/pre-commit
# 添加一个测试
git commit -m "Keep calm and commit"
# `npm test` will run every time you commit

创建自己的hook

其实这么一行就可以： npx husky add .husky/pre-commit “npm test”

# 添加 pre-commit 的hook
npx husky add .husky/pre-commit "npm test"
git add .husky/pre-commit
# 每次git pull的时候运行命令
npx husky add .husky/post-merge "npm run build"

问题

Linux 下可能出现的问题

部分 centos 系统里无法正常工作(原因不明zgmw-server)
可能原因: https://github.com/typicode/husky/issues/1241

其它的hook

git hooks	调用时机	说明
pre-applypatch	`git am` 执行前
applypatch-msg	`git am` 执行后
post-applypatch	`git am` 执行后	不影响`git am`结果
pre-commit	`git commit` 执行前	可以用`git commit --no-verify`绕过
commit-msg	`git commit` 执行前	可以用 `git commit --no-verify`绕过
post-commit	`git commit`执行后	不影响`git commit`的结果
pre-merge-commit	`git merge`执行前	可以用`git merge --no-verify`绕过。
prepare-commit-msg	`git commit`执行后，编辑器打开之前
pre-rebase	`git rebase`执行前
post-checkout	`git checkout`或`git switch`执行后	如果不使用`--no-checkout`参数，则在`git clone`之后也会执行。
post-merge	`git commit`执行后	在执行`git pull`时也会被调用
pre-push	`git push`执行前
pre-receive	`git-receive-pack`执行前
update
post-receive	`git-receive-pack`执行后	不影响`git-receive-pack`的结果
post-update	当 `git-receive-pack`对 `git push` 作出反应并更新仓库中的引用时
push-to-checkout	当`git-receive-pack` 对`git push`做出反应并更新仓库中的引用时，以及当推送试图更新当前被签出的分支且`receive.denyCurrentBranch`配置被设置为`updateInstead`时
pre-auto-gc	`git gc --auto`执行前
post-rewrite	执行`git commit --amend`或`git rebase`时
sendemail-validate	`git send-email`执行前
fsmonitor-watchman	配置`core.fsmonitor`被设置为`.git/hooks/fsmonitor-watchman`或`.git/hooks/fsmonitor-watchmanv2`时
p4-pre-submit	`git-p4 submit`执行前	可以用`git-p4 submit --no-verify`绕过
p4-prepare-changelist	`git-p4 submit`执行后，编辑器启动前	可以用`git-p4 submit --no-verify`绕过
p4-changelist	`git-p4 submit`执行并编辑完`changelist message`后	可以用`git-p4 submit --no-verify`绕过
p4-post-changelist	`git-p4 submit`执行后
post-index-change	索引被写入到`read-cache.c do_write_locked_index`后

cheatsheet

自己工作中的常用场景，利用 husky 完成

场景	代码
提交代码的时候，格式化(prettier)
拉完代码(post merge) 之后运行 build

添加 cz

https://medium.com/@rahgurung/how-to-use-the-latest-husky-8-with-commitizen-for-adding-git-hooks-to-your-projects-18227e477411

lint-staged

bash -c tsc --noEmit