setup_hooks.sh

#!/bin/bash
set -euo pipefail

SCRIPT_DIR=$(dirname "$(readlink -f "$0")")
REPO_ROOT=$(dirname "${SCRIPT_DIR}")
HOOKS_DIR="${REPO_ROOT}/.git/hooks"

echo "Installing git hooks..."

# Create pre-commit hook
cat >"${HOOKS_DIR}/pre-commit" <<'EOL'
#!/bin/bash
set -e

# Colors for better output
RED='\033[0;31m'
GREEN='\033[0;32m'
YELLOW='\033[1;33m'
BLUE='\033[0;34m'
NC='\033[0m' # No Color

# Enable running the commit even with issues using environment variable
# Usage: SKIP_LINT=1 git commit -m "..."
if [ -n "$SKIP_LINT" ]; then
    echo -e "${YELLOW}Skipping pre-commit checks due to SKIP_LINT environment variable${NC}"
    exit 0
fi

echo -e "${BLUE}Running pre-commit linting checks...${NC}"
START_TIME=$(date +%s)

# Store the root of the git repository
GIT_ROOT=$(git rev-parse --show-toplevel)
cd "$GIT_ROOT"

# Get a list of staged files
STAGED_CPP_FILES=$(git diff --cached --name-only --diff-filter=ACM | grep -E '\.([ch](pp)?|cc)$' || true)
# Read NUL-delimited paths with Bash 3.2 (the default on macOS).
STAGED_PY_FILES_ARRAY=()
while IFS= read -r -d '' FILE; do
    case "$FILE" in
        *.py) STAGED_PY_FILES_ARRAY+=("$FILE") ;;
    esac
done < <(git diff --cached --name-only --diff-filter=ACM -z)

if [ -z "$STAGED_CPP_FILES" ] && [ ${#STAGED_PY_FILES_ARRAY[@]} -eq 0 ]; then
    echo -e "${GREEN}No C/C++ or Python files to check.${NC}"
    exit 0
fi

NUM_CPP_FILES=$(echo "$STAGED_CPP_FILES" | grep -c . || echo "0")
NUM_PY_FILES=${#STAGED_PY_FILES_ARRAY[@]}
echo -e "${BLUE}Found ${NUM_CPP_FILES} C/C++ files and ${NUM_PY_FILES} Python files to check${NC}"

# Create a temporary build directory for linting
TEMP_BUILD_DIR=$(mktemp -d)
LOG_DIR="$TEMP_BUILD_DIR/logs"
mkdir -p "$LOG_DIR"

# Create a cleanup function
cleanup() {
    echo -e "${BLUE}Cleaning up temporary files...${NC}"
    # rm -rf "$TEMP_BUILD_DIR"
}
trap cleanup EXIT

# Configure the project with the same warning flags
echo -e "${BLUE}Configuring temporary build for linting...${NC}"
mkdir -p "$TEMP_BUILD_DIR"
cd "$TEMP_BUILD_DIR"
CMAKE_LOG="$LOG_DIR/cmake.log"
cmake -G Ninja -DCMAKE_BUILD_TYPE=Debug \
      -DCMAKE_C_FLAGS="-Wall -Wextra -Werror -Wno-unused-variable -Wno-unused-function -Wno-unused-parameter -Wno-unused-but-set-variable -Wpedantic -Wformat=2 -Wformat-security -Wshadow -Wwrite-strings -Wstrict-prototypes -Wold-style-definition -Wredundant-decls -Wnested-externs -Wmissing-include-dirs" \
      -DCMAKE_CXX_FLAGS="-Wall -Wextra -Werror -Wno-unused-variable -Wno-unused-function -Wno-unused-parameter -Wno-unused-but-set-variable -Wno-pedantic -Wformat=2 -Wformat-security -Wshadow -Wwrite-strings -Wmissing-include-dirs" \
      -DCMAKE_EXPORT_COMPILE_COMMANDS=ON \
      "$GIT_ROOT" > "$CMAKE_LOG" 2>&1 || {
          echo -e "${RED}Failed to configure build. See $CMAKE_LOG for details.${NC}"
          exit 1
      }

# Determine the number of processors (cross-platform)
if command -v nproc >/dev/null 2>&1; then
    # Linux/most Unix systems
    NUM_CPUS=$(nproc)
elif [ "$(uname)" = "Darwin" ]; then
    # macOS
    NUM_CPUS=$(sysctl -n hw.logicalcpu)
else
    # Fallback for other systems
    NUM_CPUS=$(getconf _NPROCESSORS_ONLN 2>/dev/null || echo "4")
fi
MAX_JOBS=$((NUM_CPUS > 8 ? 8 : NUM_CPUS))  # Limit to 8 concurrent jobs to avoid overloading

# Function to show elapsed time
show_elapsed() {
    local elapsed=$(($(date +%s) - START_TIME))
    echo -e "${BLUE}Time elapsed: ${elapsed}s${NC}"
}

# Check if clang-format exists and there are C++ files to check
if command -v clang-format >/dev/null 2>&1 && [ -n "$STAGED_CPP_FILES" ]; then
    echo -e "${BLUE}Running clang-format checks in parallel (max $MAX_JOBS jobs)...${NC}"
    FORMAT_TIME=$(date +%s)

    # Create a temporary file to capture errors
    FORMAT_ERROR_LOG="$LOG_DIR/format_errors.log"
    touch "$FORMAT_ERROR_LOG"

    # Create a file to track error count from subshells
    FORMAT_ERROR_COUNT_FILE="$LOG_DIR/format_error_count.txt"
    echo "0" > "$FORMAT_ERROR_COUNT_FILE"

    cd "$GIT_ROOT"

    # Run clang-format on each file in parallel
    PIDS=()
    FILES_CHECKED=0

    for FILE in $STAGED_CPP_FILES; do
        # If we've hit the max jobs limit, wait for one to finish
        while [ ${#PIDS[@]} -ge $MAX_JOBS ]; do
            # Wait for any job to finish, then remove it from the array
            for i in "${!PIDS[@]}"; do
                if ! kill -0 ${PIDS[$i]} 2>/dev/null; then
                    unset "PIDS[$i]"
                fi
            done
            # Only wait a bit before checking again
            sleep 0.1
        done

        # Track progress
        FILES_CHECKED=$((FILES_CHECKED + 1))
        PROGRESS=$((FILES_CHECKED * 100 / NUM_CPP_FILES))
        echo -e "  [${PROGRESS}%] Checking formatting for ${BLUE}$FILE${NC}"

        # Create a log file for this specific file
        FORMAT_LOG="$LOG_DIR/format_$(basename "$FILE").log"

        # Run clang-format in background
        (
            if ! clang-format --dry-run --Werror "$FILE" > "$FORMAT_LOG" 2>&1; then
                echo -e "  ${YELLOW}Formatting issues in $FILE (see $FORMAT_LOG)${NC}"
                echo "$FILE" >> "$FORMAT_ERROR_LOG"

                # Update the error count in the shared file
                flock "$FORMAT_ERROR_COUNT_FILE" bash -c "
                    COUNT=\$(cat \"$FORMAT_ERROR_COUNT_FILE\")
                    echo \$((COUNT + 1)) > \"$FORMAT_ERROR_COUNT_FILE\"
                "
            fi
        ) &

        # Store the PID
        PIDS+=($!)
    done

    # Wait for all remaining jobs to finish with a progress indicator
    echo -e "${BLUE}Waiting for all clang-format jobs to complete...${NC}"
    while [ ${#PIDS[@]} -gt 0 ]; do
        for i in "${!PIDS[@]}"; do
            if ! kill -0 ${PIDS[$i]} 2>/dev/null; then
                unset "PIDS[$i]"
            fi
        done
        echo -ne "  Remaining jobs: ${#PIDS[@]}/$MAX_JOBS \r"
        sleep 1
    done
    echo -e "\n${BLUE}All clang-format jobs completed.${NC}"

    # Read the final error count
    FORMAT_ERRORS=$(cat "$FORMAT_ERROR_COUNT_FILE")

    # Report the results
    if [ -s "$FORMAT_ERROR_LOG" ]; then
        echo -e "${RED}Found formatting issues in $FORMAT_ERRORS files. Commit blocked.${NC}"
        echo -e "  You can fix these issues with: clang-format -i <file>"
        echo -e "  Or bypass this check with: SKIP_LINT=1 git commit"
        echo -e "  Logs are available at: $LOG_DIR/format_*.log"
        echo -e "  List of files with issues: $LOG_DIR/format_errors.log"
        exit 1
    else
        echo -e "${GREEN}Formatting check passed.${NC}"
    fi
    echo -e "${BLUE}Format check completed in $(($(date +%s) - FORMAT_TIME))s${NC}"
    cd "$TEMP_BUILD_DIR"
else
    if [ -n "$STAGED_CPP_FILES" ]; then
        echo -e "${YELLOW}clang-format not found, skipping C++ format checks${NC}"
    fi
fi

# Check Python files with ruff
if [ ${#STAGED_PY_FILES_ARRAY[@]} -gt 0 ]; then
    if command -v ruff >/dev/null 2>&1; then
        echo -e "${BLUE}Running ruff checks on Python files...${NC}"
        RUFF_TIME=$(date +%s)

        cd "$GIT_ROOT"

        # Create log file for ruff output
        RUFF_LOG="$LOG_DIR/ruff.log"
        RUFF_FORMAT_LOG="$LOG_DIR/ruff_format.log"

        # Run ruff check (linting)
        echo -e "${BLUE}Running ruff linting...${NC}"
        if ! ruff check "${STAGED_PY_FILES_ARRAY[@]}" > "$RUFF_LOG" 2>&1; then
            echo -e "${RED}ruff found linting issues. Commit blocked.${NC}"
            echo -e "  See ruff log at: $RUFF_LOG"
            echo -e "  You can fix some issues automatically with: ruff check --fix"
            echo -e "  Or bypass this check with: SKIP_LINT=1 git commit"
            exit 1
        fi

        # Run ruff format check
        echo -e "${BLUE}Running ruff format check...${NC}"
        if ! ruff format --check "${STAGED_PY_FILES_ARRAY[@]}" > "$RUFF_FORMAT_LOG" 2>&1; then
            echo -e "${RED}ruff found formatting issues. Commit blocked.${NC}"
            echo -e "  See ruff format log at: $RUFF_FORMAT_LOG"
            echo -e "  You can fix formatting issues with: ruff format <files>"
            echo -e "  Or bypass this check with: SKIP_LINT=1 git commit"
            exit 1
        fi

        echo -e "${GREEN}Python ruff checks passed!${NC}"
        echo -e "${BLUE}ruff checks completed in $(($(date +%s) - RUFF_TIME))s${NC}"
    else
        echo -e "${YELLOW}ruff not found, skipping Python code quality checks${NC}"
        echo -e "${YELLOW}Install ruff with: pip install ruff${NC}"
    fi
else
    echo -e "${GREEN}No Python files to check with ruff.${NC}"
fi

## Todo(jason): disable clang-tidy checks for now because it reports too many CXX header not found
# # Check if clang-tidy exists
# if command -v clang-tidy >/dev/null 2>&1; then
#     echo -e "${BLUE}Running clang-tidy checks in parallel (max $MAX_JOBS jobs)...${NC}"
#     TIDY_TIME=$(date +%s)

#     # Create a temporary file to capture errors
#     ERROR_LOG="$LOG_DIR/tidy_errors.log"
#     touch "$ERROR_LOG"

#     # Create a file to track error count from subshells
#     ERROR_COUNT_FILE="$LOG_DIR/error_count.txt"
#     echo "0" > "$ERROR_COUNT_FILE"

#     # Run clang-tidy on each file in parallel
#     PIDS=()
#     FILES_CHECKED=0

#     for FILE in $STAGED_FILES; do
#         # If we've hit the max jobs limit, wait for one to finish
#         while [ ${#PIDS[@]} -ge $MAX_JOBS ]; do
#             # Wait for any job to finish, then remove it from the array
#             for i in "${!PIDS[@]}"; do
#                 if ! kill -0 ${PIDS[$i]} 2>/dev/null; then
#                     unset "PIDS[$i]"
#                 fi
#             done
#             # Only wait a bit before checking again
#             sleep 0.1
#         done

#         # Track progress
#         FILES_CHECKED=$((FILES_CHECKED + 1))
#         PROGRESS=$((FILES_CHECKED * 100 / NUM_FILES))
#         echo -e "  [${PROGRESS}%] Checking ${BLUE}$FILE${NC} with clang-tidy"

#         # Create a log file for this specific file
#         TIDY_LOG="$LOG_DIR/tidy_$(basename "$FILE").log"

#         # Run clang-tidy in background
#         (
#             # Run clang-tidy with a selected set of checks
#             # Excluded some checks that might be too noisy
#             if ! clang-tidy -p="$TEMP_BUILD_DIR" \
#                 -checks='-*,bugprone-*,cert-*,clang-analyzer-*,cppcoreguidelines-*,performance-*,portability-*,readability-*,-readability-magic-numbers,-readability-braces-around-statements,-cppcoreguidelines-avoid-magic-numbers,-readability-identifier-length,-clang-analyzer-security.insecureAPI.DeprecatedOrUnsafeBufferHandling,-clang-diagnostic-unused-command-line-argument' \
#                 "$GIT_ROOT/$FILE" > "$TIDY_LOG" 2>&1; then
#                 echo -e "  ${YELLOW}clang-tidy found issues in $FILE (see $TIDY_LOG)${NC}"
#                 echo "$FILE" >> "$ERROR_LOG"

#                 # Update the error count in the shared file
#                 flock "$ERROR_COUNT_FILE" bash -c "
#                     COUNT=\$(cat \"$ERROR_COUNT_FILE\")
#                     echo \$((COUNT + 1)) > \"$ERROR_COUNT_FILE\"
#                 "
#             fi
#         ) &

#         # Store the PID
#         PIDS+=($!)
#     done

#     # Wait for all remaining jobs to finish with a progress indicator
#     echo -e "${BLUE}Waiting for all clang-tidy jobs to complete...${NC}"
#     while [ ${#PIDS[@]} -gt 0 ]; do
#         for i in "${!PIDS[@]}"; do
#             if ! kill -0 ${PIDS[$i]} 2>/dev/null; then
#                 unset "PIDS[$i]"
#             fi
#         done
#         echo -ne "  Remaining jobs: ${#PIDS[@]}/$MAX_JOBS \r"
#         sleep 1
#     done
#     echo -e "\n${BLUE}All clang-tidy jobs completed.${NC}"

#     # Read the final error count
#     FILES_WITH_ISSUES=$(cat "$ERROR_COUNT_FILE")

#     # Report the results
#     if [ -s "$ERROR_LOG" ]; then
#         echo -e "${RED}clang-tidy found issues in $FILES_WITH_ISSUES files. Commit blocked.${NC}"
#         echo -e "  Logs are available at: $LOG_DIR/latest/tidy_*.log"
#         echo -e "  List of files with issues: $LOG_DIR/latest/tidy_errors.log"
#         echo -e "  Or bypass this check with: SKIP_LINT=1 git commit"
#         exit 1
#     else
#         echo -e "${GREEN}clang-tidy check passed successfully.${NC}"
#     fi
#     echo -e "${BLUE}clang-tidy checks completed in $(($(date +%s) - TIDY_TIME))s${NC}"
# else
#     echo -e "${YELLOW}clang-tidy not found, skipping static analysis${NC}"
# fi

# # Check for compilation warnings
# echo -e "${BLUE}Checking for compilation warnings...${NC}"
# COMPILE_TIME=$(date +%s)
# cd "$TEMP_BUILD_DIR"

# COMPILE_LOG="$LOG_DIR/compile.log"
# if ninja > "$COMPILE_LOG" 2>&1; then
#     echo -e "${GREEN}Compilation successful!${NC}"
# else
#     echo -e "${RED}Compilation failed. Please fix the warnings before committing.${NC}"
#     echo -e "  See compilation log at: $LOG_DIR/latest/compile.log"
#     echo -e "  You can also bypass this check with SKIP_LINT=1 git commit"
#     exit 1
# fi
# echo -e "${BLUE}Compilation check completed in $(($(date +%s) - COMPILE_TIME))s${NC}"

# Show total time
TOTAL_TIME=$(($(date +%s) - START_TIME))
echo -e "${GREEN}All linting checks completed successfully in ${TOTAL_TIME}s!${NC}"
exit 0
EOL

# Make hooks executable
chmod +x "${HOOKS_DIR}/pre-commit"

echo "Git hooks installed successfully!"
echo "The pre-commit hook will now run automatically on each commit to check for linting issues."
echo "You can bypass the checks with: SKIP_LINT=1 git commit"
echo "Linting logs are stored in .lint-logs/ for future reference."
echo "Note: clang-tidy and clang-format will be used if they're installed on your system."