Fix overriding a rule with a disable one #274
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
|
@djtarazona Could you have a look at this PR and merge it if it's ok? Additionally, I have 2 other open PR (#278 and #269) that would be great if you could have a look at them. Thanks in advance! |
|
@mdaloia Feel free to resolve the conflicts and I'll take another look at merging this in. Thanks! |
added 2 commits
May 19, 2019 13:02
If we want to disable a rule from an inherited set of rules through overriding it in the child ruleset the disabled rule is not created but the rule from the parent is left on the set of active rules. This fix this situation by deleting the rule (if exists) from the set of active rules if the most specific rule is declared as disabled.
In order to avoid the 'enabled' property we adapt it to 'disabled' (only if 'disabled' is not already defined). Also, it emits a warning in the console about this deprecated property and its replacement.
mdaloia
force-pushed
the
fix-override-with-disabled-rule
branch
from
6326bec to
e0e6067
Compare
|
@djtarazona Done! Fixed and rebased with master. Thanks |
djtarazona
approved these changes
Jun 16, 2019
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.
If we want to disable a rule from an inherited set of rules through overriding it in the child ruleset (*) the disabled rule is not created but the rule from the parent is left on the set of active rules.
Example:
(
openapi-tags-alphabeticalis defined indefault)This fix this situation by deleting the rule (if exists) from the set of active rules if the most specific rule is declared as disabled.
I took the liberty to add a deprecation message with an estimated version in which the
enabledproperty would be removed. I can revert it if you think that it is not necessary.The lines range 16-22 should be removed when
enabledis deleted.(*): Another option would be using
skipbut I think this option more like a temporal option used under some situation while you develop. Having it disabled in the ruleset is more organized (and, for example, you can leave a comment why you are disabling it).