chore: add workaround for installing and using shellcheck on Apple M1

kgryte · kgryte · commit aa7cbddcc9cf · 2023-04-18T02:01:02.000-07:00
This commit reverts to a global installation when developing on Apple M1/M2, as shellcheck does not provide prebuilt binaries for the host architecture. Ref: koalaman/shellcheck#2714
diff --git a/tools/make/common.mk b/tools/make/common.mk
@@ -595,6 +595,9 @@ deps_shellcheck_version_slug := $(subst .,_,$(DEPS_SHELLCHECK_VERSION))
 # Define the output path when building shellcheck:
 DEPS_SHELLCHECK_BUILD_OUT ?= $(DEPS_BUILD_DIR)/shellcheck_$(deps_shellcheck_version_slug)
 
+# Host architecture:
+DEPS_SHELLCHECK_ARCH := $(shell command -v $(NODE) >/dev/null 2>&1 && $(NODE_HOST_ARCH))
+
 # Host platform:
 DEPS_SHELLCHECK_PLATFORM := $(shell command -v $(NODE) >/dev/null 2>&1 && $(NODE_HOST_PLATFORM))
 
diff --git a/tools/make/lib/install/shellcheck.mk b/tools/make/lib/install/shellcheck.mk
@@ -23,6 +23,7 @@ ifeq ($(OS), WINNT)
 	DEPS_SHELLCHECK_URL ?= https://github.com/koalaman/shellcheck/releases/download/v$(DEPS_SHELLCHECK_VERSION)/shellcheck-v$(DEPS_SHELLCHECK_VERSION).zip
 else
 ifeq ($(DEPS_SHELLCHECK_PLATFORM), darwin)
+	# TODO: handle arm64; currently, binaries for M1/M2 are not provided. See https://github.com/koalaman/shellcheck/issues/2714
 	DEPS_SHELLCHECK_URL ?= https://github.com/koalaman/shellcheck/releases/download/v$(DEPS_SHELLCHECK_VERSION)/shellcheck-v$(DEPS_SHELLCHECK_VERSION).darwin.x86_64.tar.xz
 else
 	DEPS_SHELLCHECK_URL ?= https://github.com/koalaman/shellcheck/releases/download/v$(DEPS_SHELLCHECK_VERSION)/shellcheck-v$(DEPS_SHELLCHECK_VERSION).linux.x86_64.tar.xz
@@ -44,9 +45,18 @@ deps_shellcheck_extract_out := $(DEPS_BUILD_DIR)/shellcheck-v$(DEPS_SHELLCHECK_V
 # Define the path to the `shellcheck` executable...
 ifeq ($(DEPS_SHELLCHECK_PLATFORM), win32)
 	SHELLCHECK ?= $(DEPS_SHELLCHECK_BUILD_OUT)/shellcheck.exe
+else
+ifeq ($(DEPS_SHELLCHECK_PLATFORM), darwin)
+ifeq ($(DEPS_SHELLCHECK_ARCH), arm64)
+	# FIXME: this is a temporary workaround until M1/M2 shellcheck binaries can be installed locally
+	SHELLCHECK ?= shellcheck
+else
+	SHELLCHECK ?= $(DEPS_SHELLCHECK_BUILD_OUT)/shellcheck
+endif
 else
 	SHELLCHECK ?= $(DEPS_SHELLCHECK_BUILD_OUT)/shellcheck
 endif
+endif
 
 # Define rule prerequisites based on the host platform...
 deps_shellcheck_test_prereqs := $(DEPS_SHELLCHECK_BUILD_OUT)
