govuk-frontend
govuk-frontend copied to clipboard
Ensure presence of JSDoc tags describing access
trafficstars
What
Add ESLint rule to ensure functions, classes, properties and methods have a JSDoc tag describing their access (@public/@private/@internal).
Why
This will ensure our public API is clear and users know what our API supports and which bits are internal or private.
Who needs to work on this
Developers
Who needs to review this
Developers
Done when
- [ ] ESLint checks the presence of JSDoc tag describing symbol access
This comment proposes a possible route.