Add explicit category ordering configuration for organizeDeclarations rule #280
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
mannylopez
approved these changes
Jul 22, 2024
bachand
reviewed
Jul 23, 2024
| @@ -27,6 +27,8 @@ | |||
| --structthreshold 20 # organizeDeclarations | |||
| --enumthreshold 20 # organizeDeclarations | |||
| --organizetypes class,struct,enum,extension,actor # organizeDeclarations | |||
| --visibilityorder beforeMarks,instanceLifecycle,open,public,package,internal,fileprivate,private # organizeDeclarations | |||
| --typeorder nestedType,staticProperty,staticPropertyWithBody,classPropertyWithBody,instanceProperty,instancePropertyWithBody,staticMethod,classMethod,instanceMethod # organizeDeclarations | |||
There was a problem hiding this comment.
@calda is it expected that there is no classProperty?
There was a problem hiding this comment.
There's no such thing as a stored class property (aka a class property without a body)! Found this out when I was first working on the organizeDeclarations rule: https://forums.swift.org/t/class-properties/16539
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.
As of nicklockwood/SwiftFormat#1736, the
organizeDeclarationsrule is now fully configurable, and lets you specify the sort order of declarations. The default behavior of theorganizeDeclarationsis now different from the behavior defined in our style guide. To keep the behavior we want, we can provide our own configuration explicitly.The corresponding configuration that matches our style guide is: