Add eslint JSDoc checks

[Aljullu]

This PR installs eslint-plugin-jsdoc and enables some of the default rules. I tried to enable only the rules that were consistent with the current use we did of JSDoc.

How to test the changes in this Pull Request:

1. Run npm run lint and verify there are no errors.

[nerrad]

I'm curious, it seems like a lot of the package dependencies (including eslint-jsdoc) are provided by virtue of @wordpress/scripts which in turn exposes @wordpress/eslint-plugin (see here). Would it simplify our package maintenance if we rely on what is exposed by @wordpress/scripts more?

[Aljullu]

Would it simplify our package maintenance if we rely on what is exposed by @wordpress/scripts more?

Good point, I agree we should try to use upstream configs instead of duplicating them in our repo. Take a look at a6dc1bb and let me know how it looks. 🙂 I had to disable a couple of rules that were generating many errors.

including eslint-jsdoc

If I'm reading it correctly, eslint-plugin-jsdoc was added just a couple of days ago (WordPress/gutenberg#16869) so it's not yet in the last version, right? Anyway, I'm fine using the defaults and once the package updates we will get eslint-plugin-jsdoc enabled in our repo too.

[nerrad]

so it's not yet in the last version, right?

Oops, ya you're right!

Anyway, I'm fine using the defaults and once the package updates we will get eslint-plugin-jsdoc enabled in our repo too.

Works for me :)

I still think our dependency tree has some unnecessary definitions in it (I've commented specifically where). I may be wrong though so push back appropriately 😃

[Aljullu]

Thanks for the reviews @nerrad. This should be ready for another look.

[nerrad]

👍 🎉