xref: /freebsd/sys/contrib/openzfs/config/Shellcheck.am (revision 113e60742ef6ba5c069aa737ee57ba3c2f88b248)
1# Global ShellCheck exclusions:
2#
3# ShellCheck can't follow non-constant source. Use a directive to specify location. [SC1090]
4# Not following: a was not specified as input (see shellcheck -x). [SC1091]
5# Prefer putting braces around variable references even when not strictly required. [SC2250]
6# Consider invoking this command separately to avoid masking its return value (or use '|| true' to ignore). [SC2312]
7# Command appears to be unreachable. Check usage (or ignore if invoked indirectly). [SC2317]
8# In POSIX sh, 'local' is undefined. [SC2039] # older ShellCheck versions
9# In POSIX sh, 'local' is undefined. [SC3043] # newer ShellCheck versions
10
11SHELLCHECKSCRIPTS =
12
13JUST_SHELLCHECK_OPTS    = $(addprefix shellcheck-here-,$(subst /,^,$(1)))
14JUST_CHECKBASHISMS_OPTS = $(addprefix checkbashisms-here-,$(subst /,^,$(1)))
15SHELLCHECK_OPTS         = $(call JUST_SHELLCHECK_OPTS,$(1)) $(call JUST_CHECKBASHISMS_OPTS,$(1))
16
17PHONY += shellcheck
18
19shellcheck_verbose = $(shellcheck_verbose_@AM_V@)
20shellcheck_verbose_ = $(shellcheck_verbose_@AM_DEFAULT_V@)
21shellcheck_verbose_0 = @echo SHELLCHECK $(_STGT);
22
23_STGT = $(subst ^,/,$(subst shellcheck-here-,,$@))
24shellcheck-here-%:
25if HAVE_SHELLCHECK
26	$(shellcheck_verbose)shellcheck --format=gcc --enable=all --exclude=SC1090,SC1091,SC2039,SC2250,SC2312,SC2317,SC3043 $$([ -n "$(SHELLCHECK_SHELL)" ] && echo "--shell=$(SHELLCHECK_SHELL)") "$$([ -e "$(_STGT)" ] || echo "$(srcdir)/")$(_STGT)"
27else
28	@echo "skipping shellcheck of" $(_STGT) "because shellcheck is not installed"
29endif
30
31shellcheck: $(SHELLCHECKSCRIPTS) $(call JUST_SHELLCHECK_OPTS,$(SHELLCHECKSCRIPTS))
32
33
34PHONY += checkbashisms
35
36checkbashisms_verbose = $(checkbashisms_verbose_@AM_V@)
37checkbashisms_verbose_ = $(checkbashisms_verbose_@AM_DEFAULT_V@)
38checkbashisms_verbose_0 = @echo CHECKBASHISMS $(_BTGT);
39
40# command -v *is* specified by POSIX and every shell in existence supports it
41_BTGT = $(subst ^,/,$(subst checkbashisms-here-,,$@))
42checkbashisms-here-%:
43if HAVE_CHECKBASHISMS
44	$(checkbashisms_verbose)! { [ -n "$(SHELLCHECK_SHELL)" ] && echo '#!/bin/$(SHELLCHECK_SHELL)'; cat "$$([ -e "$(_BTGT)" ] || echo "$(srcdir)/")$(_BTGT)"; } | \
45	checkbashisms -npx 2>&1 | grep -vFe "'command' with option other than -p" -e 'command -v' -e 'any possible bashisms' $(CHECKBASHISMS_IGNORE) >&2
46else
47	@echo "skipping checkbashisms of" $(_BTGT) "because checkbashisms is not installed"
48endif
49
50checkbashisms: $(SHELLCHECKSCRIPTS) $(call JUST_CHECKBASHISMS_OPTS,$(SHELLCHECKSCRIPTS))
51