Support automatic sorting by name pattern for sortDeclarations rule
#1731
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #1731 +/- ##
===========================================
- Coverage 95.24% 95.21% -0.03%
===========================================
Files 20 20
Lines 23284 23323 +39
===========================================
+ Hits 22176 22207 +31
- Misses 1108 1116 +8 ☔ View full report in Codecov by Sentry. |
Rules.md
Outdated
| Option | Description | ||
| --- | --- | ||
| `--sortedpatterns` | List of patterns to sort alphabetically without `:sort` mark. | ||
| `--sortedtypes` | default: `class,actor,struct,enum,protocol,extension` |
There was a problem hiding this comment.
I don't really understand the purpose of the --sortedtypes option.
Reading the code, it looks like the set of --sortedpatterns values only trigger a type to be sorted if the declaration kind is also included in --sortedtypes. Is that right?
Is there a use case you have in mind for this? When would you want --sortedpatterns to not apply to all kinds of declarations?
There was a problem hiding this comment.
tbh I just needed a list of top-level declarations to sort. I've made an array of swiftTypeKeywordsto look at in parsing helpers and something clicked in me to making it into configurable parameter as in organizeDeclarations if I, for example, don't want to sort protocol declarations. I guess if it's not the case I can remove this parameter as redundant and just stick with swiftTypeKeywords, i don't have a strong opinion here
There was a problem hiding this comment.
Since we don't have a concrete use case in mind for this, to keep things simple I think it would be better to remove the --sortedtypes options and just refer to the hardcoded list of swiftTypeKeywords that you added.
There was a problem hiding this comment.
done, thanks for your comments!
| @@ -4123,6 +4123,48 @@ class OrganizationTests: RulesTests { | |||
| exclude: ["blankLinesAtEndOfScope"]) | |||
| } | |||
|
|
|||
| func testSortDeclarationsSortsByNamePattern() { | |||
There was a problem hiding this comment.
Thanks for following up on this!
This comment was marked as off-topic.
This comment was marked as off-topic.
Changes referenced from previous pull request by @calda