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.

Sign up for GitHub

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

Jump to bottom

Enable comments/require-description rule #26

Closed
junyper opened this issue Jul 8, 2022 · 4 comments
Closed

Enable comments/require-description rule #26

junyper opened this issue Jul 8, 2022 · 4 comments
Labels
eslint
Milestone
v5

Comments

@junyper
Copy link

junyper commented Jul 8, 2022 •
edited
Loading

We might want to consider setting the require-description rule to encourage adding a description to explain why an eslint rule has been disabled. That might be best set as a warning vs an error since we will probably have a lot of failures to address.
@mrmckeb
Copy link
Contributor

mrmckeb commented Jul 11, 2022

Thanks for this @junyper!

We already use the plugin itself here:
https://github.com/vercel/style-guide/blob/canary/eslint/_base.js#L13

I love the idea of adding this rule, but we'll need to get more feedback before progressing.

@mrmckeb mrmckeb added the eslint label Jul 11, 2022
@junyper junyper changed the title Add eslint-plugin-comments Add eslint-plugin-comments require-description rule Jul 11, 2022
@junyper
Copy link
Author

junyper commented Jul 11, 2022

Ok. I edited this to reflect adding just that one rule.

@mrmckeb mrmckeb added this to the September 2022 milestone Sep 21, 2022
@mrmckeb
Copy link
Contributor

mrmckeb commented Sep 21, 2022

We still plan to do this, but want to add a codemod for this first.

@mrmckeb mrmckeb removed this from the September 2022 milestone Sep 21, 2022
@mrmckeb mrmckeb changed the title Add eslint-plugin-comments require-description rule Enable comments/require-description rule Sep 21, 2022
@mrmckeb mrmckeb added this to the v5 milestone Nov 16, 2022
mrmckeb added a commit that referenced this issue Aug 29, 2023
@mrmckeb
feat(eslint): enable comments/require-description
b62ba10 
Resolves #26

BREAKING CHANGE: ESLint disable directives (comments) now require a description. When migrating
to this version, you may want to disable this rule for some files.
mrmckeb added a commit that referenced this issue Aug 29, 2023
@mrmckeb
feat(eslint): enable comments/require-description
5c98c92 
Resolves #26

BREAKING CHANGE: ESLint disable directives (comments) now require a description. When migrating
to this version, you may want to disable this rule for some files.
mrmckeb added a commit that referenced this issue Aug 29, 2023
@mrmckeb
feat(eslint): enable comments/require-description
1432604 
Resolves #26

BREAKING CHANGE: ESLint disable directives (comments) now require a description. When migrating
to this version, you may want to disable this rule for some files.
mrmckeb added a commit that referenced this issue Aug 29, 2023
@mrmckeb
feat(eslint): enable comments/require-description
5717a7b 
Resolves #26

BREAKING CHANGE: ESLint disable directives (comments) now require a description. When migrating
to this version, you may want to disable this rule for some files.
mrmckeb added a commit that referenced this issue Aug 29, 2023
@mrmckeb
feat(eslint): enable comments/require-description
2312c2d 
Resolves #26

BREAKING CHANGE: ESLint disable directives (comments) now require a description. When migrating
to this version, you may want to disable this rule for some files.
mrmckeb added a commit that referenced this issue Aug 29, 2023
@mrmckeb
feat(eslint): enable comments/require-description
8876162 
Resolves #26

BREAKING CHANGE: ESLint disable directives (comments) now require a description. When migrating
to this version, you may want to disable this rule for some files.
@mrmckeb
Copy link
Contributor

mrmckeb commented Aug 29, 2023

🎉 This PR is included in version 5.0.0 🎉

The release is available on:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
eslint
Projects
None yet
Milestone
v5
Development

No branches or pull requests
2 participants
@junyper @mrmckeb