feat: add whitelist of rules directives can be used to disable #208
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This changeset adds `eslint-plugin-eslint-comments` and a [set of rules](https://github.com/mysticatea/eslint-plugin-eslint-comments/blob/d2d21f2496232248370da851d7dbd634e2a37d87/lib/configs/recommended.js) intended to help prevent abuse of `eslint-disable` comments and to provide feedback when `eslint-disable`s can be removed. Closes #204.
ndhoule
changed the title
WIP: This is not yet a complete list. If you routinely need to disable rules for valid reasons, add your rules here along with a justification! This changeset adds a whitelist of list of rules that can be disabled by eslint directives (e.g. `/* eslint-disable rule-name-here */`). As a starting point, no rules can be disabled via directives. A few exceptions have been added to the list. We should aim to keep this list as short as possible. Developers can still disable rules by modifying their project's ESLint configuration, which is much easier to catch in review because new features and bugfixes generally shouldn't require lint configuration changes. (A nice side effect that can fall out of this is that restricting where we can make lint configuration changes will allow us to do things like set up `policy-bot` rules that require additional approvals when a PR modifies a lint configuration to help us make sure we upstream lint configuration changes into the common lint config.)
ndhoule
force-pushed
the
feat/prevent-abusive-eslint-disables-v3
branch
from
ad78cdd to
a3cc67b
Compare
ndhoule
force-pushed
the
feat/prevent-abusive-eslint-disables-v2
branch
3 times, most recently
from
ad09e5a to
ba64cb6
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
WIP: This is not yet a complete list. If you routinely need to disable
rules for valid reasons, add your rules here along with a justification!
This changeset adds a whitelist of list of rules that can be disabled by
eslint directives (e.g.
/* eslint-disable rule-name-here */). As astarting point, no rules can be disabled via directives. A few
exceptions have been added to the list. We should aim to keep this list
as short as possible.
Developers can still disable rules by modifying their project's ESLint
configuration, which is much easier to catch in review because new
features and bugfixes generally shouldn't require lint configuration
changes. (A nice side effect that can fall out of this is that
restricting where we can make lint configuration changes will allow us
to do things like set up
policy-botrules that require additionalapprovals when a PR modifies a lint configuration to help us make sure
we upstream lint configuration changes into the common lint config.)