config/Shellcheck.am

   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
  11 SHELLCHECKSCRIPTS =
  12
  13 JUST_SHELLCHECK_OPTS    = $(addprefix shellcheck-here-,$(subst /,^,$(1)))
  14 JUST_CHECKBASHISMS_OPTS = $(addprefix checkbashisms-here-,$(subst /,^,$(1)))
  15 SHELLCHECK_OPTS         = $(call JUST_SHELLCHECK_OPTS,$(1)) $(call JUST_CHECKBASHISMS_OPTS,$(1))
  16
  17 PHONY += shellcheck
  18
  19 _STGT = $(subst ^,/,$(subst shellcheck-here-,,$@))
  20 shellcheck-here-%:
  21 if HAVE_SHELLCHECK
  22         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)"
  23 else
  24         @echo "skipping shellcheck of" $(_STGT) "because shellcheck is not installed"
  25 endif
  26
  27 shellcheck: $(SHELLCHECKSCRIPTS) $(call JUST_SHELLCHECK_OPTS,$(SHELLCHECKSCRIPTS))
  28
  29
  30 PHONY += checkbashisms
  31
  32 # command -v *is* specified by POSIX and every shell in existence supports it
  33 _BTGT = $(subst ^,/,$(subst checkbashisms-here-,,$@))
  34 checkbashisms-here-%:
  35 if HAVE_CHECKBASHISMS
  36         ! { [ -n "$(SHELLCHECK_SHELL)" ] && echo '#!/bin/$(SHELLCHECK_SHELL)'; cat "$$([ -e "$(_BTGT)" ] || echo "$(srcdir)/")$(_BTGT)"; } | \
  37         checkbashisms -npx 2>&1 | grep -vFe "'command' with option other than -p" -e 'command -v' -e 'any possible bashisms' $(CHECKBASHISMS_IGNORE) >&2
  38 else
  39         @echo "skipping checkbashisms of" $(_BTGT) "because checkbashisms is not installed"
  40 endif
  41
  42 checkbashisms: $(SHELLCHECKSCRIPTS) $(call JUST_CHECKBASHISMS_OPTS,$(SHELLCHECKSCRIPTS))