git-hooks

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Git Hooks Skill

Git Hooks 技能

When to Activate

适用场景

Activate this skill when:

Setting up pre-commit hooks
Configuring commit message validation
Installing secrets scanners
Enforcing code quality standards
Automating pre-push tests

在以下场景中启用本技能：

设置pre-commit钩子
配置提交信息验证
安装密钥扫描器
强制执行代码质量标准
自动化pre-push测试

Quick Installation

快速安装

bash

undefined

bash

undefined

Use interactive installer (recommended)

使用交互式安装程序（推荐）

./AgentUsage/pre_commit_hooks/install_hooks.sh

Or manual installation for Python project

或针对Python项目手动安装

cp AgentUsage/pre_commit_hooks/commit-msg .git/hooks/ cp AgentUsage/pre_commit_hooks/pre-commit-python .git/hooks/pre-commit cp AgentUsage/pre_commit_hooks/pre-commit-secrets-scanner .git/hooks/pre-commit-secrets cp AgentUsage/pre_commit_hooks/pre-push .git/hooks/ chmod +x .git/hooks/*

undefined

undefined

Available Hooks

可用钩子

Core Hooks (All Projects)

核心钩子（所有项目通用）

Hook	Purpose
`commit-msg`	Validates conventional commit format
`pre-commit-secrets-scanner`	Prevents leaked API keys/secrets

钩子	用途
`commit-msg`	验证符合规范的提交信息格式
`pre-commit-secrets-scanner`	防止API密钥/密钥泄露

Language-Specific

特定语言钩子

Hook	Language	Checks
`pre-commit-python`	Python	Black, Ruff
`pre-commit-javascript`	JS/TS	Prettier, ESLint, TypeScript
`pre-commit-go`	Go	gofmt, go vet
`pre-commit-multi-language`	Mixed	Auto-detects and runs appropriate tools

钩子	语言	检查内容
`pre-commit-python`	Python	Black, Ruff
`pre-commit-javascript`	JS/TS	Prettier, ESLint, TypeScript
`pre-commit-go`	Go	gofmt, go vet
`pre-commit-multi-language`	多语言混合	自动检测并运行对应工具

Automation Hooks

自动化钩子

Hook	Purpose
`pre-push`	Runs tests before push
`post-checkout`	Auto-updates dependencies on branch switch
`post-commit`	Shows commit summary and TODOs

钩子	用途
`pre-push`	推送前运行测试
`post-checkout`	切换分支时自动更新依赖
`post-commit`	显示提交摘要和待办事项

Hook Selection by Project

按项目类型选择钩子

bash

undefined

bash

undefined

Python Project

Python项目

commit-msg + pre-commit-python + pre-commit-secrets-scanner + pre-push

JavaScript Project

JavaScript项目

commit-msg + pre-commit-javascript + pre-commit-secrets-scanner + pre-push

Go Project

Go项目

commit-msg + pre-commit-go + pre-commit-secrets-scanner + pre-push

Multi-language

多语言项目

commit-msg + pre-commit-multi-language + pre-commit-secrets-scanner + pre-push

undefined

commit-msg + pre-commit-multi-language + pre-commit-secrets-scanner + pre-push

undefined

What Each Hook Does

各钩子功能说明

commit-msg

Validates commit message format:

bash

undefined

验证提交信息格式：

bash

undefined

Accepted formats

可接受的格式

feat: Add user authentication fix: Correct validation error docs(readme): Update installation

feat: 添加用户认证功能 fix: 修复验证错误 docs(readme): 更新安装说明

Rejected

不被接受的格式

Update files # No type feat add feature # Missing colon

undefined

Update files # 无类型标识 feat add feature # 缺少冒号

undefined

pre-commit-secrets-scanner

Scans for exposed secrets:

Anthropic API keys (
```
sk-ant-...
```
)
OpenAI API keys (
```
sk-...
```
)
AWS credentials (
```
AKIA...
```
)
GitHub tokens (
```
ghp_...
```
)
Hardcoded passwords

扫描是否存在暴露的密钥：

Anthropic API密钥 (
```
sk-ant-...
```
)
OpenAI API密钥 (
```
sk-...
```
)
AWS凭证 (
```
AKIA...
```
)
GitHub令牌 (
```
ghp_...
```
)
硬编码密码

pre-commit-python

bash

undefined

bash

undefined

Runs automatically on staged .py files

自动对已暂存的.py文件运行

uv run black --check $file uv run ruff check $file

undefined

uv run black --check $file uv run ruff check $file

undefined

pre-push

bash

undefined

bash

undefined

Runs before push

推送前运行

uv run pytest tests/ # or pnpm test, go test, cargo test

undefined

uv run pytest tests/ # 或pnpm test、go test、cargo test

undefined

Testing Hooks

测试钩子

bash

undefined

bash

undefined

Test pre-commit directly

直接测试pre-commit钩子

.git/hooks/pre-commit

Test with sample commit

使用示例提交测试

git add . git commit -m "test: verify hooks"

Run with debug output

带调试输出运行

bash -x .git/hooks/pre-commit

undefined

bash -x .git/hooks/pre-commit

undefined

Bypassing Hooks (Emergency Only)

跳过钩子（仅紧急情况使用）

bash

undefined

bash

undefined

Skip all hooks

跳过所有钩子

git commit --no-verify -m "Emergency fix"

Only use when:

仅在以下场景使用：

- Emergency production fixes

- 紧急生产修复

- Hook malfunction

- 钩子故障

- Intentional override

- 有意覆盖检查

undefined

undefined

Troubleshooting

故障排查

Hook Not Running

钩子未运行

bash

undefined

bash

undefined

Check existence

检查钩子是否存在

ls -l .git/hooks/

Fix permissions

修复权限

chmod +x .git/hooks/*

Check syntax

检查语法

bash -n .git/hooks/pre-commit

undefined

bash -n .git/hooks/pre-commit

undefined

Permission Denied

权限被拒绝

bash

chmod +x .git/hooks/*

bash

chmod +x .git/hooks/*

Failed Quality Checks

质量检查失败

bash

undefined

bash

undefined

Run tools manually

手动运行工具

uv run black --check . uv run ruff check .

Fix issues

修复问题

uv run black . uv run ruff check --fix .

Retry commit

重新提交

git commit -m "Your message"

undefined

git commit -m "Your message"

undefined

Missing Tools

缺少工具

bash

undefined

bash

undefined

Install code quality tools

安装代码质量工具

uv add --dev black ruff

Verify installation

验证安装

which black uv run black --version

undefined

which black uv run black --version

undefined

Custom Hook Configuration

自定义钩子配置

Modify pre-commit for Your Project

为你的项目修改pre-commit钩子

bash

#!/bin/bash

bash

#!/bin/bash

.git/hooks/pre-commit

Get staged Python files

获取已暂存的Python文件

FILES=$(git diff --cached --name-only --diff-filter=ACM | grep '.py$')

if [ -n "$FILES" ]; then # Run your tools uv run black --check $FILES || exit 1 uv run ruff check $FILES || exit 1 fi

exit 0

undefined

FILES=$(git diff --cached --name-only --diff-filter=ACM | grep '.py$')

if [ -n "$FILES" ]; then # 运行你的工具 uv run black --check $FILES || exit 1 uv run ruff check $FILES || exit 1 fi

exit 0

undefined