Indicate when a rule is set to off/warn by a config in the README rules list #198
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
bmish
force-pushed
the
list-disabled-warn
branch
5 times, most recently
from
f25dc6f
to
2278e0e
Compare
bmish
force-pushed
the
list-disabled-warn
branch
from
2278e0e
to
8fd8767
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.
Fixes #182.
Previously, we had no way to indicate that a config set a rule to warn or off severity level in the README rules table. And we also didn't use a distinct emoji in the rule doc notice when indicating this.
Example of how the README rules table can now indicate when a config sets rules to warn or off:
✅ Enabled in the⚠️ Warns in the
recommendedconfiguration.✅
recommendedconfiguration.✅🚫 Disabled in the
recommendedconfiguration.Example of how a rule doc notice can now indicate when a config sets the rule to warn or off:
✅⚠️ This rule warns in the
recommendedconfig.✅🚫 This rule is disabled in the
recommendedconfig.