Skip to content

Commit f846a1f

Browse files
committed
directly use doc-kit bin instead of npx
Signed-off-by: flakey5 <[email protected]>
1 parent 6c28eee commit f846a1f

File tree

3 files changed

+13
-20
lines changed

3 files changed

+13
-20
lines changed

Makefile

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,6 @@ NODE_EXE = node$(EXEEXT)
8686
NODE ?= "$(PWD)/$(NODE_EXE)"
8787
NODE_G_EXE = node_g$(EXEEXT)
8888
NPM ?= ./deps/npm/bin/npm-cli.js
89-
NPX ?= ./deps/npm/bin/npx-cli.js
9089

9190
# Flags for packaging.
9291
BUILD_DOWNLOAD_FLAGS ?= --download=all
@@ -100,7 +99,7 @@ V ?= 0
10099
# Use -e to double check in case it's a broken link
101100
available-node = \
102101
if [ -x "$(NODE)" ] && [ -e "$(NODE)" ]; then \
103-
"$(NODE)" $(1); \
102+
PATH="$(PWD)/out/$(BUILDTYPE):$$PATH" "$(NODE)" $(1); \
104103
elif [ -x `command -v node` ] && [ -e `command -v node` ] && [ `command -v node` ]; then \
105104
`command -v node` $(1); \
106105
else \
@@ -382,14 +381,16 @@ ifeq ($(OSTYPE),os400)
382381
DOCBUILDSTAMP_PREREQS := $(DOCBUILDSTAMP_PREREQS) out/$(BUILDTYPE)/node.exp
383382
endif
384383

384+
DOC_KIT ?= tools/doc/node_modules/.bin/doc-kit
385+
385386
node_use_openssl_and_icu = $(call available-node,"-p" \
386387
"process.versions.openssl != undefined && process.versions.icu != undefined")
387388
test/addons/.docbuildstamp: $(DOCBUILDSTAMP_PREREQS) tools/doc/node_modules
388389
@if [ "$(shell $(node_use_openssl_and_icu))" != "true" ]; then \
389390
echo "Skipping .docbuildstamp (no crypto and/or no ICU)"; \
390391
else \
391392
$(RM) -r test/addons/??_*/; \
392-
$(call available-node, $(NPX) --prefix tools/doc doc-kit generate -t addon-verify -i doc/api/addons.md -o test/addons/ --type-map doc/type-map.json) \
393+
$(call available-node, $(DOC_KIT) generate -t addon-verify -i doc/api/addons.md -o test/addons/ --type-map doc/type-map.json) \
393394
[ $$? -eq 0 ] && touch $@; \
394395
fi
395396

@@ -798,14 +799,6 @@ tools/doc/node_modules: tools/doc/package.json
798799
if [ "$(shell $(node_use_openssl_and_icu))" != "true" ]; then \
799800
echo "Skipping tools/doc/node_modules (no crypto and/or no ICU)"; \
800801
else \
801-
if ! [ `command -v node` ]; then \
802-
if [ -x "$(NODE)" ] && [ -e "$(NODE)" ]; then \
803-
export PATH="$(dir $(subst $\",,$(NODE))):${PATH};" \
804-
else \
805-
echo "No available node, cannot install dependencies"; \
806-
exit 1; \
807-
fi; \
808-
fi; \
809802
cd tools/doc && $(call available-node,$(run-npm-ci)) \
810803
fi
811804

@@ -837,7 +830,7 @@ out/doc/api: doc/api
837830
# For generating individual doc files instead of all at once
838831
out/doc/api/%.html out/doc/api/%.json: doc/api/%.md tools/doc/node_modules | out/doc/api
839832
$(call available-node, \
840-
$(NPX) --prefix tools/doc doc-kit generate \
833+
$(DOC_KIT) generate \
841834
-t $(subst .,legacy-, $(suffix $@)) \
842835
-i $< \
843836
--ignore $(skip_apidoc_files) \
@@ -850,7 +843,7 @@ out/doc/api/%.html out/doc/api/%.json: doc/api/%.md tools/doc/node_modules | out
850843

851844
out/doc/api/all.html: $(apidocs_html) | out/doc/api
852845
$(call available-node, \
853-
$(NPX) --prefix tools/doc doc-kit generate \
846+
$(DOC_KIT) generate \
854847
-t legacy-html-all \
855848
-i doc/api/*.md \
856849
--ignore $(skip_apidoc_files) \
@@ -863,7 +856,7 @@ out/doc/api/all.html: $(apidocs_html) | out/doc/api
863856

864857
out/doc/api/all.json: $(apidocs_json) | out/doc/api
865858
$(call available-node, \
866-
$(NPX) --prefix tools/doc doc-kit generate \
859+
$(DOC_KIT) generate \
867860
-t legacy-json-all \
868861
-i doc/api/*.md \
869862
--ignore $(skip_apidoc_files) \

tools/doc/update.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ if ! [ -x "$NPM" ]; then
1313
NPM=../../deps/npm/bin/npm-cli.js
1414

1515
if ! [ -x "$NPM" ]; then
16-
echo npm not found
16+
echo 'npm not found' >&2
1717
exit 1
1818
fi
1919
fi

vcbuild.bat

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ if defined package set stage_package=1
183183
set "node_exe=%config%\node.exe"
184184
set "node_gyp_exe="%node_exe%" deps\npm\node_modules\node-gyp\bin\node-gyp"
185185
set "npm_exe="%~dp0%node_exe%" %~dp0deps\npm\bin\npm-cli.js"
186-
set "npx_exe="%~dp0%node_exe%" %~dp0deps\npm\bin\npx-cli.js"
186+
set "doc_kit_exe="%~dp0%node_exe%" %~dp0tools\doc\node_modules\.bin\doc-kit"
187187
if "%target_env%"=="vs2022" set "node_gyp_exe=%node_gyp_exe% --msvs_version=2022"
188188

189189
:: skip building if the only argument received was lint
@@ -591,7 +591,7 @@ if errorlevel 1 goto exit
591591

592592
:install-doctools
593593
REM only install if building doc OR testing doctool OR building addons
594-
if not defined doc if not defined build_addons if not defined lint_md (
594+
if not defined doc if not defined build_addons (
595595
echo.%test_args% | findstr doctool 1>nul
596596
if errorlevel 1 goto :skip-install-doctools
597597
)
@@ -616,8 +616,8 @@ if not exist %node_exe% (
616616
mkdir %config%\doc
617617
robocopy /e doc\api %config%\doc\api
618618

619-
%npx_exe% ^
620-
--prefix tools/doc doc-kit generate ^
619+
%doc_kit_exe% ^
620+
generate ^
621621
-t legacy-html-all legacy-json-all api-links ^
622622
-i doc/api/*.md ^
623623
-i lib/*.js ^
@@ -640,7 +640,7 @@ for /d %%F in (test\addons\??_*) do (
640640
rd /s /q %%F
641641
)
642642
:: generate
643-
"%npx_exe%" --prefix tools/doc doc-kit generate -t addon-verify -i "%~dp0doc\api\addons.md" -o "%~dp0test\addons" --type-map "%~dp0doc\type-map.json"
643+
%doc_kit_exe% generate -t addon-verify -i "%~dp0doc\api\addons.md" -o "%~dp0test\addons" --type-map "%~dp0doc\type-map.json"
644644
if %errorlevel% neq 0 exit /b %errorlevel%
645645
:: building addons
646646
setlocal

0 commit comments

Comments
 (0)