Skip to content

Commit

Permalink
check: Add suite shellcheck
Browse files Browse the repository at this point in the history
This is based on a similar suite I drafted for zulip-mobile
back in... 2019, yikes.

It looks like at the time the thing that stopped me from merging it
there was the question of how to handle Shellcheck as a dependency.
But that needn't be a barrier to merging it -- it just needs to go
into the list of "extra suites" that don't run by default.
As a bonus we can give a nice error message when missing.
  • Loading branch information
gnprice committed Oct 3, 2023
1 parent 26d37c5 commit 019e721
Showing 1 changed file with 32 additions and 1 deletion.
33 changes: 32 additions & 1 deletion tools/check
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ this_dir=${BASH_SOURCE[0]%/*}

default_suites=(analyze test build_runner drift icons)
extra_suites=(
shellcheck # Requires its own dependency, from outside the pub system.
)

usage() {
Expand Down Expand Up @@ -69,7 +70,7 @@ while (( $# )); do
--all-files) opt_files=all; shift;;
--all) opt_files=all; opt_all=1; shift;;
--fix) opt_fix=1; shift;;
analyze|test|build_runner|drift|icons)
analyze|test|build_runner|drift|icons|shellcheck)
opt_suites+=("$1"); shift;;
*) usage;;
esac
Expand Down Expand Up @@ -256,6 +257,35 @@ run_icons() {
check_no_changes "icon updates" "${outputs[@]}"
}

run_shellcheck() {
# Omitted from this check: nothing (nothing known, anyway).
files_check tools/ '!*.'{dart,js,json} \
|| return 0

# Shellcheck is fast, <1s; so if we touched any possible targets at all,
# just run on the full list of targets.
# shellcheck disable=SC2207 # filenames in our own tree, assume well-behaved
targets=(
$(git grep -l '#!.*sh\b' -- tools/)
$(git ls-files -- tools/'*.sh')
)

if ! type shellcheck >/dev/null 2>&1; then
cat >&2 <<EOF
shellcheck: command not found
Consider installing Shellcheck:
https://github.com/koalaman/shellcheck#installing
Alternatively, skip running the \`shellcheck\` suite.
See \`tools/check --help\`.
EOF
return 1
fi

shellcheck -x --shell=bash -- "${targets[@]}"
}

failed=()
for suite in "${opt_suites[@]}"; do
echo "Running $suite..."
Expand All @@ -265,6 +295,7 @@ for suite in "${opt_suites[@]}"; do
build_runner) run_build_runner ;;
drift) run_drift ;;
icons) run_icons ;;
shellcheck) run_shellcheck ;;
*) echo >&2 "Internal error: unknown suite $suite" ;;
esac || failed+=( "$suite" )
done
Expand Down

0 comments on commit 019e721

Please sign in to comment.