git hooks 提交前检查格式

最新推荐文章于 2024-01-25 14:40:37 发布

YoungHong1992

最新推荐文章于 2024-01-25 14:40:37 发布

阅读量274

点赞数

文章标签： git github

本文链接：https://blog.csdn.net/YoungHong1992/article/details/129824700

版权

该文章介绍了一个Git的预提交钩子(pre-commit)脚本，该脚本在提交前执行代码风格检查和自动修正。它包含了对cpp/hpp文件使用clang-format进行格式化，对py文件运行isort和flake8进行Python代码风格检查，以及对json文件的处理。如果任何检查失败，脚本将阻止提交并给出错误信息。

摘要由CSDN通过智能技术生成

git config core.hookspath .git/hooks
ln -sf …/…/.githooks/pre-commit.sh .git/hooks/pre-commit

#!/bin/bash
function abort() {
    local msg=$1
    printf "\e[5m\e[1m\e[31m[COMMIT FAILED]\e[0m\e[1m %s\e[0m\n" "$msg"
    exit 1
}

function check_commands() {
    for cmd in $@; do
        which $cmd > /dev/null || abort "$cmd : command not found"
    done
}

check_commands flake8 clang-format isort

NEWFILES=$(git diff --cached --name-only --diff-filter=ACM)

for FILE in $NEWFILES; do
    case $FILE in
        *.cpp|*.hpp)
            clang-format -i $FILE
            echo  $FILE "auto corrected"
            ;;
        *.py)
            printf "\e[1mChecking\e[0m %s\n" "$FILE"
            isort --ac $FILE && {
                echo "isort: pass "
                git add $FILE
            }
            flake8 $FILE && echo "flake8: pass" || abort "Failed to pass flake8 style check"
            ;;
        *.json)
            python3 utils/update_json.py $FILE $FILE
            ;;
        *)
            ;;
    esac
    git add $FILE
done