Git Pro: git pre commit hook tool

[hhstore]

related:

• [x] Git Pro: #74
• [x] xxx

[hhstore]

Git Pre Commit Hook:

• Git 提交本地 check 工具
• 避免不规范的代码提交到 repo, 浪费 reviewer 的时间.

插件: pre-commit

• https://pre-commit.com/
• 这是个 Python 项目. 很方便.

安装:

• 不推荐 pip 安装, 除非特别了解 Python 的多版本管理(pyenv)

# 安装:
brew install pre-commit

curl https://pre-commit.com/install-local.py | python -

# 检查版本: 
pre-commit --version

使用:

• 项目中激活:

# 切换到项目根目录: 
cd project-root/

# 项目中激活: 
pre-commit install

配置文件:

• .pre-commit-config.yaml
• https://pre-commit.com/#plugins

[hhstore]

示例配置:

• https://github.com/better-go/cookiecutter-go/blob/master/mono-repo/gin/%7B%7Bcookiecutter.repo_name%7D%7D/.pre-commit-config.yaml

• https://github.com/better-go/cookiecutter-go/blob/master/mono-repo/gin/%7B%7Bcookiecutter.repo_name%7D%7D/.pre-commit-hooks.yaml

• 配置文件参考, 这个是 go 项目的. 直接拿走用.

完整示例项目:

• https://github.com/zeromicro/zeromall
• https://github.com/zeromicro/zeromall/blob/main/.pre-commit-config.yaml#L33
• https://github.com/zeromicro/zeromall/blob/main/.pre-commit-hooks.yaml#L12
• go 项目用例

[hhstore]

用法示例:

• 正常提交:

配置好 git-pre-commit-hook 之后, 每次 git commit, 都会自动做 check, 如果check 不过, 无法提交代码.

• 异常提交:

commit check 不通过 提示 hook 插件, 帮你 fmt 了, 你要重新 commit 一次.

[hhstore]

1

[hhstore]

xxxxxx:

xxxxxxxxxxxxxx	xxxxxxxxxxxxxx	xxxx
xxxxxxxxxxxxxx	xxxxxxxxxxxxxxxxxx	xxxxxxxxxx
xxxxxxxxxxxxxx	xxxxxxxxxxxxxxxxxx	xxxxxxxxxx
xxxxxxxxxxxxxx	xxxxxxxxxxxxxxxxxx	xxxxxxxxxx
xxxxxxxxxxxxxx	xxxxxxxxxxxxxxxxxx	xxxxxxxxxx
xxxxxxxxxxxxxx	xxxxxxxxxxxxxxxxxx	xxxxxxxxxx
xxxxxxxxxxxxxx	xxxxxxxxxxxxxxxxxx	xxxxxxxxxx
xxxxxxxxxxxxxx	xxxxxxxxxxxxxxxxxx	xxxxxxxxxx