emulsify-ds / compound

Compound is the default component collection for Emulsify
https://emulsify-ds.github.io/compound/
GNU General Public License v2.0
12 stars 12 forks source link

Feat: JSdoc Eslint Plugin #63

Closed callinmullaney closed 1 year ago

callinmullaney commented 1 year ago

Summary Adds a new plugin to existing Eslint setup that allows us to check formatting of javascript comments. See: https://jsdoc.app/about-getting-started.html

Explain the motivation for making this change. What existing problem does the pull request solve?

Documentation Update (required)

How to review this PR

ryanhagerty commented 1 year ago

@callinmullaney LGTM - feels like Typescript Lite.

Since this is open-source, I'm def for this kind of documentation. But as an unrelated aside, I'm hesitant about this in client projects - at least at the level of recommended settings. I'm not sure a six line function whose greatest complexity is click needs a seven line comment. πŸ˜΅β€πŸ’«

Anywho, that's just my grumbly old man comment, good job getting this set up 🍟

callinmullaney commented 1 year ago

ToDo: Add documentation to the README regarding this linting addition. Link to JSdoc plugin, how to use it, and how to disable it completely.

github-actions[bot] commented 1 year ago

:tada: This PR is included in version 1.7.0 :tada:

The release is available on GitHub release

Your semantic-release bot :package::rocket: