pwndbg/lint.sh

#!/bin/bash

set -o errexit

help_and_exit() {
    echo "Usage: ./lint.sh [-f|--filter]"
    echo "  -f,  --filter         format code instead of just checking the format"
    exit 1
}

if [[ $# -gt 1 ]]; then
    help_and_exit
fi

FORMAT=0

while [[ $# -gt 0 ]]; do
    case $1 in
        -f | --format)
            FORMAT=1
            shift
            ;;
        *)
            help_and_exit
            ;;
    esac
done

set -o xtrace

# Use Python virtual env for all programs used here
if [[ -z "${PWNDBG_VENV_PATH}" ]]; then
    PWNDBG_VENV_PATH="./.venv"
fi

# shfmt is not a Python program but a system binary
# so let's hack it into the virtualenv
# This is not great, but we can't add a single binary to $PATH
SHFMT_PATH=$(which shfmt)
if [[ ! -z "${SHFMT_PATH}" ]]; then
    ln -s ${SHFMT_PATH} ${PWNDBG_VENV_PATH}/bin/shfmt 2> /dev/null || true
fi

# Override PATH because we don't want any system-level binaries to be used
PATH="${PWNDBG_VENV_PATH}/bin/"
source "${PWNDBG_VENV_PATH}/bin/activate"

LINT_FILES="pwndbg tests *.py"
LINT_TOOLS="isort black ruff vermin mypy"

if ! type ${LINT_TOOLS} &> /dev/null; then
    PIP_CMD="pip install -Ur dev-requirements.txt"
    echo "Missing one of the following tools: ${LINT_TOOLS}"
    echo "Running '${PIP_CMD}'"

    $PIP_CMD
fi

call_shfmt() {
    local FLAGS=$1
    if [ -x "$(command -v shfmt)" ]; then
        local SHFMT_FILES=$(find . -name "*.sh" -not -path "./.venv/*")
        # Indents are four spaces, binary ops can start a line, indent switch cases,
        # and allow spaces following a redirect
        shfmt ${FLAGS} -i 4 -bn -ci -sr -d .
    else
        echo "shfmt not installed, skipping"
    fi
}

if [[ $FORMAT == 1 ]]; then
    isort ${LINT_FILES}
    black ${LINT_FILES}
    call_shfmt -w
else
    isort --check-only --diff ${LINT_FILES}
    black --check --diff ${LINT_FILES}
    call_shfmt
fi

# Checking minimum python version
vermin -vvv --no-tips -t=3.8- --violations ./pwndbg/

ruff check --show-source ${LINT_FILES}

mypy pwndbg