doc: recommend test-doc instead of lint-md #35708
Conversation
nodejs-github-bot
added
the
build
aduh95
changed the title
aduh95
force-pushed
the
recommand-test-doc-rather-than-lint-md
branch
from
af8e5cb
to
f51ad26
Compare
|
There's no equivalent |
| # Note that on the CI `lint-js-ci` is run instead. | ||
| # Lints the JavaScript code with eslint. | ||
| lint-js: | ||
| lint-js: EXTENSIONS=.js,.mjs,.md | ||
| lint-js-doc: EXTENSIONS=.md |
There was a problem hiding this comment.
Will this bust the ESLint cache and make the next run of lint-js take (typically) around 30 seconds instead of 3 seconds? If so, might we want to just lint-js to keep the ESLint cache intact?
There was a problem hiding this comment.
It doesn't seem so:
$ make lint-js && shasum .eslintcache
Running JS linter...
88f96b5b75f52cd813f327e329b5b90ae977e3cc .eslintcache
$ make lint-js-doc && shasum .eslintcache
Running JS linter...
88f96b5b75f52cd813f327e329b5b90ae977e3cc .eslintcache
This comment has been minimized.
This comment has been minimized.
I've tried to add I haven't added a |
@nodejs/platform-windows |
github-actions
bot
removed
the
request-ci
Non-blocking for this PR, but I've always wondered why the things |
@richardlau originally I guess we could mode the command to |
I'm confused. I thought |
|
No you're right, I was wrong: |
|
@nodejs/platform-windows friendly ping |
aduh95
added
review wanted
aduh95
force-pushed
the
recommand-test-doc-rather-than-lint-md
branch
2 times, most recently
from
3b0c574
to
cc2d361
Compare
|
|
aduh95
added
author ready
github-actions
bot
removed
the
request-ci
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Refs: #35708 PR-URL: #35927 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>
Add a build target to lint JS code in Markdown files only. PR-URL: #35708 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
PR-URL: #35708 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
The documentation style guide used to recommend checking changes in the docs by running `make lint-md`. This leaves out some important checks which are contained in the `test-doc` build target. This commit also replaces `lint` by `lint-md` in the list of `test-doc`'s prerequisites. PR-URL: #35708 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
Refs: #35708 PR-URL: #35927 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>
Add a build target to lint JS code in Markdown files only. PR-URL: #35708 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
PR-URL: #35708 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
The documentation style guide used to recommend checking changes in the docs by running `make lint-md`. This leaves out some important checks which are contained in the `test-doc` build target. This commit also replaces `lint` by `lint-md` in the list of `test-doc`'s prerequisites. PR-URL: #35708 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
Refs: #35708 PR-URL: #35927 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>
Add a build target to lint JS code in Markdown files only. PR-URL: #35708 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
PR-URL: #35708 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
The documentation style guide used to recommend checking changes in the docs by running `make lint-md`. This leaves out some important checks which are contained in the `test-doc` build target. This commit also replaces `lint` by `lint-md` in the list of `test-doc`'s prerequisites. PR-URL: #35708 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
Refs: #35708 PR-URL: #35927 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>
Add a build target to lint JS code in Markdown files only. PR-URL: #35708 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
PR-URL: #35708 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
The documentation style guide used to recommend checking changes in the docs by running `make lint-md`. This leaves out some important checks which are contained in the `test-doc` build target. This commit also replaces `lint` by `lint-md` in the list of `test-doc`'s prerequisites. PR-URL: #35708 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
Refs: #35708 PR-URL: #35927 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>
The documentation style guide used to recommend checking changes in the docs by running
make lint-md. This leaves out some important checks which are contained in thetest-docbuild target.This also adds a
lint-js-doctarget, which lints only Markdown files. This is to maketest-doctests doc files only.Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passescc @nodejs/documentation