Git Hooks：提交前自动拦截低级错误

Git Hooks 是什么

Git Hooks 是 Git 版本控制系统中的一种机制，允许开发者在特定 Git 事件发生时自动触发自定义脚本。这些脚本可以拦截或修改 Git 的操作流程，比如在提交代码前运行检查、在推送代码前执行测试等。Git Hooks 存储在项目的 .git/hooks 目录下，默认包含一些示例脚本（如 pre-commit.sample），去掉 .sample 后缀即可启用。

为什么要在提交前拦截低级错误

低级错误如拼写错误、未使用的变量、错误的缩进、缺少分号等，虽然不会直接导致程序崩溃，但会影响代码的可读性和维护性。如果这些错误进入代码库，可能会在后续开发中引发更严重的问题。通过 Git Hooks 在提交前自动拦截这些错误，可以确保代码库始终保持高质量。

常见的低级错误类型

1. 语法错误

比如 JavaScript 中缺少括号、引号不匹配等。这类错误会导致代码无法运行。

// 错误示例：缺少右括号
function sayHello() {
  console.log("Hello, world!";
}

2. 未使用的变量

定义了变量但未使用，可能是代码残留或逻辑错误。

// 错误示例：未使用的变量
const unusedVar = "This is not used";
function doSomething() {
  console.log("Doing something");
}

3. 代码风格问题

比如缩进不一致、行尾缺少分号等。虽然不影响运行，但会影响团队协作。

// 错误示例：缩进不一致
function badIndent() {
console.log("This is badly indented");
}

4. 调试代码残留

比如提交了 console.log 或调试断点。

// 错误示例：调试代码残留
function calculateSum(a, b) {
  console.log("Calculating sum..."); // 不应提交的调试代码
  return a + b;
}

如何用 Git Hooks 拦截错误

1. 使用 pre-commit Hook

pre-commit 钩子在提交前触发，可以在此阶段运行代码检查工具。

示例：用 ESLint 检查代码

首先安装 ESLint：

npm install eslint --save-dev

然后在 .git/hooks/pre-commit 中写入以下脚本：

#!/bin/sh

# 运行 ESLint 检查
echo "Running ESLint..."
eslint .

if [ $? -ne 0 ]; then
  echo "ESLint found errors. Please fix them before committing."
  exit 1
fi

2. 使用 commit-msg Hook

commit-msg 钩子可以检查提交信息是否符合规范，比如是否包含 JIRA 任务号。

示例：检查提交信息格式

#!/bin/sh

# 检查提交信息是否包含 JIRA 任务号
if ! grep -qE '^[A-Z]+-[0-9]+' "$1"; then
  echo "Commit message must include a JIRA task number (e.g., PROJ-123)."
  exit 1
fi

3. 使用 Husky 简化 Hook 管理

手动管理 Git Hooks 比较麻烦，可以使用 Husky 工具简化流程。

安装 Husky

npm install husky --save-dev
npx husky install

添加 pre-commit Hook

npx husky add .husky/pre-commit "npm run lint"

实际案例：拦截常见错误

案例 1：拦截未使用的变量

配置 ESLint 规则 no-unused-vars，并在 pre-commit 中运行检查。

.eslintrc.json：

{
  "rules": {
    "no-unused-vars": "error"
  }
}

案例 2：拦截调试代码

使用 ESLint 的 no-console 规则禁止提交 console.log。

.eslintrc.json：

{
  "rules": {
    "no-console": "error"
  }
}

案例 3：拦截拼写错误

使用 cspell 工具检查拼写错误。

安装：

npm install cspell --save-dev

pre-commit 脚本：

#!/bin/sh

echo "Running spell check..."
npx cspell "**/*.{js,jsx,ts,tsx}"

if [ $? -ne 0 ]; then
  echo "Spell check failed. Fix errors before committing."
  exit 1
fi

高级用法：结合多个工具

可以结合 ESLint、Prettier、TypeScript 等工具进行全面检查。

示例：综合检查脚本

#!/bin/sh

echo "Running checks..."

# 1. 运行 ESLint
eslint .
if [ $? -ne 0 ]; then
  exit 1
fi

# 2. 运行 TypeScript 类型检查
tsc --noEmit
if [ $? -ne 0 ]; then
  exit 1
fi

# 3. 运行单元测试
npm test
if [ $? -ne 0 ]; then
  exit 1
fi

注意事项

1. 性能问题：如果项目很大，运行检查可能会很慢。可以通过只检查暂存区的文件来优化：

   git diff --cached --name-only | grep -E '\.(js|jsx|ts|tsx)$' | xargs eslint
   

2. 灵活性：有时需要临时跳过检查，可以通过 --no-verify 选项绕过：

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

3. 团队协作：Git Hooks 默认不会同步到远程仓库，需要借助 Husky 或其他工具确保团队成员统一配置。