xref: /freebsd/sys/contrib/openzfs/config/Shellcheck.am (revision 3c4ba5f55438f7afd4f4b0b56f88f2bb505fd6a6) 
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# In POSIX sh, 'local' is undefined. [SC2039] # older ShellCheck versions
8# In POSIX sh, 'local' is undefined. [SC3043] # newer ShellCheck versions
9
10SHELLCHECKSCRIPTS =
11
12JUST_SHELLCHECK_OPTS    = $(addprefix shellcheck-here-,$(subst /,^,$(1)))
13JUST_CHECKBASHISMS_OPTS = $(addprefix checkbashisms-here-,$(subst /,^,$(1)))
14SHELLCHECK_OPTS         = $(call JUST_SHELLCHECK_OPTS,$(1)) $(call JUST_CHECKBASHISMS_OPTS,$(1))
15
16PHONY += shellcheck
17
18_STGT = $(subst ^,/,$(subst shellcheck-here-,,$@))
19shellcheck-here-%:
20if HAVE_SHELLCHECK
21	shellcheck --format=gcc --enable=all --exclude=SC1090,SC1091,SC2039,SC2250,SC2312,SC3043 $$([ -n "$(SHELLCHECK_SHELL)" ] && echo "--shell=$(SHELLCHECK_SHELL)") "$$([ -e "$(_STGT)" ] || echo "$(srcdir)/")$(_STGT)"
22else
23	@echo "skipping shellcheck of" $(_STGT) "because shellcheck is not installed"
24endif
25
26shellcheck: $(SHELLCHECKSCRIPTS) $(call JUST_SHELLCHECK_OPTS,$(SHELLCHECKSCRIPTS))
27
28
29PHONY += checkbashisms
30
31# command -v *is* specified by POSIX and every shell in existence supports it
32_BTGT = $(subst ^,/,$(subst checkbashisms-here-,,$@))
33checkbashisms-here-%:
34if HAVE_CHECKBASHISMS
35	! { [ -n "$(SHELLCHECK_SHELL)" ] && echo '#!/bin/$(SHELLCHECK_SHELL)'; cat "$$([ -e "$(_BTGT)" ] || echo "$(srcdir)/")$(_BTGT)"; } | \
36	checkbashisms -npx 2>&1 | grep -vFe "'command' with option other than -p" -e 'command -v' -e 'any possible bashisms' $(CHECKBASHISMS_IGNORE) >&2
37else
38	@echo "skipping checkbashisms of" $(_BTGT) "because checkbashisms is not installed"
39endif
40
41checkbashisms: $(SHELLCHECKSCRIPTS) $(call JUST_CHECKBASHISMS_OPTS,$(SHELLCHECKSCRIPTS))
42