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