diff --git a/Makefile b/Makefile index cc2944b3b0f..8dbe79c1370 100644 --- a/Makefile +++ b/Makefile @@ -1,28 +1,28 @@ - # Since we rely on paths relative to the makefile location, abort if make isn't being run from there. +# Since we rely on paths relative to the makefile location, abort if make isn't being run from there. $(if $(findstring /,$(MAKEFILE_LIST)),$(error Please only invoke this makefile from the directory it resides in)) - # Note: With Travis CI: - # - the path to urchin is passed via the command line. - # - the other utilities are NOT needed, so we skip the test for their existence. +# Note: With Travis CI: +# - the path to urchin is passed via the command line. +# - the other utilities are NOT needed, so we skip the test for their existence. URCHIN := urchin ifeq ($(findstring /,$(URCHIN)),) # urchin path was NOT passed in. - # Add the local npm packages' bin folder to the PATH, so that `make` can find them, when invoked directly. - # Note that rather than using `$(npm bin)` the 'node_modules/.bin' path component is hard-coded, so that invocation works even from an environment - # where npm is (temporarily) unavailable due to having deactivated an nvm instance loaded into the calling shell in order to avoid interference with tests. + # Add the local npm packages' bin folder to the PATH, so that `make` can find them, when invoked directly. + # Note that rather than using `$(npm bin)` the 'node_modules/.bin' path component is hard-coded, so that invocation works even from an environment + # where npm is (temporarily) unavailable due to having deactivated an nvm instance loaded into the calling shell in order to avoid interference with tests. export PATH := $(shell printf '%s' "$$PWD/node_modules/.bin:$$PATH") - # The list of all supporting utilities, installed with `npm install`. + # The list of all supporting utilities, installed with `npm install`. UTILS := $(URCHIN) replace semver - # Make sure that all required utilities can be located. + # Make sure that all required utilities can be located. UTIL_CHECK := $(or $(shell PATH="$(PATH)" which $(UTILS) >/dev/null && echo 'ok'),$(error Did you forget to run `npm install` after cloning the repo? At least one of the required supporting utilities not found: $(UTILS))) endif - # The files that need updating when incrementing the version number. +# The files that need updating when incrementing the version number. VERSIONED_FILES := nvm.sh install.sh README.md package.json - # Define all shells to test with. Can be overridden with `make SHELLS=... `. +# Define all shells to test with. Can be overridden with `make SHELLS=... `. SHELLS := sh bash dash zsh # ksh (#574) - # Generate 'test-' target names from specified shells. - # The embedded shell names are extracted on demand inside the recipes. +# Generate 'test-' target names from specified shells. +# The embedded shell names are extracted on demand inside the recipes. SHELL_TARGETS := $(addprefix test-,$(SHELLS)) - # Define the default test suite(s). This can be overridden with `make TEST_SUITE=<...> `. - # Test suites are the names of subfolders of './test'. +# Define the default test suite(s). This can be overridden with `make TEST_SUITE=<...> `. +# Test suites are the names of subfolders of './test'. TEST_SUITE := $(shell find ./test/* -type d -prune -exec basename {} \;) @@ -40,10 +40,14 @@ list: # Note that preexisting NVM_* variables are unset to avoid interfering with tests, except when running the Travis tests (where NVM_DIR must be passed in and the env. is assumed to be pristine). .PHONY: $(SHELL_TARGETS) $(SHELL_TARGETS): - @shell='$@'; shell=$${shell##*-}; which "$$shell" >/dev/null || { printf '\033[0;31m%s\033[0m\n' "WARNING: Cannot test with shell '$$shell': not found." >&2; exit 0; } && \ + @shell='$@'; shell=$${shell##*-}; \ + which "$$shell" >/dev/null || { printf '\033[0;31m%s\033[0m\n' "WARNING: Cannot test with shell '$$shell': not found." >&2; exit 0; } && \ printf '\n\033[0;34m%s\033[0m\n' "Running tests in $$shell"; \ [ -z "$$TRAVIS_BUILD_DIR" ] && for v in $$(set | awk -F'=' '$$1 ~ "^NVM_" { print $$1 }'); do unset $$v; done && unset v; \ - for suite in $(TEST_SUITE); do $(URCHIN) -f -s $$shell test/$$suite || exit; done + for suite in $(TEST_SUITE); do \ + echo "Running test suite: $$suite"; \ + $(URCHIN) -f -s $$shell test/$$suite || exit; \ + done # All-tests target: invokes the specified test suites for ALL shells defined in $(SHELLS). .PHONY: test @@ -82,4 +86,4 @@ release: _ensure-tag _ensure-clean _ensure-current-version printf "=== Bumping version **$$old_ver** to **$$new_ver** before committing and tagging:\n=== TYPE 'proceed' TO PROCEED, anything else to abort: " && read response && [ "$$response" = 'proceed' ] || { echo 'Aborted.' >&2; exit 2; }; \ replace "$$old_ver" "$$new_ver" $(VERSIONED_FILES) && \ git commit -m "v$$new_ver" $(VERSIONED_FILES) && \ - git tag -a "v$$new_ver" + git tag -a "v$$new_ver" \ No newline at end of file