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

Attention: Patch coverage is 99.72145% with 1 line in your changes missing coverage. Please review.

Project coverage is 90.08%. Comparing base (9524908) to head (9dbe731).
Report is 168 commits behind head on main.

Files with missing lines	Patch %	Lines
lib/internal/http2/util.js	66.66%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #58521      +/-   ##
==========================================
- Coverage   90.25%   90.08%   -0.17%     
==========================================
  Files         635      640       +5     
  Lines      187635   188576     +941     
  Branches    36861    36944      +83     
==========================================
+ Hits       169347   169885     +538     
- Misses      11055    11419     +364     
- Partials     7233     7272      +39     

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.17%)	⬇️
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/random.js	96.09% <100.00%> (ø)
lib/internal/data_url.js	100.00% <100.00%> (+8.23%)	⬆️
lib/internal/dns/promises.js	98.29% <100.00%> (-0.01%)	⬇️
... and 46 more

... and 128 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/

[aduh95]

Is this needed? What's the point of it?

Suggested change

	/**
	* @class
	*/
	class CustomEvent extends Event {
	class CustomEvent extends Event {

[anonrig]

I'm not sure. One of the rules probably asked me to add it.

[aduh95]

Well let's remove it 😅 I've checked, the linter doesn't complain without it

[aduh95]

Suggested change

	* the eslint module is required.
	* the eslint module is required.

[anonrig]

I 100% agree but it's against our CONTRIBUTING.md, since it's allowed in our formatter and linter right now. This should be handled through a formatter. There is a particular sentence in the document about: "Anything that can be automated should be automated"

[aduh95]

Wouldn't jsdoc/check-line-alignment enforce that?

[anonrig]

This is the first time I hear about it. Perfect. Thanks! I'll enable it now. Hopefully it will fix it.

[anonrig]

I enabled it but it didn't fix this.