meta: enable eslint jsdoc rules

[anonrig]

I propose enabling jsdoc eslint rules. This would help a lot for maintainance, and help create a more consistent code base. Currently, we have jsdoc in some areas but not in all places. Additionally, this would help folks maintaining @types/node package a lot.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.07%. Comparing base (049664b) to head (0813c52).
Report is 11 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff            @@
##             main   #58521    +/-   ##
========================================
  Coverage   90.06%   90.07%            
========================================
  Files         645      645            
  Lines      189130   189330   +200     
  Branches    37094    37093     -1     
========================================
+ Hits       170339   170530   +191     
+ Misses      11511    11507     -4     
- Partials     7280     7293    +13     

Files with missing lines	Coverage Δ
lib/_http_common.js	100.00% <100.00%> (ø)
lib/buffer.js	100.00% <100.00%> (ø)
lib/events.js	99.58% <100.00%> (+<0.01%)	⬆️
lib/https.js	99.30% <100.00%> (ø)
lib/internal/abort_controller.js	98.27% <100.00%> (+<0.01%)	⬆️
lib/internal/async_hooks.js	99.36% <100.00%> (ø)
lib/internal/blob.js	99.80% <100.00%> (ø)
lib/internal/crypto/hash.js	98.89% <100.00%> (+<0.01%)	⬆️
lib/internal/crypto/random.js	96.09% <100.00%> (ø)
lib/internal/data_url.js	100.00% <100.00%> (ø)
... and 49 more

... and 26 files with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[anonrig]

cc @LiviaMedeiros @jasnell can you re-review?

[nodejs-github-bot]

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

[nodejs-github-bot]

Commit Queue failed

- Loading data for nodejs/node/pull/58521
✔  Done loading data for nodejs/node/pull/58521
----------------------------------- PR info ------------------------------------
Title      meta: enable eslint jsdoc rules (#58521)
   ⚠  Could not retrieve the email or name of the PR author's from user's GitHub profile!
Branch     anonrig:yagiz/enable-eslint-jsdoc -> nodejs:main
Labels     tools, author ready, commit-queue-squash
Commits    10
 - meta: enable jsdoc/check-tag-names rule
 - meta: enable jsdoc/no-defaults rule
 - meta: enable jsdoc/valid-types rule
 - meta: enable jsdoc/require-returns rule
 - fixup! meta: enable jsdoc/check-tag-names rule
 - meta: enable jsdoc/check-line-alignment rule
 - meta: enable jsdoc/check-alignment rule
 - Update source_map.js
 - Update eslint.config.mjs
 - fix eslint errors
Committers 1
 - Yagiz Nizipli <[email protected]>
PR-URL: https://github.com/nodejs/node/pull/58521
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: LiviaMedeiros <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/58521
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: LiviaMedeiros <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
--------------------------------------------------------------------------------
   ℹ  This PR was created on Sat, 31 May 2025 00:31:26 GMT
   ✔  Approvals: 3
   ✔  - James M Snell (@jasnell) (TSC): https://github.com/nodejs/node/pull/58521#pullrequestreview-2882947324
   ✔  - LiviaMedeiros (@LiviaMedeiros): https://github.com/nodejs/node/pull/58521#pullrequestreview-2885824763
   ✔  - Michaël Zasso (@targos) (TSC): https://github.com/nodejs/node/pull/58521#pullrequestreview-3018831710
   ✔  Last GitHub CI successful
   ℹ  Last Full PR CI on 2025-06-01T16:43:29Z: https://ci.nodejs.org/job/node-test-pull-request/67232/
   ⚠  Commits were pushed after the last Full PR CI run:
   ⚠  - meta: enable jsdoc/check-tag-names rule
   ⚠  - meta: enable jsdoc/no-defaults rule
   ⚠  - meta: enable jsdoc/valid-types rule
   ⚠  - meta: enable jsdoc/require-returns rule
   ⚠  - fixup! meta: enable jsdoc/check-tag-names rule
   ⚠  - meta: enable jsdoc/check-line-alignment rule
   ⚠  - meta: enable jsdoc/check-alignment rule
   ⚠  - Update source_map.js
   ⚠  - Update eslint.config.mjs
   ⚠  - fix eslint errors
- Querying data for job/node-test-pull-request/67232/
   ✔  Last Jenkins CI successful
--------------------------------------------------------------------------------
   ✔  Aborted `git node land` session in /home/runner/work/node/node/.ncu

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

[nodejs-github-bot]

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