Skip to content

require-jsdoc: add exemptEmptyConstructors as default #605

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 8, 2020

Conversation

brettz9
Copy link
Collaborator

@brettz9 brettz9 commented Jul 6, 2020

feat(require-jsdoc): add exemptEmptyConstructors and set true as default; fixes #600

If true will prevent empty constructors from needing documentation.

Also adds checkConstructors, checkGetters, and checkSetters options (default true) to allow the complete disabling of checks on these methods as per other require-* rules.

Is "light breaking" in that it will stop checking empty constructors, but even I don't think it really requires a breaking change.

@brettz9 brettz9 requested a review from golopot July 6, 2020 03:44
@brettz9 brettz9 force-pushed the exemptEmptyConstructors branch from ae91ae8 to 759cb86 Compare July 6, 2020 05:23
…s default; fixes gajus#600

If `true` will prevent empty constructors from needing documentation.

Also adds `checkConstructors`, `checkGetters`, and `checkSetters` options (default `true`) to allow the complete disabling of checks on these methods as per other require-* rules.
@brettz9 brettz9 force-pushed the exemptEmptyConstructors branch from 759cb86 to 187d669 Compare July 8, 2020 06:29
@brettz9 brettz9 merged commit 5409f25 into gajus:master Jul 8, 2020
@gajus
Copy link
Owner

gajus commented Jul 8, 2020

🎉 This PR is included in version 28.7.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@gajus gajus added the released label Jul 8, 2020
@brettz9 brettz9 deleted the exemptEmptyConstructors branch July 8, 2020 06:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

require-jsdoc exemptEmptyFunctions and class constructors
2 participants