如何通过Git Hook检测QDebug使用并阻止包含该代码的提交？

既然你已经懂Git Hook的部署，那直接上干货——我们可以用pre-commit钩子实现提交前的自动检查，拦截包含QDebug相关代码的提交，同时精准检测头文件里的#include <QDebug>语句。

一、编写pre-commit钩子脚本 #

Git的pre-commit钩子位于仓库的.git/hooks/目录下，默认有个示例文件pre-commit.sample，我们直接新建/修改pre-commit文件（注意不要加后缀），写入以下shell脚本：

#!/bin/bash

# 定义要检查的文件后缀（根据你的项目调整）
TARGET_EXTENSIONS=(".h" ".cpp" ".hpp" ".cxx")

# 获取本次提交的所有文件
STAGED_FILES=$(git diff --cached --name-only)

# 标记是否检测到违规
HAS_VIOLATION=0

# 遍历每个文件检查
for FILE in $STAGED_FILES; do
    # 跳过非目标后缀的文件
    FILE_EXT="${FILE##*.}"
    if [[ ! " ${TARGET_EXTENSIONS[@]/%/.${FILE_EXT}} " =~ " .${FILE_EXT} " ]]; then
        continue
    fi

    # 检查1：是否包含#include <QDebug>
    if grep -q "^#include <QDebug>" "$FILE"; then
        echo "❌ 错误：文件 $FILE 中包含禁止的#include <QDebug>"
        HAS_VIOLATION=1
    fi

    # 检查2：是否直接使用QDebug相关代码（比如qDebug()、QDebug::等）
    # 这里可以根据你的需求调整匹配规则，比如排除注释里的内容
    if grep -E -q "(qDebug\(|QDebug::)" "$FILE"; then
        echo "❌ 错误：文件 $FILE 中包含禁止的QDebug调用"
        HAS_VIOLATION=1
    fi
done

# 如果有违规，终止提交
if [ $HAS_VIOLATION -eq 1 ]; then
    echo -e "\n⚠️ 提交被阻止：请移除所有QDebug相关代码或头文件引用后重试"
    exit 1
fi

# 没有违规，允许提交
exit 0

二、部署钩子并测试 #

1. 把上面的脚本保存为.git/hooks/pre-commit
2. 给脚本添加可执行权限：

   chmod +x .git/hooks/pre-commit
   

3. 现在尝试提交包含QDebug的代码，你会看到错误提示，提交被自动拦截。

三、优化细节（可选） #

如果你的项目里允许注释中的QDebug（比如// qDebug() << "test"），可以调整grep的规则来排除注释行：

• 对于#include <QDebug>的检查，基本不用调整（因为很少有人把include写在注释里）
• 对于QDebug调用的检查，可以修改grep命令，排除以//开头的注释行：

  if grep -E "(qDebug\(|QDebug::)" "$FILE" | grep -v "^//"; then
      echo "❌ 错误：文件 $FILE 中包含禁止的QDebug调用"
      HAS_VIOLATION=1
  fi
  

不过这个规则比较基础，如果有块注释（/* ... */）里的QDebug，可能需要更复杂的正则，你可以根据项目实际情况调整。

四、额外提示 #

• 如果团队协作，建议把这个钩子脚本加入项目仓库（比如放在scripts/git-hooks/目录），然后通过git config core.hooksPath scripts/git-hooks让所有团队成员共享这个钩子配置，避免每个人手动部署。
• 如果你需要临时跳过检查（比如紧急修复），可以用git commit --no-verify强制提交，但不推荐日常使用。

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