Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

tools: enable jsdoc recommended rules #41057

Closed
wants to merge 3 commits into from
Closed

tools: enable jsdoc recommended rules #41057

wants to merge 3 commits into from

Conversation

Trott
Copy link
Member

@Trott Trott commented Dec 2, 2021

No description provided.

@nodejs-github-bot nodejs-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
@Trott Trott added the commit-queue-rebase Add this label to allow the Commit Queue to land a PR in several commits. label Dec 2, 2021
@aduh95 aduh95 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-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Dec 3, 2021
@nodejs-github-bot
Copy link
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/41288/

@nodejs-github-bot
Copy link
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/41295/

@nodejs-github-bot
Copy link
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/41297/

@nodejs-github-bot
Copy link
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/41301/

@nodejs-github-bot
Copy link
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/41304/

@github-actions github-actions bot mentioned this pull request Dec 4, 2021
Open
32 tasks
@nodejs-github-bot
Copy link
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/41316/

@github-actions github-actions bot mentioned this pull request Dec 5, 2021
Open
20 tasks
@nodejs-github-bot
Copy link
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/41345/

@nodejs-github-bot
Copy link
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/41346/

@Trott Trott added the commit-queue Add this label to land a pull request using GitHub Actions. label Dec 5, 2021
@nodejs-github-bot nodejs-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
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

Trott added 3 commits December 4, 2021 19:04
@Trott
tools: use jsdoc recommended rules
6dae965 
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>
@Trott
test: add missing JSDoc parameter name
87f1311 
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
tools: enable jsdoc/require-param-name lint rule
147d23b 
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
Copy link
Member Author

Trott commented Dec 5, 2021 •
edited
Loading

Landed in 069d2bd...147d23b.

@Trott Trott closed this Dec 5, 2021
@Trott Trott deleted the jsdoc-preferred branch December 5, 2021 03:05
This was referenced Dec 6, 2021
Open
Open
Open
Open
Open
danielleadams pushed a commit that referenced this pull request Dec 13, 2021
@Trott @danielleadams
tools: use jsdoc recommended rules
6468094 
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
@Trott @danielleadams
test: add missing JSDoc parameter name
602a820 
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
@Trott @danielleadams
tools: enable jsdoc/require-param-name lint rule
5a7c2bd 
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
@Trott @danielleadams
tools: use jsdoc recommended rules
78265e0 
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
@Trott @danielleadams
test: add missing JSDoc parameter name
ce656a8 
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
@Trott @danielleadams
tools: enable jsdoc/require-param-name lint rule
855f15d 
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 danielleadams mentioned this pull request Dec 14, 2021
Merged
Linkgoron pushed a commit to Linkgoron/node that referenced this pull request Jan 31, 2022
@Trott @Linkgoron
tools: use jsdoc recommended rules
02e666a 
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
@Trott @Linkgoron
test: add missing JSDoc parameter name
3c145c3 
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
@Trott @Linkgoron
tools: enable jsdoc/require-param-name lint rule
c99c0de 
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
@Trott @danielleadams
tools: use jsdoc recommended rules
0983f6b 
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
@Trott @danielleadams
test: add missing JSDoc parameter name
d6b1542 
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
@Trott @danielleadams
tools: enable jsdoc/require-param-name lint rule
50420c6 
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 danielleadams mentioned this pull request Feb 1, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BridgeAR BridgeAR BridgeAR approved these changes

@targos targos targos approved these changes

@jasnell jasnell jasnell approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. build Issues and PRs related to build files or the CI. commit-queue-failed An error occurred while landing this pull request using GitHub Actions. commit-queue-rebase Add this label to allow the Commit Queue to land a PR in several commits. 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.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@Trott @nodejs-github-bot @jasnell @targos @BridgeAR @danielleadams @aduh95