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

Allows require-description to be turned off for specific rules #142

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

mcongrove
Copy link

@mcongrove mcongrove commented Nov 8, 2023

Adds a new option to require-description, called disableForRules, which allows you to pass an array of rules that require-description will not apply to.

Example usage:

"@eslint-community/eslint-comments/require-description": [
	"error",
	{ disableForRules: ["no-unused-vars"] },
],

This can be especially helpful for overrides which are self-evident amongst users of the codebase.

Requested by #134.

@mcongrove mcongrove changed the title #134 Allows require-description to be turned off for specific rules Allows require-description to be turned off for specific rules Nov 8, 2023
@mcongrove
Copy link
Author

@ota-meshi @MichaelDeBoey

Hate to ping y'all, but I'm not sure if you were notified this PR was here because I can't request a reviewer.

@github-actions github-actions bot added the Stale label Feb 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants