tools: add JSDoc ESLint plugin

[targos]

• tools: install eslint-plugin-jsdoc
• tools: enable JSDoc ESLint plugin

[targos]

/cc @bmeck

[nodejs-github-bot]

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

[targos]

@nodejs/testing

[benjamingr]

I wonder how far we are from actually running (fairly permissive) tsc to check these instead :D

[targos]

I wonder how far we are from actually running (fairly permissive) tsc to check these instead :D

We are very far from that I think :D
But anyway, TSC won't validate the format of the JSDoc comments like an ESLint plugin can do.

[Trott]

Rubber-stamp LTGM although that's a lot of files....

[targos]

Rubber-stamp LTGM although that's a lot of files....

Almost all the files come from the lodash package. I don't know if we can do something about that.

[benjamingr]

@ljharb opinions ^ ?

[ljharb]

I mean, my personal opinion is that vendoring dev deps in general is a waste, and i don’t like jsdoc at all :-) so I’m not sure how helpful I’ll be here.

if that eslint plugin could be made to drop lodash tho, that’d address this concern (and also avoid a ton of others, like overly broad CVEs alerting unnecessarily for node). most of lodash is effectively built into the language now.

[aduh95]

I wonder if we could delete unused files… Looking at the code source, it's only using a dozen of lodash functions:

• _.has
• _.filter
• _.flatten
• _.flatMap
• _.mapKeys
• _.some
• _.kebabCase
• _.zipObject
• _.escapeRegExp
• _.trimStart
• _.compact

[ljharb]

The trick is that it’s quite difficult to programmatically determine and remove unused files, and you wouldn’t want to have to do the manual work multiple times.

[jasnell]

I'd be -1 on this for now. I'd like to see the vendored dep made smaller or made explicitly opt in.