lint.sh

#! /bin/bash

set -euo pipefail

# Function to print usage
function print_usage {
  echo "Usage: $0 --mode [check|format]"
  exit 1
}

function grep_xxx {
  # Don't show up in the search
  X="X"
  BAD_STRING="$X$X$X"
  # Collect matches with line numbers
  MATCHES=$(git grep -In ${BAD_STRING} || true)
  if [ -n "$MATCHES" ]; then
    echo "${BAD_STRING} found in source"
    while IFS= read -r line; do
      echo "$line"
      file=$(echo "$line" | cut -d: -f1)
      linenum=$(echo "$line" | cut -d: -f2)
      echo "::error file=${file},line=${linenum}::${BAD_STRING} comment found"
    done <<< "$MATCHES"
    exit 1
  fi
}

# Parse arguments using getopt
OPTS=$(getopt -o '' -l 'mode:' -- "$@")
if [ $? != 0 ]; then
  print_usage
fi
eval set -- "$OPTS"

# Initialize the flag
mode=

while true; do
  case "$1" in
    --mode)
      if [ "$2" = "check" ]; then
        mode=$2
      elif [ "$2" = "format" ]; then
        mode=$2
      else
        echo "Invalid value for --mode. Use 'check' or 'format'."
        exit 1
      fi
      shift 2
      ;;
    --)
      shift
      break
      ;;
    *)
      print_usage
      ;;
  esac
done

REPO_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")" &>/dev/null && pwd -P)"

# Find all git-tracked Bazel-ish files - these templates come from Buildifier's
# default search list. Literal (non-glob) names need both the bare and "**/"
# forms since git pathspec only matches wildcard patterns at any depth.
BAZEL_FILES=$(git -C "${REPO_ROOT}" ls-files -- \
              '*.bzl' \
              '*.sky' \
              'BUILD.bazel' '**/BUILD.bazel' \
              'BUILD' '**/BUILD' \
              '*.BUILD' \
              'BUILD.*.bazel' \
              'BUILD.*.oss' \
              'MODULE.bazel' '**/MODULE.bazel' \
              'WORKSPACE' '**/WORKSPACE' \
              'WORKSPACE.bazel' '**/WORKSPACE.bazel' \
              'WORKSPACE.oss' '**/WORKSPACE.oss' \
              'WORKSPACE.*.bazel' \
              'WORKSPACE.*.oss' \
            | sed "s|^|${REPO_ROOT}/|")

# Find all git-tracked Markdown-ish files
MARKDOWN_FILES=$(git -C "${REPO_ROOT}" ls-files -- '*.md' | sed "s|^|${REPO_ROOT}/|")

# Check if the flag was set
if [ -z "$mode" ]; then
  print_usage
elif [ "$mode" = "check" ]; then
  BUILDIFIER_ARGS=("-lint=off" "-mode=check" "-v=false")
  PRETTIER_ARGS=("--check" "--config" "${REPO_ROOT}/.prettierrc" "--ignore-path" "${REPO_ROOT}/.prettierignore" "--ignore-path" "${REPO_ROOT}/.gitignore")
  BAZEL_TOOL="//tools:check"
  GAZELLE_ARGS=("-mode" "diff")
  RULES_LINT_CMD="//tools/format:format.check"
elif [ "$mode" = "format" ]; then
  BUILDIFIER_ARGS=("-lint=fix" "-mode=fix" "-v=false")
  PRETTIER_ARGS=("--write" "--config" "${REPO_ROOT}/.prettierrc" "--ignore-path" "${REPO_ROOT}/.prettierignore" "--ignore-path" "${REPO_ROOT}/.gitignore")
  BAZEL_TOOL="//tools:format"
  GAZELLE_ARGS=("-mode" "fix")
  RULES_LINT_CMD="//tools/format:format"
fi
PRETTIER_INVOCATION=""


function print_error {
    read line file <<<$(caller)
    printf "\n⛔️ An error occurred during the following lint step ⛔️\n" >&2
    sed "${line}q;d" "$file" >&2
}
trap print_error ERR

CONFIG="--config quiet"
# Can uncomment to get more verbose
# CONFIG=""

# Run query generator
bazel run ${CONFIG} --output_groups=-mypy //packaging:query_generator -- --mode $mode

# Regenerate/verify gazelle_cc index files
bazel run ${CONFIG} --output_groups=-mypy //tools:generate_ccindex -- --mode $mode

echo $BAZEL_FILES | xargs bazel run ${CONFIG} -- //tools/buildifier ${BUILDIFIER_ARGS[@]}
bazel run ${CONFIG} -- ${BAZEL_TOOL}
echo $MARKDOWN_FILES | xargs bazel run ${CONFIG} -- //tools/prettier ${PRETTIER_ARGS[@]}
bazel run ${CONFIG} -- //:gazelle ${GAZELLE_ARGS[@]}

bazel run $RULES_LINT_CMD

grep_xxx

# TODO(#139)
# Add this back in (conflicts with emboss at the moment)
# See https://github.com/aspect-build/rules_lint/blob/main/example/lint.sh
# --aspects=//tools/lint:linters.bzl%clang_tidy


# Verify MODULE.bazel.lock is up to date (fixed by rules_rust upgrade, #57, #392)
bazel mod deps --lockfile_mode=error


printf "\n✨ Linting completed successfully! ✨\n"