delint.sh

#!/bin/bash
################################################################################
# Analyzes code and assets for stylistic errors, correcting them or printing
# them to the console
#
# Usage:
#   delint.sh:
#     Analyze code for stylistic errors, printing them to the console
#   delint.sh -c, delint.sh --clean:
#     Correct simple errors which can be automatically corrected

# parse arguments
CLEAN=
if [ "$1" = "-c" ] || [ "$1" = "--clean" ]; then
  CLEAN=true
fi

# functions missing return type
RESULT=$(grep -R -n "^func.*):$" --include="*.gd" project/src)
if [ -n "$RESULT" ]; then
  echo ""
  echo "Functions missing return type:"
  echo "$RESULT"
fi

# long lines
RESULT=""
# cannot split a string literal across multiple lines in bash; must use a variable
REGEX="\(^.\{120,\}$"
REGEX+="\|^"$'\t'"\{1\}.\{116,\}$"
REGEX+="\|^"$'\t'"\{2\}.\{112,\}$"
REGEX+="\|^"$'\t'"\{3\}.\{108,\}$"
REGEX+="\|^"$'\t'"\{4\}.\{104,\}$"
REGEX+="\|^"$'\t'"\{5\}.\{100,\}$\)"
RESULT="${RESULT}$(grep -R -n "$REGEX" --include="*.gd" project/src)"
if [ -n "$RESULT" ]; then
  echo ""
  echo "Long lines:"
  echo "$RESULT"
fi

# whitespace at the start of a line
RESULT=$(grep -R -n "^\s* [^\s]" --include="*.gd" project/src \
  )
if [ -n "$RESULT" ]; then
  echo ""
  echo "Whitespace at the start of a line:"
  echo "$RESULT"
fi

# whitespace at the end of a line
RESULT=$(grep -R -n "\S\s\s*$" --include="*.gd" project/src project/assets)
if [ -n "$RESULT" ]; then
  echo ""
  echo "Whitespace at the end of a line:"
  echo "$RESULT"
  if [ "$CLEAN" ]; then
    # remove whitespace at the end of lines
    find project/src project/assets \( -name "*.gd" \) -exec sed -i "s/\(\S\)\s\s*$/\1/g" {} +
    echo "...Whitespace removed."
  fi
fi

# comments with incorrect whitespace
REGEX="\(^##"$'\t'"\|## "$'\t\t\t'"\)"
RESULT=$(grep -R -n "$REGEX" --include="*.gd" project/src)
if [ -n "$RESULT" ]; then
  echo ""
  echo "Comments with incorrect whitespace:"
  echo "$RESULT"
fi

# malformed block comments
RESULT=$(grep -R -n "^#[^#]" --include="*.gd" project/src)
if [ -n "$RESULT" ]; then
  echo ""
  echo "Malformed block comments:"
  echo "$RESULT"
fi

# fields/variables missing type hint. includes a list of whitelisted type hint omissions
RESULT=$(grep -R -n "var [^:]* = \|const [^:]* = " --include="*.gd" project/src \
  | grep -v " = parse_json(" \
  | grep -v "utils\\.gd.*var new_key = key" \
  | grep -v "utils\\.gd.*var new_value = dict\[key\]" \
  | grep -v "var result_obj = test_json_conv\\.get_data()" \
  )
if [ -n "$RESULT" ]; then
  echo ""
  echo "Fields/variables missing type hint:"
  echo "$RESULT"
fi

# functions missing type hint
RESULT=$(grep -R -n "func [a-zA-Z0-9_]*([a-zA-Z0-9_]\+[,)]" --include="*.gd" project/src \
  )
if [ -n "$RESULT" ]; then
  echo ""
  echo "Functions missing type hint:"
  echo "$RESULT"
fi

# signal functions with bad capitalization
RESULT=$(grep -R -n "func _on_[A-Z]" --include="*.gd" project/src \
  )
if [ -n "$RESULT" ]; then
  echo ""
  echo "Signal functions with bad capitalization:"
  echo "$RESULT"
fi

# temporary files
RESULT=$(find project -name "*.TMP" -o -name "*.gd~" -o -name "*.tmp")
if [ -n "$RESULT" ]; then
  echo ""
  echo "Temporary files:"
  echo "$RESULT"
  if [ "$CLEAN" ]; then
    # remove temporary files
    find project \( -name "*.TMP" -o -name "*.gd~" -o -name "*.tmp" \) -exec rm {} +
    echo "...Temporary files deleted."
  fi
fi

# orphaned .import files
FILES=$(find project/assets -type f -iname "*.import")
if [ -n "$FILES" ]; then
  RESULT=()
  for FILE in $FILES; do
    # check for no file without the .import extension
    if ! [ -f "${FILE%.*}" ]; then
      RESULT+=("${FILE}")
    fi
  done

  if [ -n "${RESULT[*]}" ]; then
    echo ""
    echo "Orphaned .import files:"
    for FILE in "${RESULT[@]}"; do
      echo "${FILE}"
    done
    if [ "$CLEAN" ]; then
      for FILE in "${RESULT[@]}"; do
        rm "${FILE}"
      done
      echo "...Orphaned .import files deleted."
    fi
  fi
fi

# filenames with bad capitalization
RESULT=$(find project/src -name "*[A-Z]*.gd" -o -name "[a-z]*.tscn")
if [ -n "$RESULT" ]; then
  echo ""
  echo "Filenames with bad capitalization:"
  echo "$RESULT"
fi

# filenames with disallowed characters
RESULT=$(find project/src -name "*_*.gd" -o -name "*[-_]*.tscn")
if [ -n "$RESULT" ]; then
  echo ""
  echo "Filenames with disallowed characters:"
  echo "$RESULT"
fi

# project settings which are enabled temporarily, but shouldn't be pushed
RESULT=
RESULT=${RESULT}"Ê"$(grep "emulate_touch_from_mouse=true" project/project.godot)
RESULT=${RESULT}"Ê"$(grep "^window/size/test_width=" project/project.godot)
RESULT=${RESULT}"Ê"$(grep "^window/size/test_height=" project/project.godot)
RESULT=$(echo "${RESULT}" |
  sed 's/ÊÊÊ*/Ê/g' | # remove consecutive newline placeholders
  sed 's/^Ê\(.*\)$/\1/g' | # remove trailing newline placeholders
  sed 's/^\(.*\)Ê$/\1/g' | # remove following newline placeholders
  sed 's/Ê/\n/g') # convert newline placeholders to newlines
if [ -n "$RESULT" ]; then
  echo ""
  echo "Temporary project settings:"
  echo "$RESULT"
  if [ "$CLEAN" ]; then
    # unset project settings
    sed -i "/emulate_touch_from_mouse=true/d" project/project.godot
    sed -i "/^window\/size\/test_width=/d" project/project.godot
    sed -i "/^window\/size\/test_height=/d" project/project.godot
    echo "...Temporary settings reverted."
  fi
fi

# print statements that got left in by mistake
RESULT=$(git diff main | grep print\()
RESULT=${RESULT}"Ê"$(git diff main | grep print_debug\()
RESULT=$(echo "${RESULT}" |
  sed 's/ÊÊÊ*/Ê/g' | # remove consecutive newline placeholders
  sed 's/^Ê\(.*\)$/\1/g' | # remove trailing newline placeholders
  sed 's/^\(.*\)Ê$/\1/g' | # remove following newline placeholders
  sed 's/Ê/\n/g') # convert newline placeholders to newlines
if [ -n "$RESULT" ]; then
  echo ""
  echo "Print statements:"
  echo "$RESULT"
fi

# redundant 'range(0, x)' call
RESULT=$(grep -R -n "[^_a-z]range(0," --include="*.gd" project/src)
if [ -n "$RESULT" ]; then
  echo ""
  echo "Redundant 'range(0, x)':"
  echo "$RESULT"
fi

# node names with spaces
RESULT=$(grep -R -n "node name=\"[^\"]* [^\"]*\"" --include="*.tscn" project/src)
if [ -n "$RESULT" ]; then
  echo ""
  echo "Node names with spaces:"
  echo "$RESULT"
fi