tools: enable JSDoc check-alignment lint rule #41109

Trott · 2021-12-07T14:38:30Z

~~This affects more than just JSDoc comments, but I'm OK with that.~~

doc/api/tls.md

doc/api/url.md

Trott · 2021-12-07T17:35:42Z

@targos Yes, I like your suggestions better than the auto-fixed changes. Adopted. Thanks!

nodejs-github-bot · 2021-12-07T23:31:07Z

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

nodejs-github-bot · 2021-12-09T16:20:22Z

Commit Queue failed

- Loading data for nodejs/node/pull/41109 ✔ Done loading data for nodejs/node/pull/41109 ----------------------------------- PR info ------------------------------------ Title tools: enable JSDoc check-alignment lint rule (#41109) Author Rich Trott (@Trott) Branch Trott:jsdoc-check-alignment -> nodejs:master Labels tools, needs-ci, commit-queue-rebase Commits 2 - doc,lib,tools: align multiline comments - tools: enable JSDoc check-alignment lint rule Committers 1 - Rich Trott PR-URL: https://github.com/nodejs/node/pull/41109 Reviewed-By: Antoine du Hamel Reviewed-By: Michaël Zasso Reviewed-By: Ruben Bridgewater Reviewed-By: Luigi Pinca ------------------------------ Generated metadata ------------------------------ PR-URL: https://github.com/nodejs/node/pull/41109 Reviewed-By: Antoine du Hamel Reviewed-By: Michaël Zasso Reviewed-By: Ruben Bridgewater Reviewed-By: Luigi Pinca -------------------------------------------------------------------------------- ℹ This PR was created on Tue, 07 Dec 2021 14:38:30 GMT ✔ Approvals: 4 ✔ - Antoine du Hamel (@aduh95) (TSC): https://github.com/nodejs/node/pull/41109#pullrequestreview-825370225 ✔ - Michaël Zasso (@targos) (TSC): https://github.com/nodejs/node/pull/41109#pullrequestreview-825595191 ✔ - Ruben Bridgewater (@BridgeAR) (TSC): https://github.com/nodejs/node/pull/41109#pullrequestreview-825647060 ✔ - Luigi Pinca (@lpinca): https://github.com/nodejs/node/pull/41109#pullrequestreview-825760708 ✔ Last GitHub Actions successful ℹ Last Full PR CI on 2021-12-07T23:31:07Z: https://ci.nodejs.org/job/node-test-pull-request/41413/ - Querying data for job/node-test-pull-request/41413/ ✔ Last Jenkins CI successful -------------------------------------------------------------------------------- ✔ No git cherry-pick in progress ✔ No git am in progress ✔ No git rebase in progress -------------------------------------------------------------------------------- - Bringing origin/master up to date... From https://github.com/nodejs/node * branch master -> FETCH_HEAD ✔ origin/master is now up-to-date - Downloading patch for 41109 From https://github.com/nodejs/node * branch refs/pull/41109/merge -> FETCH_HEAD ✔ Fetched commits as 3697587c31c7..7347e2cfd83b -------------------------------------------------------------------------------- [master a458871855] doc,lib,tools: align multiline comments Author: Rich Trott Date: Tue Dec 7 06:35:08 2021 -0800 4 files changed, 7 insertions(+), 7 deletions(-) [master 140daca3a6] tools: enable JSDoc check-alignment lint rule Author: Rich Trott Date: Tue Dec 7 06:35:45 2021 -0800 1 file changed, 1 deletion(-) ✔ Patches applied There are 2 commits in the PR. Attempting autorebase. Rebasing (2/4)

Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
doc,lib,tools: align multiline comments

These changes are in preparation for enabling a JSDoc lint rule.

PR-URL: #41109
Reviewed-By: Antoine du Hamel duhamelantoine1995@gmail.com
Reviewed-By: Michaël Zasso targos@protonmail.com
Reviewed-By: Ruben Bridgewater ruben@bridgewater.de
Reviewed-By: Luigi Pinca luigipinca@gmail.com

[detached HEAD 763cff735b] doc,lib,tools: align multiline comments
Author: Rich Trott rtrott@gmail.com
Date: Tue Dec 7 06:35:08 2021 -0800
4 files changed, 7 insertions(+), 7 deletions(-)
Rebasing (3/4)
Rebasing (4/4)

Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
tools: enable JSDoc check-alignment lint rule

PR-URL: #41109
Reviewed-By: Antoine du Hamel duhamelantoine1995@gmail.com
Reviewed-By: Michaël Zasso targos@protonmail.com
Reviewed-By: Ruben Bridgewater ruben@bridgewater.de
Reviewed-By: Luigi Pinca luigipinca@gmail.com

[detached HEAD 54dc36e6fc] tools: enable JSDoc check-alignment lint rule
Author: Rich Trott rtrott@gmail.com
Date: Tue Dec 7 06:35:45 2021 -0800
1 file changed, 1 deletion(-)

Successfully rebased and updated refs/heads/master.

✔ 763cff735b68e9764f451363f41593e78c2dc371
✔ 0:0 skipping fixes-url fixes-url
✔ 0:0 blank line after title line-after-title
✔ 0:0 line-lengths are valid line-length
✔ 0:0 metadata is at end of message metadata-end
✔ 3:8 PR-URL is valid. pr-url
✔ 0:0 reviewers are valid reviewers
✔ 0:0 valid subsystems subsystem
✔ 0:0 Title is formatted correctly. title-format
✔ 0:0 Title is <= 50 columns. title-length
✔ 54dc36e6fc44e96c48b6a1cfaf690c02d2cd5034
✔ 0:0 skipping fixes-url fixes-url
✔ 0:0 blank line after title line-after-title
✔ 0:0 line-lengths are valid line-length
✔ 0:0 metadata is at end of message metadata-end
✔ 1:8 PR-URL is valid. pr-url
✔ 0:0 reviewers are valid reviewers
✔ 0:0 valid subsystems subsystem
✔ 0:0 Title is formatted correctly. title-format
✔ 0:0 Title is <= 50 columns. title-length

The following commits are ready to be pushed to origin/master

763cff735b doc,lib,tools: align multiline comments
54dc36e6fc tools: enable JSDoc check-alignment lint rule

Temporary files removed.
To finish landing:

Run:
git push origin master
Post "Landed in 3697587c31c7...54dc36e6fc44" in tools: enable JSDoc check-alignment lint rule #41109
gh pr comment 41109 --body "Landed in 3697587c31c7...54dc36e6fc44"
gh pr close 41109
fatal: could not read Username for 'https://github.com': No such device or address

https://github.com/nodejs/node/actions/runs/1559626012

These changes are in preparation for enabling a JSDoc lint rule. PR-URL: nodejs#41109 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

PR-URL: nodejs#41109 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

Trott · 2021-12-09T16:32:15Z

Landed in 3697587...ecf4114

These changes are in preparation for enabling a JSDoc lint rule. PR-URL: #41109 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

PR-URL: #41109 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

These changes are in preparation for enabling a JSDoc lint rule. PR-URL: #41109 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

PR-URL: #41109 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

These changes are in preparation for enabling a JSDoc lint rule. PR-URL: #41109 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

These changes are in preparation for enabling a JSDoc lint rule. PR-URL: nodejs#41109 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

PR-URL: nodejs#41109 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

These changes are in preparation for enabling a JSDoc lint rule. PR-URL: #41109 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

PR-URL: #41109 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

Trott added the commit-queue-rebase Add this label to allow the Commit Queue to land a PR in several commits. label Dec 7, 2021

nodejs-github-bot added needs-ci PRs that need a full CI run. tools Issues and PRs related to the tools directory. labels Dec 7, 2021

aduh95 approved these changes Dec 7, 2021

View reviewed changes

Trott added the request-ci Add this label to start a Jenkins CI on a PR. label Dec 7, 2021

github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Dec 7, 2021

This comment has been minimized.

Sign in to view

targos reviewed Dec 7, 2021

View reviewed changes

doc/api/tls.md Outdated Show resolved Hide resolved

doc/api/url.md Outdated Show resolved Hide resolved

doc/api/url.md Outdated Show resolved Hide resolved

Trott force-pushed the jsdoc-check-alignment branch from d364d56 to 7347e2c Compare December 7, 2021 17:34

This comment has been minimized.

Sign in to view

targos approved these changes Dec 7, 2021

View reviewed changes

BridgeAR approved these changes Dec 7, 2021

View reviewed changes

lpinca approved these changes Dec 7, 2021

View reviewed changes

This comment has been minimized.

Sign in to view

This was referenced Dec 8, 2021

CI Reliability 2021-12-08 nodejs/reliability#138

Open

CI Reliability 2021-12-09 nodejs/reliability#139

Open

Trott added the commit-queue Add this label to land a pull request using GitHub Actions. label Dec 9, 2021

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 9, 2021

Trott added 2 commits December 9, 2021 08:31

tools: enable JSDoc check-alignment lint rule

ecf4114

PR-URL: nodejs#41109 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

Trott force-pushed the jsdoc-check-alignment branch from 7347e2c to ecf4114 Compare December 9, 2021 16:32

Trott merged commit ecf4114 into nodejs:master Dec 9, 2021

Trott deleted the jsdoc-check-alignment branch December 9, 2021 16:32

This was referenced Dec 10, 2021

CI Reliability 2021-12-10 nodejs/reliability#140

Open

CI Reliability 2021-12-11 nodejs/reliability#141

Open

This was referenced Dec 12, 2021

CI Reliability 2021-12-12 nodejs/reliability#142

Open

CI Reliability 2021-12-13 nodejs/reliability#143

Open

github-actions bot mentioned this pull request Dec 14, 2021

CI Reliability 2021-12-14 nodejs/reliability#144

Open

46 tasks

danielleadams mentioned this pull request Dec 14, 2021

v17.3.0 release proposal #41167

Merged

github-actions bot mentioned this pull request Dec 15, 2021

CI Reliability 2021-12-15 nodejs/reliability#145

Open

24 tasks

danielleadams added backport-blocked-v16.x and removed backport-blocked-v16.x labels Jan 31, 2022

danielleadams removed the backport-blocked-v16.x label Feb 1, 2022

danielleadams mentioned this pull request Feb 1, 2022

v16.14.0 proposal #41804

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

tools: enable JSDoc check-alignment lint rule #41109

tools: enable JSDoc check-alignment lint rule #41109

Uh oh!

Trott commented Dec 7, 2021 •

edited

Loading

Uh oh!

This comment has been minimized.

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

Trott commented Dec 7, 2021

Uh oh!

This comment has been minimized.

nodejs-github-bot commented Dec 7, 2021

Uh oh!

nodejs-github-bot commented Dec 9, 2021

PR-URL: #41109
Reviewed-By: Antoine du Hamel duhamelantoine1995@gmail.com
Reviewed-By: Michaël Zasso targos@protonmail.com
Reviewed-By: Ruben Bridgewater ruben@bridgewater.de
Reviewed-By: Luigi Pinca luigipinca@gmail.com

PR-URL: #41109
Reviewed-By: Antoine du Hamel duhamelantoine1995@gmail.com
Reviewed-By: Michaël Zasso targos@protonmail.com
Reviewed-By: Ruben Bridgewater ruben@bridgewater.de
Reviewed-By: Luigi Pinca luigipinca@gmail.com

Successfully rebased and updated refs/heads/master.

Uh oh!

Trott commented Dec 9, 2021

Uh oh!

Uh oh!

Uh oh!

tools: enable JSDoc check-alignment lint rule #41109

tools: enable JSDoc check-alignment lint rule #41109

Uh oh!

Conversation

Trott commented Dec 7, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment has been minimized.

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

Trott commented Dec 7, 2021

Uh oh!

This comment has been minimized.

nodejs-github-bot commented Dec 7, 2021

Uh oh!

nodejs-github-bot commented Dec 9, 2021

PR-URL: #41109 Reviewed-By: Antoine du Hamel duhamelantoine1995@gmail.com Reviewed-By: Michaël Zasso targos@protonmail.com Reviewed-By: Ruben Bridgewater ruben@bridgewater.de Reviewed-By: Luigi Pinca luigipinca@gmail.com

PR-URL: #41109 Reviewed-By: Antoine du Hamel duhamelantoine1995@gmail.com Reviewed-By: Michaël Zasso targos@protonmail.com Reviewed-By: Ruben Bridgewater ruben@bridgewater.de Reviewed-By: Luigi Pinca luigipinca@gmail.com

Successfully rebased and updated refs/heads/master.

Uh oh!

Trott commented Dec 9, 2021

Uh oh!

Uh oh!

Trott commented Dec 7, 2021 •

edited

Loading

PR-URL: #41109
Reviewed-By: Antoine du Hamel duhamelantoine1995@gmail.com
Reviewed-By: Michaël Zasso targos@protonmail.com
Reviewed-By: Ruben Bridgewater ruben@bridgewater.de
Reviewed-By: Luigi Pinca luigipinca@gmail.com

PR-URL: #41109
Reviewed-By: Antoine du Hamel duhamelantoine1995@gmail.com
Reviewed-By: Michaël Zasso targos@protonmail.com
Reviewed-By: Ruben Bridgewater ruben@bridgewater.de
Reviewed-By: Luigi Pinca luigipinca@gmail.com