-
Notifications
You must be signed in to change notification settings - Fork 45
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: allow type: unsorted
for all remaining rules
#468
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
type: unsorted
for all remaining rulestype: unsorted
for all remaining rules
type: unsorted
for all remaining rulestype: unsorted
for all remaining rules
fc9679b
to
53151e7
Compare
- It was only handled in `customGroups` and a test was missing.
49451a8
to
ab44220
Compare
- We will be adding additional tests in the next commit
ab44220
to
73e2a73
Compare
azat-io
approved these changes
Feb 13, 2025
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.
Most of the added lines are documentation and tests.
Description
Today, only the following rules support
type: unsorted
directly in theoptions
object (meaning: outside ofcustomGroups
)sort-array-includes
sort-sets
sort-maps
(is supposed to but actually isn't due to its JSON schema, and a test is missing about that)sort-objects
sort-interfaces
sort-object-types
These rules support this feature because they have a
useConfigurationIf
option, which synergizes well together.The problem
The current implementation of
type: unsorted
is simple, but is lacking as it returns very early. As such,newlinesBetween
.groups
.Users may want to
type: unsorted
with:newlinesBetween
, in order not to enforce sorting order, but to enforce no newline between elements.groups
, to enforce grouping, but not enforce any sorting other than required dependency sort.Making all rules handle
type: unsorted
also makes the codebase more uniform: it's better if all rules can handle as many things in common as possible!Proposal
This PR focuses on the following:
type: unsorted
from returning early and ignoringnewlinesBetween
andgroups
options.type: unsorted
for all remaining rules that did not support it.The two implementation commits are:
58b912a
(#468)1062616
(#468)Commit split
sort-maps
not handlingtype: unsorted
when it should already be.type: unsorted
.type: unsorted
for all remaining rules.Impacted tests
No test was removed or had its content updated.
What is the purpose of this pull request?