files-vs-readme

#!/usr/bin/env bash
#
# files-vs-readme v1.0
#
# Compare files listed in each folder to those shown in its `README.md`
# This shows maintainers which files aren't listed in the folder index
#
# Written by:    Derek Callaway [decal (AT) sdf (D0T) org]
# Last Modified: Wed Oct 26 13:48:05 EDT 2016
# Tested On:     Kali GNU/Linux Rolling
#

WRDLS_PAGER='/bin/more'

[ ! -x "$WRDLS_PAGER" ] && WRDLS_PAGER="`which less`"
[ ! -x "$WRDLS_PAGER" ] && WRDLS_PAGER='/bin/cat'

export LESS='-R'
export WRDLS_PAGER

[ -f colors ] && source -- colors

# exit gracefully on error; be mindful of possibly malicious user function input
function errx_exit() {
  local readonly emsg=$( errno -- $1 | tail -n +1 )

  # redirect to STDERR_FILENO and close STDOUT_FILENO
  declare -l -- astr="${blackf}${yellowb}$2"
  (echo -e "${reset}${whitef}${boldon}:${reset} ${redf}${emsg}${reset}" 1>&2) <&1- 

  exit -- $1
}

[[ "$(realpath `pwd`)" =~ '/scripts' ]] && cd ..

LS=$( find . -maxdepth 1 -type d -not -iname '.*' -name '*-*' -print | egrep -v '^\./scripts$' )

[ $? -ne 0 ] && errx_exit "$?" "$_"

[[ "$PAGER" == "" ]] && export PAGER="$WRDLS_PAGER"

for d in $LS
  do declare rpth="$(realpath $d)"
  declare avar="$(basename $rpth)"

  [[ "$avar" == "" ]] && continue

  cd $avar
  
  for f in $( ls -1 * | egrep -v '^README\.md$' )
    do declare anam=$( echo $f | cut -d '.' -f1 )
    echo -ne "${bluef}${avar}${boldon}:${boldoff}${reset} "
    echo -ne "$(grep --color=ALWAYS -ia -- "${anam}" README.md)"
    echo
  done

  cd ..
done <&2- | $PAGER 

exit 0