Skip to content

Pre-commit Hook

一句话解释

pre-commit 钩子是 Git 在提交定稿前运行的脚本,可在检查失败时拒绝提交。

用大白话说

pre-commit 钩子是 .git/hooks/pre-commit 中的脚本,Git 在提交定稿前运行。若脚本以非零状态退出,提交被中止。这让你在源头阻止坏提交——在它们进入共享历史之前。常见检查:lint(eslint、ruff)、格式化(prettier、black)、类型检查、密钥扫描(不提交 API key)、运行快速测试子集。钩子对暂存文件运行,在本地而非 CI 捕获问题。pre-commit(框架)与 husky 等工具跨团队管理钩子。.git/hooks 中的钩子是本地且不提交,因此团队用 husky + lint-staged(在 package.json)或 pre-commit 框架(在 .pre-commit-config.yaml)共享钩子配置。这确保每位贡献者提交前运行相同检查。

示例

bash
# .git/hooks/pre-commit (must be executable)
#!/bin/sh
# Lint staged files; abort commit on failure

files=$(git diff --cached --name-only --filter=ACM | grep "\.js$")
if [ -n "$files" ]; then
  npx eslint $files || { echo "lint failed"; exit 1; }
fi

# With husky + lint-staged (package.json):
# "lint-staged": { "*.js": ["eslint --fix", "git add"] }

钩子对暂存 .js 文件 lint。eslint 失败则 exit 1 中止提交。husky + lint-staged 跨团队共享。

相关术语

相关资源

相关课程

解读错误信息

用大白话解释常见错误——什么意思、为什么发生、如何修复。

查看错误

← 返回术语表