infra: lint all existing jsdocs

[ST-DDT]

This PR fixes all lint errors that aren't Missing JSDoc comment in scripts.

Note, that currently the jsdocs lint rules don't apply to the scripts at all.

[codecov]

Codecov Report

Merging #2408 (5884e14) into next (74eeccc) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Additional details and impacted files

@@           Coverage Diff           @@
##             next    #2408   +/-   ##
=======================================
  Coverage   99.60%   99.60%           
=======================================
  Files        2802     2802           
  Lines      252486   252492    +6     
  Branches     1103     1104    +1     
=======================================
+ Hits       251499   251505    +6     
  Misses        960      960           
  Partials       27       27           

Files Changed	Coverage Δ
src/modules/date/index.ts	100.00% <100.00%> (ø)
src/modules/helpers/index.ts	99.12% <100.00%> (+<0.01%)	⬆️

... and 2 files with indirect coverage changes

[matthewmayer]

Can you make this part of preflight so lint issues dont creep back in?

[ST-DDT]

Theoretically yes. The problem is that I didnt fix the missing jsdoc lint issues. So we either had to fix them or disable the rule for scripts (and tests).
The non jsdocs lint checks are enabled for our scripts.

I'm somewhat torn on this and would like to hear more opinions on this.

[Shinigami92]

I'm somewhat torn on this and would like to hear more opinions on this.

JSDocs are checked in src because they are provided when consumers of Faker hover over the methods and stuff.
The scripts are internal and not published/exposed, so "I" don't care about JSDocs in scripts, they just help to remember what is for what when coming back a half year later and try to find stuff out. They are not public-docs.

[matthewmayer]

Agree Jsdocs in the scripts are a nice to have but much much less important than in src.

If they exist they should probably be linted correctly, but missing jsdocs in scripts is not important for self explanatory methods.

[ST-DDT]

I enabled the jsdoc checks for our entire code base, but only require jsdocs for src.