mas/script/lint
Ross Goldberg 67ca8f5404
Improve script/lint output.
Change YAML emoji to fix spacing issue.

Move YAML lint before Git lint to keep the names getting progressively shorter.

Partial #638

Signed-off-by: Ross Goldberg <484615+rgoldberg@users.noreply.github.com>
2024-11-16 14:46:32 -05:00

76 lines
2.4 KiB
Bash
Executable file

#!/bin/bash -u
#
# script/lint
# mas
#
# Linting checks for development and CI.
#
# Reports style violations without making any modifications to the code.
#
# Please keep in sync with script/format.
#
set -o pipefail
mas_dir="$(readlink -fn "$(dirname "${BASH_SOURCE:-"${0}"}")/..")"
if ! cd -- "${mas_dir}"; then
printf $'Error: Could not cd into mas directory: %s\n' "${mas_dir}" >&2
exit 1
fi
printf $'==> 🚨 Linting mas (%s)\n' "$(script/version --write)"
for linter in git markdownlint periphery shellcheck shfmt swift-format swiftformat swiftlint yamllint; do
if [[ ! -x "$(command -v ${linter})" ]]; then
printf $'error: %s is not installed. Run \'script/bootstrap\' or \'brew install %s\'.\n' "${linter}" "${linter}"
exit 1
fi
done
exit_code=0
for source in Package.swift Sources Tests; do
printf -- $'--> 🦅 %s swift-format\n' "${source}"
swift-format lint --strict --recursive "${source}"
((exit_code |= "${?}"))
printf -- $'--> 🦅 %s swiftformat\n' "${source}"
script -q /dev/null swiftformat --lint --strict "${source}" |
(grep -vxE '(?:\^D\x08{2})?Running SwiftFormat\.{3}\r|\(lint mode - no files will be changed\.\)\r|Reading (?:config|swift-version) file at .*|\x1b\[32mSwiftFormat completed in \d+\.\d+s\.\x1b\[0m\r|0/\d+ files require formatting\.\r' || true)
((exit_code |= "${?}"))
printf -- $'--> 🦅 %s swiftlint\n' "${source}"
swiftlint --strict --quiet "${source}" 2> \
>((grep -vxF $'warning: Configuration option \'allow_multiline_func\' in \'opening_brace\' rule is deprecated. Use the option \'ignore_multiline_function_signatures\' instead.' || true) >&2)
((exit_code |= "${?}"))
done
printf -- $'--> 🐚 Bash shellcheck\n'
shellcheck --shell=bash script/*
((exit_code |= "${?}"))
printf -- $'--> 📜 Bash shfmt\n'
shfmt \
--diff \
--list \
--indent 2 \
--case-indent \
contrib/ script/
((exit_code |= "${?}"))
printf -- $'--> 〽️ Markdown\n'
markdownlint --config .markdownlint.json .github .
((exit_code |= "${?}"))
printf -- $'--> 📝 YAML\n'
yamllint .
((exit_code |= "${?}"))
printf -- $'--> 🌳 Git\n'
PAGER='cat' git diff --check
((exit_code |= "${?}"))
printf -- $'--> 🌀 Periphery\n'
script -q /dev/null periphery scan --strict --quiet --disable-update-check |
(grep -vxE '(?:\x1b\[0;1;32m|\^D\x08{2})\* (?:\x1b\[0;0m\x1b\[0;1m)?No unused code detected\.(?:\x1b\[0;0m)?\r' || true)
((exit_code |= "${?}"))
exit "${exit_code}"