DevOps-Bash-tools/check_whitespace.sh

#!/usr/bin/env bash
#  vim:ts=4:sts=4:sw=4:et
#
#  Author: Hari Sekhon
#  Date: 2016-01-09 18:50:56 +0000 (Sat, 09 Jan 2016)
#
#  https://github.com/HariSekhon/DevOps-Bash-tools
#
#  License: see accompanying Hari Sekhon LICENSE file
#
#  If you're using my code you're welcome to connect with me on LinkedIn and optionally send me feedback to help improve or steer this or other code I publish
#
#  https://www.linkedin.com/in/HariSekhon
#

set -euo pipefail
[ -n "${DEBUG:-}" ] && set -x
srcdir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"

# shellcheck source=lib/utils.sh
. "$srcdir/lib/utils.sh"

section "Checking Whitespace"

start_time="$(start_timer)"

# shellcheck source=lib/excluded.sh
. "$srcdir/lib/excluded.sh"

progress_char='-'
[ -n "${DEBUG:-}" ] && progress_char=''

whitespace_only_files_found=0
trailing_whitespace_files_found=0
trailing_whitespace_bar_files_found=0
for filename in $(find "${1:-.}" -type f | grep -Evf "$srcdir/resources/whitespace_ignore.txt" | sort); do
    isExcluded "$filename" && continue
    printf "%s" "$progress_char"
    # [[:space:]] matches \r in Windows files which we don't want, use explicit character class instead to exclude \r
    # works but not efficient
    #grep -Hn '^[[:space:]]\+$' <<< "$(tr -d '\r' < "$filename")" && let whitespace_only_files_found+=1 || :
    #grep -Hn '[[:space:]]\+$'  <<< "$(tr -d '\r' < "$filename")" && let trailing_whitespace_files_found+=1 || :
    #grep -EHn '[[:space:]]{4}\|[[:space:]]*$'  <<< "$(tr -d '\r' < "$filename")" && let trailing_whitespace_bar_files_found+=1 || :
    # \t aren't working inside character classes for some reason, embedding literal tabs instead
    output="$(grep -EHn '^[ 	]+$' "$filename" || :)"
    if [ -n "$output" ]; then
        echo
        echo "$output"
        ((whitespace_only_files_found + 1))
    fi
    output="$(grep -EHn '[ 	]+$' "$filename" || :)"
    if [ -n "$output" ]; then
        echo
        echo "$output"
        ((trailing_whitespace_files_found + 1))
    fi
    output="$(grep -EHn '[ 	]{4}\|[ 	]*$' "$filename" || :)"
    if [ -n "$output" ]; then
        echo
        echo "$output"
        ((trailing_whitespace_bar_files_found + 1))
    fi
done
echo
if [ $whitespace_only_files_found -gt 0 ]; then
    echo "$whitespace_only_files_found files with whitespace only lines detected!"
fi
if [ $trailing_whitespace_files_found -gt 0 ]; then
    echo "$trailing_whitespace_files_found files with trailing whitespace lines detected!"
fi
if [ $trailing_whitespace_bar_files_found -gt 0 ]; then
    echo "$trailing_whitespace_bar_files_found files with trailing whitespace bar lines detected!"
fi
if [ $whitespace_only_files_found -gt 0 ] ||
   [ $trailing_whitespace_files_found -gt 0 ] ||
   [ $trailing_whitespace_bar_files_found -gt 0 ]; then
    return 1 &>/dev/null || :
    exit 1
fi

time_taken "$start_time"
section2 "Whitespace only checks passed"
echo