Skip to content

Commit aad93ea

Browse files
flakey5ovflowd
authored andcommitted
directly use doc-kit bin instead of npx
Signed-off-by: flakey5 <[email protected]>
1 parent 8fa0c8b commit aad93ea

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
@@ -84,7 +84,6 @@ EXEEXT := $(shell $(PYTHON) -c \
8484
NODE_EXE = node$(EXEEXT)
8585
NODE_G_EXE = node_g$(EXEEXT)
8686
NPM ?= ./deps/npm/bin/npm-cli.js
87-
NPX ?= ./deps/npm/bin/npx-cli.js
8887

8988
# Release build of node.
9089
# Use $(PWD) so we can cd to anywhere before calling this.
@@ -106,7 +105,7 @@ V ?= 0
106105
# Use -e to double check in case it's a broken link
107106
available-node = \
108107
if [ -x "$(NODE)" ] && [ -e "$(NODE)" ]; then \
109-
"$(NODE)" $(1); \
108+
PATH="$(PWD)/out/$(BUILDTYPE):$$PATH" "$(NODE)" $(1); \
110109
elif [ -x `command -v node` ] && [ -e `command -v node` ] && [ `command -v node` ]; then \
111110
`command -v node` $(1); \
112111
else \
@@ -390,14 +389,16 @@ ifeq ($(OSTYPE),os400)
390389
DOCBUILDSTAMP_PREREQS := $(DOCBUILDSTAMP_PREREQS) out/$(BUILDTYPE)/node.exp
391390
endif
392391

392+
DOC_KIT ?= tools/doc/node_modules/.bin/doc-kit
393+
393394
node_use_openssl_and_icu = $(call available-node,"-p" \
394395
"process.versions.openssl != undefined && process.versions.icu != undefined")
395396
test/addons/.docbuildstamp: $(DOCBUILDSTAMP_PREREQS) tools/doc/node_modules
396397
@if [ "$(shell $(node_use_openssl_and_icu))" != "true" ]; then \
397398
echo "Skipping .docbuildstamp (no crypto and/or no ICU)"; \
398399
else \
399400
$(RM) -r test/addons/??_*/; \
400-
$(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) \
401+
$(call available-node, $(DOC_KIT) generate -t addon-verify -i doc/api/addons.md -o test/addons/ --type-map doc/type-map.json) \
401402
[ $$? -eq 0 ] && touch $@; \
402403
fi
403404

@@ -806,14 +807,6 @@ tools/doc/node_modules: tools/doc/package.json
806807
if [ "$(shell $(node_use_openssl_and_icu))" != "true" ]; then \
807808
echo "Skipping tools/doc/node_modules (no crypto and/or no ICU)"; \
808809
else \
809-
if ! [ `command -v node` ]; then \
810-
if [ -x "$(NODE)" ] && [ -e "$(NODE)" ]; then \
811-
export PATH="$(dir $(subst $\",,$(NODE))):${PATH};" \
812-
else \
813-
echo "No available node, cannot install dependencies"; \
814-
exit 1; \
815-
fi; \
816-
fi; \
817810
cd tools/doc && $(call available-node,$(run-npm-ci)) \
818811
fi
819812

@@ -845,7 +838,7 @@ out/doc/api: doc/api
845838
# For generating individual doc files instead of all at once
846839
out/doc/api/%.html out/doc/api/%.json: doc/api/%.md tools/doc/node_modules | out/doc/api
847840
$(call available-node, \
848-
$(NPX) --prefix tools/doc doc-kit generate \
841+
$(DOC_KIT) generate \
849842
-t $(subst .,legacy-, $(suffix $@)) \
850843
-i $< \
851844
--ignore $(skip_apidoc_files) \
@@ -858,7 +851,7 @@ out/doc/api/%.html out/doc/api/%.json: doc/api/%.md tools/doc/node_modules | out
858851

859852
out/doc/api/all.html: $(apidocs_html) | out/doc/api
860853
$(call available-node, \
861-
$(NPX) --prefix tools/doc doc-kit generate \
854+
$(DOC_KIT) generate \
862855
-t legacy-html-all \
863856
-i doc/api/*.md \
864857
--ignore $(skip_apidoc_files) \
@@ -871,7 +864,7 @@ out/doc/api/all.html: $(apidocs_html) | out/doc/api
871864

872865
out/doc/api/all.json: $(apidocs_json) | out/doc/api
873866
$(call available-node, \
874-
$(NPX) --prefix tools/doc doc-kit generate \
867+
$(DOC_KIT) generate \
875868
-t legacy-json-all \
876869
-i doc/api/*.md \
877870
--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
@@ -184,7 +184,7 @@ if defined package set stage_package=1
184184
set "node_exe=%config%\node.exe"
185185
set "node_gyp_exe="%node_exe%" deps\npm\node_modules\node-gyp\bin\node-gyp"
186186
set "npm_exe="%~dp0%node_exe%" %~dp0deps\npm\bin\npm-cli.js"
187-
set "npx_exe="%~dp0%node_exe%" %~dp0deps\npm\bin\npx-cli.js"
187+
set "doc_kit_exe="%~dp0%node_exe%" %~dp0tools\doc\node_modules\.bin\doc-kit"
188188
if "%target_env%"=="vs2022" set "node_gyp_exe=%node_gyp_exe% --msvs_version=2022"
189189
if "%target_env%"=="vs2026" set "node_gyp_exe=%node_gyp_exe% --msvs_version=2026"
190190

@@ -620,7 +620,7 @@ if errorlevel 1 goto exit
620620

621621
:install-doctools
622622
REM only install if building doc OR testing doctool OR building addons
623-
if not defined doc if not defined build_addons if not defined lint_md (
623+
if not defined doc if not defined build_addons (
624624
echo.%test_args% | findstr doctool 1>nul
625625
if errorlevel 1 goto :skip-install-doctools
626626
)
@@ -645,8 +645,8 @@ if not exist %node_exe% (
645645
mkdir %config%\doc
646646
robocopy /e doc\api %config%\doc\api
647647

648-
%npx_exe% ^
649-
--prefix tools/doc doc-kit generate ^
648+
%doc_kit_exe% ^
649+
generate ^
650650
-t legacy-html-all legacy-json-all api-links ^
651651
-i doc/api/*.md ^
652652
-i lib/*.js ^
@@ -669,7 +669,7 @@ for /d %%F in (test\addons\??_*) do (
669669
rd /s /q %%F
670670
)
671671
:: generate
672-
"%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"
672+
%doc_kit_exe% generate -t addon-verify -i "%~dp0doc\api\addons.md" -o "%~dp0test\addons" --type-map "%~dp0doc\type-map.json"
673673
if %errorlevel% neq 0 exit /b %errorlevel%
674674
:: building addons
675675
setlocal

0 commit comments

Comments
 (0)