ale/custom-checks

#!/bin/bash -eu

# This Bash script implements custom sanity checks for scripts beyond what
# Vint covers, which are easy to check with regex.

# A flag for automatically fixing some errors.
FIX_ERRORS=0
RETURN_CODE=0

function print_help() {
    echo "Usage: ./custom-checks [--fix] [DIRECTORY]" 1>&2
    echo 1>&2
    echo "  -h, --help    Print this help text" 1>&2
    echo "      --fix     Automatically fix some errors" 1>&2
    exit 1
}

while [ $# -ne 0 ]; do
    case $1 in
    -h) ;& --help)
        print_help
    ;;
    --fix)
        FIX_ERRORS=1
        shift
    ;;
    --)
        shift
        break
    ;;
    -?*)
        echo "Invalid argument: $1" 1>&2
        exit 1
    ;;
    *)
        break
    ;;
    esac
done

if [ $# -eq 0 ] || [ -z "$1" ]; then
    print_help
fi

shopt -s globstar

directory="$1"

check_errors() {
    regex="$1"
    message="$2"

    for match in $(
        grep --color=never -Pn "$regex" "$directory"/**/*.vim \
        | grep --color=never -Po '^[^:]+:[0-9]+' \
        | sed 's:^\./::'
    ); do
        RETURN_CODE=1
        echo "$match $message"
    done
}

if (( FIX_ERRORS )); then
    sed -i "s/^\(function.*)\) *$/\1 abort/" "$directory"/**/*.vim
fi

check_errors \
    '^function.*\) *$' \
    'Function without abort keyword (See :help except-compat)'
check_errors ' +$' 'Trailing whitespace'
check_errors '^ * end?i? *$' 'Write endif, not en, end, or endi'

exit $RETURN_CODE