Split configs rule doc notice into separate lines by severity
#311
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
ddzz
approved these changes
Nov 29, 2022
ljharb
reviewed
Nov 29, 2022
| @@ -151,9 +140,9 @@ const RULE_NOTICES: { | |||
| ), | |||
| ] | |||
| .filter(Boolean) | |||
| .join(' '); | |||
| .join('\n\n'); | |||
There was a problem hiding this comment.
We currently separate all notices with a blank line:
💼 This rule is enabled in the ✅ recommended config.
🚫 This rule is disabled in the other config.
Are you suggesting grouping these related notices together like:
💼 This rule is enabled in the ✅ recommended config.
🚫 This rule is disabled in the other config.
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.
Split onto separate lines for clarity. A rule that is enabled/disabled/warn by multiple configs is a relatively uncommon situation to begin with.
Fixes #310.
Before:
💼🚫 This rule is enabled in the ✅
recommendedconfig. This rule is disabled in theotherconfig.After:
recommendedconfig.🚫 This rule is disabled in the ⌨️
typescriptconfig.