Skip to content

build: more portable Makefile #28108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

build: more portable Makefile #28108

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6ee79a8
build: more portable Makefile
refack Jun 6, 2019
2f36e5d
fixup!
refack Jun 6, 2019
0d18772
squash! more normalization
refack Jun 6, 2019
b4a589a
fixup! keep output of lint-js.js in TAP
refack Jun 6, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
135 changes: 68 additions & 67 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,15 +61,17 @@ V ?= 0

# Use -e to double check in case it's a broken link
# Use $(PWD) so we can cd to anywhere before calling this
available-node = \
if [ -x $(PWD)/$(NODE) ] && [ -e $(PWD)/$(NODE) ]; then \
$(PWD)/$(NODE) $(1); \
available-node-shell = $(shell \
if [ -x $(PWD)/$(NODE) ] && [ -e $(PWD)/$(NODE) ]; then \
echo $(PWD)/$(NODE); \
elif [ -x `which node` ] && [ -e `which node` ] && [ `which node` ]; then \
`which node` $(1); \
else \
echo "No available node, cannot run \"node $(1)\""; \
exit 1; \
fi;
echo `which node`; \
else \
echo "No available node\n"; \
exit 1; \
fi;)

available-node = $(available-node-shell) $(1)

.PHONY: all
# BUILDTYPE=Debug builds both release and debug builds. If you want to compile
Expand Down Expand Up @@ -367,8 +369,8 @@ test/addons/.docbuildstamp: $(DOCBUILDSTAMP_PREREQS) tools/doc/node_modules
@if [ "$(shell $(node_use_openssl))" != "true" ]; then \
echo "Skipping .docbuildstamp (no crypto)"; \
else \
$(RM) -r test/addons/??_*/; \
[ -x $(NODE) ] && $(NODE) $< || node $< ; \
$(RM) -r test/addons/??_*/; \
$(available-node-shell) $<; \
touch $@; \
fi

Expand Down Expand Up @@ -687,16 +689,16 @@ apidocs_json = $(addprefix out/,$(apidoc_sources:.md=.json))
apiassets = $(subst api_assets,api/assets,$(addprefix out/,$(wildcard doc/api_assets/*)))

tools/doc/node_modules: tools/doc/package.json
@if [ "$(shell $(node_use_openssl))" != "true" ]; then \
echo "Skipping tools/doc/node_modules (no crypto)"; \
if [ "$(shell $(node_use_openssl))" != "true" ]; then \
echo "Skipping tools/doc/node_modules (no crypto)"; \
else \
cd tools/doc && $(call available-node,$(run-npm-ci)) \
cd tools/doc && $(available-node-shell) $(run-npm-ci); \
fi

.PHONY: doc-only
doc-only: tools/doc/node_modules \
$(apidoc_dirs) $(apiassets) ## Builds the docs with the local or the global Node.js binary.
@$(MAKE) out/doc/api/all.html out/doc/api/all.json
$(MAKE) out/doc/api/all.html out/doc/api/all.json

.PHONY: doc
doc: $(NODE_EXE) doc-only
Expand All @@ -717,7 +719,7 @@ out/doc/api/assets:

# If it's not a source tarball, we need to copy assets from doc/api_assets
out/doc/api/assets/%: doc/api_assets/% out/doc/api/assets
@cp $< $@
cp $< $@


run-npm-ci = $(PWD)/$(NPM) ci
Expand All @@ -743,7 +745,7 @@ out/doc/api/all.json: $(apidocs_json) tools/doc/alljson.js

.PHONY: docopen
docopen: $(apidocs_html)
@$(PYTHON) -mwebbrowser file://$(PWD)/out/doc/api/all.html
$(PYTHON) -mwebbrowser file://$(PWD)/out/doc/api/all.html

.PHONY: docclean
docclean:
Expand Down Expand Up @@ -1129,11 +1131,11 @@ endif

.PHONY: bench-all
bench-all: bench-addons-build
@echo "Please use benchmark/run.js or benchmark/compare.js to run the benchmarks."
$(info Please use benchmark/run.js or benchmark/compare.js to run the benchmarks.)

.PHONY: bench
bench: bench-addons-build
@echo "Please use benchmark/run.js or benchmark/compare.js to run the benchmarks."
$(info Please use benchmark/run.js or benchmark/compare.js to run the benchmarks.)

# Build required addons for benchmark before running it.
.PHONY: bench-addons-build
Expand All @@ -1159,68 +1161,67 @@ lint-md-clean:
lint-md-build:
$(warning "Deprecated no-op target 'lint-md-build'")

LINT_MD_DOC_FILES = $(shell ls doc/*.md doc/**/*.md)
run-lint-doc-md = tools/lint-md.js -q -f $(LINT_MD_DOC_FILES)
run-lint-doc-md = tools/lint-md.js -q -f $?

# The following two targets are split for two reasons:
# 1. The first one uses $(wildcard) and the second shells out 'find'.
# 2. The first one uses 'available-node-shell' and the second uses
# $(call available-node, ...), we use that for debugging those two methods.

# Lint all changed markdown files under doc/
tools/.docmdlintstamp: $(LINT_MD_DOC_FILES)
@echo "Running Markdown linter on docs..."
@$(call available-node,$(run-lint-doc-md))
@touch $@
tools/.docmdlintstamp: AVALIBLE_NODE := $(available-node-shell)
tools/.docmdlintstamp: $(wildcard doc/*.md doc/**/*.md)
Copy link
Member

@richardlau richardlau Jun 13, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

doc/**/*.md doesn't appear to pick up all subdirectories under doc with wildcard.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

5 mins of searching, and I couldn't even find a definition of what pattern means for wildcard() in GNU make, much less generally. I didn't think ** was supported unless the shell supported it, and I just tried on AIX, which is agressively POSIX, and it didn't expand.

$(info Running Markdown linter on docs...)
$(AVALIBLE_NODE) $(run-lint-doc-md)
touch $@

# Keep these vars recursive (no ':=') so no evaluation unless needed.
LINT_MD_TARGETS = src lib benchmark test tools/doc tools/icu
LINT_MD_ROOT_DOCS := $(wildcard *.md)
LINT_MD_MISC_FILES := $(shell find $(LINT_MD_TARGETS) -type f \
! -path '*node_modules*' ! -path 'test/fixtures/*' -name '*.md') \
$(LINT_MD_ROOT_DOCS)
run-lint-misc-md = tools/lint-md.js -q -f $(LINT_MD_MISC_FILES)
LINT_MD_MISC_FILES = \
$(wildcard *.md) $(shell find $(LINT_MD_TARGETS) -type f -name '*.md' \
! -path '*node_modules*' ! -path 'test/fixtures/*')
# Lint other changed markdown files maintained by us
tools/.miscmdlintstamp: $(LINT_MD_MISC_FILES)
@echo "Running Markdown linter on misc docs..."
@$(call available-node,$(run-lint-misc-md))
@touch $@
$(info Running Markdown linter on misc docs...)
$(call available-node, $(run-lint-doc-md))
touch $@

tools/.mdlintstamp: tools/.miscmdlintstamp tools/.docmdlintstamp

.PHONY: lint-md
# Lints the markdown documents maintained by us in the codebase.
lint-md: | tools/.mdlintstamp

.PHONY: lint-md
lint-md: | tools/.mdlintstamp ;

LINT_JS_TARGETS = .eslintrc.js benchmark doc lib test tools

run-lint-js = tools/node_modules/eslint/bin/eslint.js --cache \
--report-unused-disable-directives --ext=.js,.mjs,.md $(LINT_JS_TARGETS)
run-lint-js-fix = $(run-lint-js) --fix

.PHONY: lint-js-fix
lint-js-fix:
@$(call available-node,$(run-lint-js-fix))
$(available-node-shell) $(run-lint-js) --fix

.PHONY: lint-js
# Note that on the CI `lint-js-ci` is run instead.
# Lints the JavaScript code with eslint.
.PHONY: lint-js
lint-js:
@if [ "$(shell $(node_use_openssl))" != "true" ]; then \
if [ "$(shell $(node_use_openssl))" != "true" ]; then \
echo "Skipping $@ (no crypto)"; \
else \
echo "Running JS linter..."; \
$(call available-node,$(run-lint-js)) \
$(available-node-shell) $(run-lint-js); \
fi

jslint: lint-js
@echo "Please use lint-js instead of jslint"

run-lint-js-ci = tools/lint-js.js $(PARALLEL_ARGS) -f tap -o test-eslint.tap \
$(LINT_JS_TARGETS)
$(info Please use lint-js instead of jslint)

# For CI use local compiled 'node', and output in TAP format.
.PHONY: lint-js-ci
# On the CI the output is emitted in the TAP format.
lint-js-ci:
@echo "Running JS linter..."
@$(call available-node,$(run-lint-js-ci))
$(info Running JS linter...)
./node tools/lint-js.js $(PARALLEL_ARGS) -f tap -o test-eslint.tap $(LINT_JS_TARGETS)

jslint-ci: lint-js-ci
@echo "Please use lint-js-ci instead of jslint-ci"
$(info Please use lint-js-ci instead of jslint-ci)

LINT_CPP_ADDON_DOC_FILES_GLOB = test/addons/??_*/*.cc test/addons/??_*/*.h
LINT_CPP_ADDON_DOC_FILES = $(wildcard $(LINT_CPP_ADDON_DOC_FILES_GLOB))
Expand Down Expand Up @@ -1275,15 +1276,15 @@ CLANG_FORMAT_START ?= HEAD
# $ CLANG_FORMAT_START=master make format-cpp
format-cpp: ## Format C++ diff from $CLANG_FORMAT_START to current changes
ifneq ("","$(wildcard tools/clang-format/node_modules/)")
@echo "Formatting C++ diff from $(CLANG_FORMAT_START).."
@$(PYTHON) tools/clang-format/node_modules/.bin/git-clang-format \
$(info Formatting C++ diff from $(CLANG_FORMAT_START)..)
$(PYTHON) tools/clang-format/node_modules/.bin/git-clang-format \
--binary=tools/clang-format/node_modules/.bin/clang-format \
--style=file \
$(CLANG_FORMAT_START) -- \
$(LINT_CPP_FILES)
else
@echo "clang-format is not installed."
@echo "To install (requires internet access) run: $ make format-cpp-build"
$(warning 'clang-format' is not installed.)
$(info To install run: 'make format-cpp-build' (internet access required))
endif

ifeq ($(V),1)
Expand All @@ -1296,28 +1297,28 @@ endif
lint-cpp: tools/.cpplintstamp

tools/.cpplintstamp: $(LINT_CPP_FILES)
@echo "Running C++ linter..."
@$(PYTHON) tools/cpplint.py $(CPPLINT_QUIET) $?
@$(PYTHON) tools/check-imports.py
@touch $@
$(info Running C++ linter...)
$(PYTHON) tools/cpplint.py $(CPPLINT_QUIET) $?
$(PYTHON) tools/check-imports.py
touch $@

.PHONY: lint-addon-docs
lint-addon-docs: tools/.doclintstamp

tools/.doclintstamp: test/addons/.docbuildstamp
@echo "Running C++ linter on addon docs..."
@$(PYTHON) tools/cpplint.py $(CPPLINT_QUIET) --filter=$(ADDON_DOC_LINT_FLAGS) \
$(info Running C++ linter on addon docs...)
$(PYTHON) tools/cpplint.py $(CPPLINT_QUIET) --filter=$(ADDON_DOC_LINT_FLAGS) \
$(LINT_CPP_ADDON_DOC_FILES_GLOB)
@touch $@
touch $@

cpplint: lint-cpp
@echo "Please use lint-cpp instead of cpplint"
$(info Please use lint-cpp instead of cpplint.)

.PHONY: lint-py-build
# python -m pip install flake8
# Try with '--system' is to overcome systems that blindly set '--user'
lint-py-build:
@echo "Pip installing flake8 linter on $(shell $(PYTHON) --version)..."
$(info Pip installing flake8 linter on $(shell $(PYTHON) --version)...)
$(PYTHON) -m pip install --upgrade -t tools/pip/site-packages flake8 || \
$(PYTHON) -m pip install --upgrade --system -t tools/pip/site-packages flake8

Expand All @@ -1329,8 +1330,8 @@ lint-py:
PYTHONPATH=tools/pip $(PYTHON) -m flake8 --count --show-source --statistics .
else
lint-py:
@echo "Python linting with flake8 is not avalible"
@echo "Run 'make lint-py-build'"
$(warning Python linting with flake8 is not avalible)
$(info To install run: 'make lint-py-build' (internet access required))
endif

.PHONY: lint
Expand All @@ -1357,9 +1358,9 @@ lint-ci: lint-js-ci lint-cpp lint-py lint-md lint-addon-docs
fi
else
lint:
@echo "Linting is not available through the source tarball."
@echo "Use the git repo instead:" \
"$ git clone https://github.com/nodejs/node.git"
$(warning Linting is not available through the source tarball.)
$(info Use the git repo instead: \
'git clone https://github.com/nodejs/node.git')

lint-ci: lint
endif
Expand Down