Skip to content
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

Rule proposal: require-description #40

Closed
ota-meshi opened this issue May 10, 2020 · 3 comments · Fixed by #44
Closed

Rule proposal: require-description #40

ota-meshi opened this issue May 10, 2020 · 3 comments · Fixed by #44

Comments

@ota-meshi
Copy link
Contributor

Please describe what the rule should do:

This rule reports directive comments without description.

What category of rule is this? (place an "X" next to just one item)

[ ] Warns about a potential error (problem)
[ ] Suggests an alternate way of doing something (suggestion)
[ ] Enforces code style (layout)
[X] Other (please specify:)

Provide 2-3 code examples that this rule will warn about:

/* eslint-disable */
/* eslint-disable rule-name */
/* global _ */
/* eslint-env node */

No warning is given if the directive comment contains an description.

/* eslint-disable -- description */
/* eslint-disable rule-name -- description */
/* global _ -- description */
/* eslint-env node -- description */

May need an option to set whether or not to warn depending on the type of directives.

@mysticatea
Copy link
Owner

Sounds good to me!

@nemoDreamer
Copy link

I was just considering opening a pull-request for this! ❤️
Thanks, @ota-meshi !!

@dimitropoulos
Copy link

thanks again for doing this: it inspired me to do typescript-eslint/typescript-eslint#2099

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants