This repository has been archived by the owner on Mar 25, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 887
Fix behavior of jsRules:true to include explicitly disabled rules. #4517
Merged
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
UselessPickles
commented
Feb 14, 2019
@@ -151,7 +152,9 @@ describe("Configuration", () => { | |||
rawConfig = { | |||
jsRules: true, | |||
rules: { | |||
eofline: true, | |||
// valid rule for JS, disabled (should be copied over) | |||
eofline: false, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tweaked this existing test case to cover the new behavior of keeping disabled rules
UselessPickles
commented
Feb 14, 2019
@@ -31,7 +31,7 @@ configure which rules get run and each of their options. | |||
- Legacy: A boolean value may be specified instead of the above object, and is equivalent to setting no options with default severity. | |||
- Any rules specified in this block will override those configured in any base configuration being extended. | |||
- [Check out the full rules list here][3]. | |||
- `jsRules?: any | boolean`: Same format as `rules` or explicit `true` to copy all valid active rules from rules. These rules are applied to `.js` and `.jsx` files. | |||
- `jsRules?: any | boolean`: Same format as `rules` or explicit `true` to copy all rule configurations for JS-compatible rules from `rules`. These rules are applied to `.js` and `.jsx` files. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Documentation is clarified
Am I supposed to add an entry to CHANGELOG.md as part of this PR? |
@UselessPickles nope, those entries get autogenerated by the release script |
adidahiya
approved these changes
Feb 23, 2019
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
PR checklist
Overview of change:
Changed behavior of
jsRules:true
to copy over ALL rule configurations that are compatible with JS, including any that are explicitly disabled.Is there anything you'd like reviewers to focus on?
The original PR (#3641) that added
jsRules:true
functionality seemed to make a point to describe its desired/implemented behavior to copy over all "active" rules that are valid for JS. Does the term "active" mean something special that is not simply "those that are not disabled"? Is there still some kind of rule configurations that I should be skipping over?CHANGELOG.md entry:
[bugfix] Explicit disabling of rules is now copied over to jsRules when using jsRules:true