tools: enable jsdoc recommended rules #41057
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nodejs-github-bot
added
build
targos
approved these changes
Dec 2, 2021
Trott
added
the
commit-queue-rebase
jasnell
approved these changes
Dec 2, 2021
BridgeAR
approved these changes
Dec 3, 2021
aduh95
added
author ready
github-actions
bot
removed
the
request-ci
32 tasks
20 tasks
Trott
force-pushed
the
jsdoc-preferred
branch
from
fc5bbc9
to
c0f32cc
Compare
Trott
added
the
commit-queue
nodejs-github-bot
added
commit-queue-failed
Commit Queue failed- Loading data for nodejs/node/pull/41057 ✔ Done loading data for nodejs/node/pull/41057 ----------------------------------- PR info ------------------------------------ Title tools: enable jsdoc recommended rules (#41057) Author Rich Trott (@Trott) Branch Trott:jsdoc-preferred -> nodejs:master Labels windows, build, tools, author ready, needs-ci, commit-queue-rebase Commits 3 - tools: use jsdoc recommended rules - test: add missing JSDoc parameter name - tools: enable jsdoc/require-param-name lint rule Committers 1 - Rich Trott PR-URL: https://github.com/nodejs/node/pull/41057 Reviewed-By: Michaël Zasso Reviewed-By: James M Snell Reviewed-By: Ruben Bridgewater ------------------------------ Generated metadata ------------------------------ PR-URL: https://github.com/nodejs/node/pull/41057 Reviewed-By: Michaël Zasso Reviewed-By: James M Snell Reviewed-By: Ruben Bridgewater -------------------------------------------------------------------------------- ⚠ Commits were pushed since the last review: ⚠ - tools: use jsdoc recommended rules ⚠ - test: add missing JSDoc parameter name ⚠ - tools: enable jsdoc/require-param-name lint rule ℹ This PR was created on Thu, 02 Dec 2021 08:02:32 GMT ✔ Approvals: 3 ✔ - Michaël Zasso (@targos) (TSC): https://github.com/nodejs/node/pull/41057#pullrequestreview-821167123 ✔ - James M Snell (@jasnell) (TSC): https://github.com/nodejs/node/pull/41057#pullrequestreview-822087855 ✔ - Ruben Bridgewater (@BridgeAR) (TSC): https://github.com/nodejs/node/pull/41057#pullrequestreview-822383820 ✔ Last GitHub Actions successful ℹ Last Full PR CI on 2021-12-05T02:10:54Z: https://ci.nodejs.org/job/node-test-pull-request/41346/ - Querying data for job/node-test-pull-request/41346/ ✔ Last Jenkins CI successful -------------------------------------------------------------------------------- ✔ Aborted `git node land` session in /home/runner/work/node/node/.ncuhttps://github.com/nodejs/node/actions/runs/1540329342 |
Enable all recommended JSDoc linting rules and disable the ones we don't (yet?) meet. They can be enabled one by one by removing the lines that turn them off. This requires adding --max-warnings to the ESLint invocations in Makefile and vcbuild.bat because the preset enables the recommended rules as warnings and not errors. PR-URL: nodejs#41057 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
PR-URL: nodejs#41057 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
PR-URL: nodejs#41057 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
|
Landed in 069d2bd...147d23b. |
Trott
force-pushed
the
jsdoc-preferred
branch
from
c0f32cc
to
147d23b
Compare
This was referenced Dec 6, 2021
danielleadams
pushed a commit
that referenced
this pull request
Dec 13, 2021
Enable all recommended JSDoc linting rules and disable the ones we don't (yet?) meet. They can be enabled one by one by removing the lines that turn them off. This requires adding --max-warnings to the ESLint invocations in Makefile and vcbuild.bat because the preset enables the recommended rules as warnings and not errors. PR-URL: #41057 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
danielleadams
pushed a commit
that referenced
this pull request
Dec 13, 2021
PR-URL: #41057 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
danielleadams
pushed a commit
that referenced
this pull request
Dec 13, 2021
PR-URL: #41057 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
danielleadams
pushed a commit
that referenced
this pull request
Dec 14, 2021
Enable all recommended JSDoc linting rules and disable the ones we don't (yet?) meet. They can be enabled one by one by removing the lines that turn them off. This requires adding --max-warnings to the ESLint invocations in Makefile and vcbuild.bat because the preset enables the recommended rules as warnings and not errors. PR-URL: #41057 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
danielleadams
pushed a commit
that referenced
this pull request
Dec 14, 2021
PR-URL: #41057 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
danielleadams
pushed a commit
that referenced
this pull request
Dec 14, 2021
PR-URL: #41057 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Linkgoron
pushed a commit
to Linkgoron/node
that referenced
this pull request
Jan 31, 2022
Enable all recommended JSDoc linting rules and disable the ones we don't (yet?) meet. They can be enabled one by one by removing the lines that turn them off. This requires adding --max-warnings to the ESLint invocations in Makefile and vcbuild.bat because the preset enables the recommended rules as warnings and not errors. PR-URL: nodejs#41057 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Linkgoron
pushed a commit
to Linkgoron/node
that referenced
this pull request
Jan 31, 2022
PR-URL: nodejs#41057 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Linkgoron
pushed a commit
to Linkgoron/node
that referenced
this pull request
Jan 31, 2022
PR-URL: nodejs#41057 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
danielleadams
pushed a commit
that referenced
this pull request
Feb 1, 2022
Enable all recommended JSDoc linting rules and disable the ones we don't (yet?) meet. They can be enabled one by one by removing the lines that turn them off. This requires adding --max-warnings to the ESLint invocations in Makefile and vcbuild.bat because the preset enables the recommended rules as warnings and not errors. PR-URL: #41057 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
danielleadams
pushed a commit
that referenced
this pull request
Feb 1, 2022
PR-URL: #41057 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
danielleadams
pushed a commit
that referenced
this pull request
Feb 1, 2022
PR-URL: #41057 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.