pre-commit.sh

#!/bin/sh

dir="$(git rev-parse --show-toplevel)"

# Check that there's some commits in the first place
if [[ -n $(git rev-list -n 1 --all) ]]; then
    # Ensure that we're only actually looking at the state of the repo as
    # it's being committed.
    # 
    # --keep-index means staged chunks won't be stashed; -u means untracked
    # files will be stashed.
    if [[ -n $(git status --porcelain | grep -E '^( M|\?\?)') ]]; then
        stashed="yes"
        git stash --keep-index -u
    fi
fi

# Helper function to un-stash any changes, if we had to stash them
unstash () {
    if [[ "$stashed" == "yes" ]]; then
        git stash pop
    fi
}

RUSTDOC="cargo +nightly rustdoc --" # nightly is required for -Z flags
CODESPELL_OK_WORDS="crate,raison"
CODESPELL_IGNORE_PATHS=(
    -S "$dir/fuzz/artifacts"
    -S "$dir/fuzz/corpus"
    -S "$dir/fuzz/target"
    -S "$dir/target"
)

run_codespell () {
    # note: the sed script uses '*' as the separator, because it's INCREDIBLY unlikely that you
    # actually have a filename containing '*'
    output="$(codespell --enable-colors -L "$CODESPELL_OK_WORDS" "${CODESPELL_IGNORE_PATHS[@]}" "$dir" | sed -e "s*$dir/**g" | tee -a /dev/tty)"
    if [ $? -ne 0 ] || [ -z "$output" ]; then
        return 1
    else
        return 0
    fi
}

if rg '@''commit-fail' $dir -g "!$0"; then # allow <search term> to mark things that shouldn't be committed
    unstash
    exit 1
elif rg '(debug_println|enable_debug)!' $dir; then
    unstash
    exit 1
elif rg 'auto_fuzz_\d+_unnamed' $dir; then # prevent unnamed fuzz tests
    unstash
    exit 1
elif run_codespell; then
    unstash
    exit 1
elif ! cargo fmt --check; then
    unstash
    exit 1
elif ! $RUSTDOC --document-private-items -Z unstable-options --check; then
    unstash
    exit 1
fi

unstash