Refactor to improve types and docs for *-list rules
#5936
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
ybiquitous
commented
Feb 23, 2022
| @@ -80,7 +80,7 @@ testRule({ | |||
| ruleName, | |||
| skipBasicChecks: true, | |||
|
|
|||
| config: ['keyframes'], | |||
| config: 'keyframes', | |||
There was a problem hiding this comment.
[note] This change aims to test a single primary option value.
| const rule = (primary) => { | ||
| // To allow for just a string as a parameter (not only arrays of strings) | ||
| const primaryValues = [primary].flat(); |
There was a problem hiding this comment.
[note] validateOptions allows both a single value and an array, so it's better to call .flat() after the validation.
| message: messages.rejected('>'), | ||
| }, | ||
| ], | ||
| }); |
There was a problem hiding this comment.
[note] This new test case aims to just check a single primary value.
| * @param {string} value | ||
| * @param {string} comparison | ||
| * | ||
| * @param {unknown} comparison |
There was a problem hiding this comment.
[note] testAgainst() uses isString(), so it accepts the unknown argument.
jeddy3
approved these changes
Feb 23, 2022
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.
Follow-up of #5934
When I was looking into the problem of #5933 and #5934, I felt to check the
*-listrules again.So, this pull request aims to improve the docs and type of that rules for consistency and clarity.
It doesn't change the existing behavior.