Skip to content

tools: enable jsdoc recommended rules - #41057

Closed
Trott wants to merge 3 commits into
nodejs:masterfrom
Trott:jsdoc-preferred
Closed

tools: enable jsdoc recommended rules#41057
Trott wants to merge 3 commits into
nodejs:masterfrom
Trott:jsdoc-preferred

Conversation

@Trott

@TrottTrott commented Dec 2, 2021

Copy link
Copy Markdown
Member

No description provided.

@nodejs-github-botnodejs-github-bot added build Issues and PRs related to build files or the CI. needs-ci PRs that need a full CI run. tools Issues and PRs related to the tools directory. windows Issues and PRs related to the Windows platform. labels Dec 2, 2021
@TrottTrott added the commit-queue-rebase Add this label to allow the Commit Queue to land a PR in several commits. label Dec 2, 2021
@aduh95aduh95 added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. request-ci Add this label to start a Jenkins CI on a PR. labels Dec 3, 2021
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Dec 3, 2021
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@TrottTrott added the commit-queue Add this label to land a pull request using GitHub Actions. label Dec 5, 2021
@nodejs-github-botnodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Dec 5, 2021
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator
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/.ncu
https://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>
@Trott

Trott commented Dec 5, 2021

Copy link
Copy Markdown
MemberAuthor

Landed in 069d2bd...147d23b.

@TrottTrott closed this Dec 5, 2021
@Trott
Trott deleted the jsdoc-preferred branch December 5, 2021 03:05
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>
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>
@danielleadamsdanielleadams mentioned this pull request Feb 1, 2022
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.buildIssues and PRs related to build files or the CI.commit-queue-failedAn error occurred while landing this pull request using GitHub Actions.commit-queue-rebaseAdd this label to allow the Commit Queue to land a PR in several commits.needs-ciPRs that need a full CI run.toolsIssues and PRs related to the tools directory.windowsIssues and PRs related to the Windows platform.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@Trott@nodejs-github-bot@jasnell@targos@BridgeAR@danielleadams@aduh95