-
-
Notifications
You must be signed in to change notification settings - Fork 155
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
Option to require a docblock for the file? #55
Comments
I would like to see us add a new rule for this, maybe Edit July 2019: more than a few days have passed and I haven't done it. |
@bary12 Are you available to a PR for this? |
@gajus Unfortunately no |
I was thinking of tweaking my current PR for this (#464), to allow a whitelist of other tags to check since some other tags such as the following might, in at least some cases, be desirable as one per file (or 1+ per file): I'd also like to allow this whitelist to tweak the behavior per tag since the rule as it is currently not only checks that a given tag is present, but also currently checks that there are no duplicates and that it is not preceded by any non-comment code (a project might wish to allow some tags like
Update: I've now filed #469 for this purpose. |
🎉 This issue has been resolved in version 18.7.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
A lot of the focus of docblocks is on functions, so this may not be a common need, but I'm wondering whether it might be worth an option to require a docblock at the top of the file?
There is at least one jsdoc tag that is specifically for use in a file docblock, so the concept is at least supported.
The text was updated successfully, but these errors were encountered: