git - 如何创建 git pre hook 来检测 'TODO' 或提交中的任何特定字符串？

Question

例如，pycharm 有一个很好的功能，可以在提交包含“TODO”的代码之前警告用户...我希望在使用 git 的标准命令行中有类似的功能。我听说可以使用 git pre-hook 。我会很感激一些关于如何实现这一目标的提示。

Answer 1

作为一个简单的解决方案，您可以将以下 shell 脚本保存为 .git/hooks/pre-commit:

#!/bin/sh

files=$(git diff --cached --name-only --diff-filter=AM)

if [ -n "$files" ]; then
    if grep -H TODO $files; then
        echo "Blocking commit as TODO was found."
        exit 1
    fi
fi