StarPilot/scripts/lint/lint.sh

#!/usr/bin/env bash
set -e

RED='\033[0;31m'
GREEN='\033[0;32m'
UNDERLINE='\033[4m'
BOLD='\033[1m'
NC='\033[0m'

DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && pwd )"
ROOT="$DIR/../../"
cd "$ROOT"

FAILED=0

function run() {
  shopt -s extglob
  case $1 in
    $SKIP | $RUN ) return 0 ;;
  esac

  echo -en "$1"

  for ((i=0; i<$((50 - ${#1})); i++)); do
    echo -n "."
  done

  shift 1;
  CMD=("$@")

  set +e
  log="$("${CMD[@]}" 2>&1)"

  if [[ $? -eq 0 ]]; then
    echo -e "[${GREEN}✔${NC}]"
  else
    echo -e "[${RED}✗${NC}]"
    echo "$log"
    FAILED=1
  fi
  set -e
}

function run_tests() {
  run "ruff" ruff check openpilot --quiet
  run "check_workflows" python3 "$DIR/check_workflows.py"
  run "check_shell" python3 "$DIR/check_shell.py" "${SHELL_FILES[@]}"
  run "check_dependencies" python3 "$DIR/check_dependencies.py"
  run "check_indentation" "$DIR/check_indentation.py" "${PYTHON_FILES[@]}"
  run "check_added_large_files" "$DIR/check_added_large_files.py" --maxkb=120 "${ALL_FILES[@]}"
  run "check_shebang_scripts_are_executable" "$DIR/check_shebang_scripts_are_executable.py" "${ALL_FILES[@]}"
  run "check_shebang_format" "$DIR/check_shebang_format.sh" "${ALL_FILES[@]}"
  run "check_nomerge_comments" "$DIR/check_nomerge_comments.sh" "${ALL_FILES[@]}"

  if [[ -z "$FAST" ]]; then
    run "ty" ty check openpilot
    run "codespell" codespell "${ALL_FILES[@]}"
  fi

  return "$FAILED"
}

function help() {
  echo "A fast linter"
  echo ""
  echo -e "${BOLD}${UNDERLINE}Usage:${NC} op lint [TESTS] [OPTIONS]"
  echo ""
  echo -e "${BOLD}${UNDERLINE}Tests:${NC}"
  echo -e "  ${BOLD}ruff${NC}"
  echo -e "  ${BOLD}check_shell${NC}"
  echo -e "  ${BOLD}check_workflows${NC}"
  echo -e "  ${BOLD}check_dependencies${NC}"
  echo -e "  ${BOLD}check_indentation${NC}"
  echo -e "  ${BOLD}ty${NC}"
  echo -e "  ${BOLD}codespell${NC}"
  echo -e "  ${BOLD}check_added_large_files${NC}"
  echo -e "  ${BOLD}check_shebang_scripts_are_executable${NC}"
  echo ""
  echo -e "${BOLD}${UNDERLINE}Options:${NC}"
  echo -e "  ${BOLD}-f, --fast${NC}"
  echo "          Skip slow tests"
  echo -e "  ${BOLD}-s, --skip${NC}"
  echo "          Specify tests to skip separated by spaces"
  echo ""
  echo -e "${BOLD}${UNDERLINE}Examples:${NC}"
  echo "  op lint ty ruff"
  echo "          Only run the ty and ruff tests"
  echo ""
  echo "  op lint --skip ty ruff"
  echo "          Skip the ty and ruff tests"
  echo ""
  echo "  op lint"
  echo "          Run all the tests"
}

SKIP=""
RUN=""
while [[ $# -gt 0 ]]; do
  case $1 in
    -f | --fast ) shift 1; FAST="1" ;;
    -s | --skip ) shift 1; SKIP=" " ;;
    -h | --help | -help | --h ) help; exit 0 ;;
    * ) if [[ -n $SKIP ]]; then SKIP+="$1 "; else RUN+="$1 "; fi; shift 1 ;;
  esac
done

RUN=$([ -z "$RUN" ] && echo "" || echo "!($(echo "$RUN" | sed 's/ /|/g'))")
SKIP="@($(echo "$SKIP" | sed 's/ /|/g'))"

ALL_FILES=()
PYTHON_FILES=()
while IFS= read -r -d '' f; do
  if [[ -f $f ]]; then
    ALL_FILES+=("$f")
    if [[ $f == *.py ]]; then
      PYTHON_FILES+=("$f")
    fi
  fi
done < <(git ls-files -z openpilot)

# Keep inherited pinned dependency scripts outside the first-party shell check.
SHELL_FILES=()
while IFS= read -r -d '' f; do
  case $f in
    msgq_repo/*|opendbc_repo/*|panda/*|rednose_repo/*|teleoprtc_repo/*|tinygrad_repo/*|jetlink_repo/*) continue ;;
  esac
  if [[ -f $f ]]; then
    SHELL_FILES+=("$f")
  fi
done < <(git ls-files -z '*.sh' '*.bash' scripts/post-commit)

run_tests