Skip to content

Commit cb8390b

Browse files
committed
update tooling, --version
1 parent a418c13 commit cb8390b

File tree

4 files changed

+82
-29
lines changed

4 files changed

+82
-29
lines changed

Makefile

+16-5
Original file line numberDiff line numberDiff line change
@@ -385,7 +385,7 @@ test/addons/.docbuildstamp: $(DOCBUILDSTAMP_PREREQS) tools/doc/node_modules
385385
echo "Skipping .docbuildstamp (no crypto and/or no ICU)"; \
386386
else \
387387
$(RM) -r test/addons/??_*/; \
388-
$(call available-node, $(NPX) --prefix tools/doc api-docs-tooling -t addon-verify -i doc/api/addons.md -o test/addons/ --lint-dry-run) \
388+
$(call available-node, $(NPX) --prefix tools/doc api-docs-tooling generate -t addon-verify -i doc/api/addons.md -o test/addons/ --no-lint) \
389389
[ $$? -eq 0 ] && touch $@; \
390390
fi
391391

@@ -791,13 +791,26 @@ tools/doc/node_modules: tools/doc/package.json
791791
cd tools/doc && $(call available-node,$(run-npm-ci)) \
792792
fi
793793

794+
RAWVER=$(shell $(PYTHON) tools/getnodeversion.py)
795+
VERSION=v$(RAWVER)
796+
794797
.PHONY: doc-only
795798
doc-only: tools/doc/node_modules \
796799
$(apidoc_dirs) ## Builds the docs with the local or the global Node.js binary.
797800
@if [ "$(shell $(node_use_openssl_and_icu))" != "true" ]; then \
798801
echo "Skipping doc-only (no crypto or no icu)"; \
799802
else \
800-
$(call available-node, $(NPX) --prefix tools/doc api-docs-tooling -t legacy-html-all legacy-json-all api-links -i doc/api/\*.md -i lib/\*.js --ignore $(skip_apidoc_files) -o out/doc/api/ --lint-dry-run -c file://$(PWD)/CHANGELOG.md) \
803+
$(call available-node, \
804+
$(NPX) --prefix tools/doc api-docs-tooling generate \
805+
-t legacy-html-all legacy-json-all api-links \
806+
-i doc/api/*.md \
807+
-i lib/*.js \
808+
--ignore $(skip_apidoc_files) \
809+
-o out/doc/api/ \
810+
--no-lint \
811+
-c file://$(PWD)/CHANGELOG.md \
812+
-v $(VERSION) \
813+
) \
801814
fi
802815

803816
.PHONY: doc
@@ -832,8 +845,6 @@ docserve: doc-only ## Serve the documentation on localhost:8000.
832845
docclean: ## Remove the generated documentation.
833846
$(RM) -r out/doc
834847

835-
RAWVER=$(shell $(PYTHON) tools/getnodeversion.py)
836-
VERSION=v$(RAWVER)
837848
CHANGELOG=doc/changelogs/CHANGELOG_V$(firstword $(subst ., ,$(RAWVER))).md
838849

839850
# For nightly builds, you must set DISTTYPE to "nightly", "next-nightly" or
@@ -1342,7 +1353,7 @@ lint-md: lint-js-doc lint-docs | tools/.mdlintstamp ## Lint the markdown documen
13421353
.PHONY: lint-docs
13431354
lint-docs: tools/doc/node_modules
13441355
$(info Running API Doc linter...)
1345-
$(call available-node, $(NPX) --prefix tools/doc api-docs-tooling -i doc/api/*.md -r github)
1356+
$(call available-node, $(NPX) --prefix tools/doc api-docs-tooling lint -i doc/api/*.md)
13461357

13471358
run-format-md = tools/lint-md/lint-md.mjs --format $(LINT_MD_FILES)
13481359
.PHONY: format-md

tools/doc/package-lock.json

+54-20
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

tools/doc/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "doc",
33
"dependencies": {
4-
"@node-core/api-docs-tooling": "github:nodejs/api-docs-tooling#91df7496b67426b5b0f8cb6ded7a844a8f48afd1"
4+
"@node-core/api-docs-tooling": "github:nodejs/api-docs-tooling#222fea362e70641c443b51e7094cf78df2a2f16b"
55
}
66
}

vcbuild.bat

+11-3
Original file line numberDiff line numberDiff line change
@@ -605,7 +605,15 @@ if not exist %node_exe% (
605605
mkdir %config%\doc
606606
robocopy /e doc\api %config%\doc\api
607607

608-
"%npx_exe%" --prefix tools/doc api-docs-tooling -t legacy-html-all legacy-json-all api-links -i doc/api/*.md -i lib/*.js -o out/doc/api/ --lint-dry-run -c file://%~dp0\CHANGELOG.md
608+
%npx_exe% ^
609+
--prefix tools/doc api-docs-tooling generate ^
610+
-t legacy-html-all legacy-json-all api-links ^
611+
-i doc/api/*.md ^
612+
-i lib/*.js ^
613+
-o out/doc/api/ ^
614+
--no-lint ^
615+
-c file://%~dp0\CHANGELOG.md ^
616+
-v %NODE_VERSION%
609617

610618
:run
611619
@rem Run tests if requested.
@@ -621,7 +629,7 @@ for /d %%F in (test\addons\??_*) do (
621629
rd /s /q %%F
622630
)
623631
:: generate
624-
"%npx_exe%" --prefix tools/doc api-docs-tooling -t addon-verify -i "%~dp0doc\api\addons.md" -o "%~dp0test\addons"
632+
"%npx_exe%" --prefix tools/doc api-docs-tooling generate -t addon-verify -i "%~dp0doc\api\addons.md" -o "%~dp0test\addons" --no-lint
625633
if %errorlevel% neq 0 exit /b %errorlevel%
626634
:: building addons
627635
setlocal
@@ -764,7 +772,7 @@ for /D %%D IN (doc\*) do (
764772
)
765773
)
766774
%node_exe% tools\lint-md\lint-md.mjs %lint_md_files%
767-
%npx_exe% --prefix tools\doc api-docs-tooling -i doc\api\*.md
775+
%npx_exe% --prefix tools\doc api-docs-tooling lint -i doc\api\*.md
768776
ENDLOCAL
769777
goto format-md
770778

0 commit comments

Comments
 (0)