如何在pre-commit钩子中捕获ESLint错误码并阻止Git提交？

问题根源 #

你的脚本存在两个关键问题，导致ESLint无法正确检测错误并阻止提交：

1. 文件路径获取错误
   原命令git diff --name-only HEAD **/*.ts | xargs有两处缺陷：

   • **/*.ts是shell通配符，会被提前解析为当前目录下所有.ts文件，而非仅你要提交的暂存区文件
   • git diff --name-only HEAD对比的是工作区与HEAD的差异，而非暂存区与HEAD的差异，导致ESLint要么检测未add的文件，要么漏掉已add的问题文件
     最终ESLint没拿到有错误的目标文件，返回状态码0，脚本因此输出"Good"。

2. 退出码逻辑完全错误
   不管ESLint返回0（检测通过）、1（有错误/警告超标）还是2（致命错误），你的脚本都执行exit 2，这会阻止所有提交，同时错误的分支判断导致即使ESLint检测到错误，也不会触发对应的提示逻辑。

修正后的Pre-Commit脚本 #

替换.git/hooks/pre-commit中的内容为以下脚本：

#!/bin/bash

# 获取暂存区中所有.ts文件
TS_FILES=$(git diff --cached --name-only -- '*.ts')

# 若无.ts文件，直接允许提交
if [ -z "$TS_FILES" ]; then
    exit 0
fi

# 执行ESLint检测
npx eslint --max-warnings 1 --exit-on-fatal-error $TS_FILES

ESLINT_EXIT_CODE=$?

# 根据ESLint退出码处理提交逻辑
if [ $ESLINT_EXIT_CODE -eq 0 ]; then
    echo "ESLint检测通过，允许提交"
    exit 0
elif [ $ESLINT_EXIT_CODE -eq 1 ]; then
    echo "ESLint检测到错误或警告超标，阻止提交"
    exit 1
elif [ $ESLINT_EXIT_CODE -eq 2 ]; then
    echo "ESLint发生致命错误（如配置错误），阻止提交"
    exit 1
fi

关键说明 #

• git diff --cached --name-only -- '*.ts'：
  • --cached：仅获取已git add到暂存区的文件，精准对应即将提交的内容
  • --name-only：只输出文件名，避免多余干扰内容
  • -- '*.ts'：精确过滤.ts文件，防止shell提前解析通配符
• 空文件判断：如果暂存区没有.ts文件，直接允许提交，避免无意义的ESLint检测
• 正确的退出码处理：
  • 返回0：检测通过，exit 0允许提交
  • 返回1：存在错误/警告超过阈值，exit 1阻止提交
  • 返回2：ESLint配置错误等致命问题，exit 1阻止提交

验证步骤 #

1. 修改某个.ts文件，引入已知的ESLint错误（比如你示例中的default-case问题）
2. 执行git add将文件加入暂存区
3. 执行git commit，此时钩子会输出错误信息并阻止提交

内容的提问来源于stack exchange，提问作者Lance Pollard