chore: setup eslint-plugin-jsdoc to lint jsdoc

[RebeccaStevens]

PR Checklist

• Addresses an existing open issue: fixes 🛠 Tooling: Add linting to prevent blank/redundant JSDoc/TSDoc tags #152
• That issue was marked as status: accepting prs
• Steps in CONTRIBUTING.md were taken

Overview

Sets up eslint-plugin-jsdoc and apply whitespace fixes for violations reported.

[RebeccaStevens]

Not sure if we want to enforce sort-tags.

We may also want to enforce require-jsdoc specifying the contexts to apply in. Here's the config I personally use in my projects for refernce.

[codecov]

Codecov Report

Merging #157 (5ee19ab) into main (b85c70a) will not change coverage.
The diff coverage is n/a.

❗ Current head 5ee19ab differs from pull request most recent head 6f69f41. Consider uploading reports for the commit 6f69f41 to get more accurate results

@@           Coverage Diff           @@
##             main     #157   +/-   ##
=======================================
  Coverage   21.80%   21.80%           
=======================================
  Files          18       18           
  Lines         431      431           
  Branches      171      171           
=======================================
  Hits           94       94           
  Misses        315      315           
  Partials       22       22           

Flag	Coverage Δ
4.2.4	21.11% <ø> (ø)
4.3.5	21.34% <ø> (ø)
4.4.4	21.34% <ø> (ø)
latest	21.34% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
src/comments.ts	0.00% <ø> (ø)
src/compilerOptions.ts	84.21% <ø> (ø)
src/flags.ts	100.00% <ø> (ø)
src/modifiers.ts	0.00% <ø> (ø)
src/nodes/typeGuards/compound.ts	40.90% <ø> (ø)
src/nodes/typeGuards/single.ts	0.00% <ø> (ø)
src/nodes/typeGuards/union.ts	1.94% <ø> (ø)
src/scopes.ts	0.00% <ø> (ø)
src/syntax.ts	91.66% <ø> (ø)
src/tokens.ts	0.00% <ø> (ø)
... and 5 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[JoshuaKGoldberg]

LGTM! I tested it out locally and got complaints from unnecessary param and returns docs.

Just requesting extending from the recommended ruleset. But if you think that's not best here, then 🚀 let's ship!

[JoshuaKGoldberg]

Looks great, thanks! Just the one suggestion of a comment to help bump the tracking issue. Ready to merge whenever you'd like to. 🚀