pre-commit

#!/bin/bash

# This script is a pre-commit hook designed to automate code formatting and ensure style
# consistency before committing code. It automatically checks for and fixes trailing whitespaces,
# converts tabs to spaces, and runs clang-format on C/C++ source files. This helps maintain a
# clean and readable codebase across all contributions.

set -o pipefail

echo "Running pre-commit hook"

print_failure() {
    echo -ne "................................................................\033[1;37;41mFailed\033[0m"
    echo -e "\r❌ $1"
    echo "- Files were modified by this hook"
}

print_success() {
    echo -ne "................................................................\033[1;37;42mPassed\033[0m"
    echo -e "\r✅ $1"
}

print_skip() {
    echo -ne "...............................................................\033[1;37;46mSkipped\033[0m"
    echo -e "\r$1"
}

declare -A results=(["whitespaces"]=0 ["tabs"]=0 ["clang-format"]=0)
exit_code=0

remove_white_spaces() {
    diff -u <(cat $1) <(sed -E 's/[ '$'\t'']+$//g' $1) > /dev/null 2>&1

    if [[ $? -ne 0 ]]; then
        sed -i -E 's/[ '$'\t'']+$//g' $1
        results["whitespaces"]=1
    fi
}

change_tabs_for_spaces() {
    diff -u <(cat $1) <(sed -E 's/\t/    /g' $1) > /dev/null 2>&1

    if [[ $? -ne 0 ]]; then
        sed -i -E 's/\t/    /g' $1
        results["tabs"]=1
    fi
}

stagedFiles=$(git diff --diff-filter=d --cached --name-only)

if [[ -z ${stagedFiles} ]]; then
    echo -e "No staged files. Nothing to check."
    exit 0
fi

generalFiles=$(echo "${stagedFiles}" | grep -E '.*\.(sh|s|S|asm|ld|txt|cmake|clang-format)$') 2>&1

if [[ -z ${generalFiles} ]]; then
    results["whitespaces"]=2
    results["tabs"]=2

else
    for file in $generalFiles; do
        remove_white_spaces $file
        change_tabs_for_spaces $file
    done
fi

srcFiles=$(echo "${stagedFiles}" | grep -E '.*\.(h|c|hpp|cpp|cppm)$') 2>&1

if [[ -z ${srcFiles} ]]; then
    results["clang-format"]=2

else
    clang-format --dry-run --Werror ${srcFiles} > /dev/null 2>&1

    if [[ $? -ne 0 ]]; then
        clang-format -i -style=file ${srcFiles} > /dev/null 2>&1
        results["clang-format"]=1
    fi
fi

for key in "${!results[@]}"
do
    if [[ ${results["$key"]} -eq 1 ]]; then
        print_failure "$key"
        exit_code=1

    elif [[ ${results["$key"]} -eq 2 ]]; then
        print_skip "$key"

    else
        print_success "$key"
    fi
done

exit $exit_code