Fix FP S2871 (no-alphabetical-sort): Rework the rule to emit a dedicated message for arrays of strings
#4539
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
ericmorand-sonarsource
force-pushed
the
issue-4531-S2871
branch
from
18accf6
to
cb85a97
Compare
| @@ -53,6 +53,8 @@ export const rule: Rule.RuleModule = { | |||
| messages: { | |||
| provideCompareFunction: | |||
| 'Provide a compare function to avoid sorting elements alphabetically.', | |||
| provideCompareFunctionForArrayOfStrings: | |||
| 'Provide a compare function that depends on String.localeCompare, to reliably sort elements alphabetically.', | |||
There was a problem hiding this comment.
This looks great!
There was a problem hiding this comment.
Suggested change
| 'Provide a compare function that depends on String.localeCompare, to reliably sort elements alphabetically.', | |
| 'Provide a compare function that depends on "String.localeCompare", to reliably sort elements alphabetically.', |
| @@ -606,6 +606,8 @@ ruleTester.run( | |||
| code: 'const array = ["foo", "bar"]; const sortedArray = array.toSorted();', | |||
| errors: [ | |||
| { | |||
| message: | |||
| 'Provide a compare function that depends on String.localeCompare, to reliably sort elements alphabetically.', | |||
There was a problem hiding this comment.
Might need to apply this suggestion if you applied the one I suggested above.
Suggested change
| 'Provide a compare function that depends on String.localeCompare, to reliably sort elements alphabetically.', | |
| 'Provide a compare function that depends on "String.localeCompare", to reliably sort elements alphabetically.', |
Comment on lines
34
to
43
| <h3>Exceptions</h3> | ||
| <p>The rule ignores arrays that only contain strings, or are declared as such.</p> | ||
| <pre> | ||
| const names = ['foo', 'bar']; | ||
| names.sort(); // Compliant | ||
| </pre> | ||
| <pre> | ||
| const names: string[] = []; | ||
| names.sort(); // Compliant | ||
| </pre> |
There was a problem hiding this comment.
I guess the exception no longer holds and we can get rid of this from the RSPEC, right?
|
We could also update the PR's title since it's no longer about adding an exception for string arrays but rather having a specific message for string arrays. |
ericmorand-sonarsource
force-pushed
the
issue-4531-S2871
branch
from
cb85a97
to
24b3623
Compare
|
ericmorand-sonarsource
changed the title
no-alphabetical-sort): Add exception for string arraysno-alphabetical-sort): Rework the rule to emit a dedicated message for arrays of strings
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 #4531