Set up ESLint for JSDoc comments

chaijs / chai

BDD / TDD assertion framework for node.js and the browser that can be paired with any testing framework.

https://chaijs.github.io

MIT License

8.11k stars 694 forks source link

Set up ESLint for JSDoc comments #1605

Closed koddsson closed 6 months ago

koddsson commented 6 months ago

I really want to explore both better typing and possible automatic generation of API docs since the JSDoc comments that exist in the codebase are of such high quality.

This PR introduces ESLint and eslint-plugin-jsdoc to start linting JSDoc comment in effort to make sure that all of the comments stay high quality as we refactor the code

This PR can be followed up by more changes to the rules we apply as well as some explorations into API documentation and stricter type-checking.

koddsson commented 6 months ago

lol, maybe I shouldn't have had it on auto-merge :D

I'll make a follow up PR to apply some of your suggestions @43081j