Add SwiftFormat void rule #288
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
calda
reviewed
Aug 21, 2024
README.md
Outdated
| @@ -3677,6 +3677,39 @@ _You can enable the following settings in Xcode by running [this script](resourc | |||
|
|
|||
| </details> | |||
|
|
|||
| * <a id='generic-void'></a>(<a href='#generic-void'>link</a>) **Avoid using `()` as a generic type**. Prefer `Void`. | |||
There was a problem hiding this comment.
Instead of saying "Avoid using () as a generic type" maybe we should say "Avoid using () as a type"
e.g. the rule would convert let result: () to let result: Void (right?) but that's not covered by the "generic type" wording here
There was a problem hiding this comment.
Good point, let me update it
calda
reviewed
Aug 21, 2024
README.md
Outdated
Comment on lines
3685
to
3690
| struct Wrapper<T> { ... } | ||
| // WRONG | ||
| let wrapper = Wrapper<()>() | ||
|
|
||
| // RIGHT | ||
| let wrapper = Wrapper<Void>() |
There was a problem hiding this comment.
Maybe we use Result instead. Result<Void, Error> is pretty common.
Suggested change
| struct Wrapper<T> { ... } | |
| // WRONG | |
| let wrapper = Wrapper<()>() | |
| // RIGHT | |
| let wrapper = Wrapper<Void>() | |
| // WRONG | |
| let result: Result<(), Error> | |
| // RIGHT | |
| let result: Result<Void, Error> |
calda
reviewed
Aug 21, 2024
README.md
Outdated
Comment on lines
3699
to
3709
| struct Resolver<T> { | ||
| func resolve(T) { ... } | ||
| } | ||
|
|
||
| let resolver = Resolver() | ||
|
|
||
| // WRONG | ||
| resolver.resolve(Void()) | ||
|
|
||
| // RIGHT | ||
| resolver.resolve(()) |
There was a problem hiding this comment.
We could use Result here as well
Suggested change
| struct Resolver<T> { | |
| func resolve(T) { ... } | |
| } | |
| let resolver = Resolver() | |
| // WRONG | |
| resolver.resolve(Void()) | |
| // RIGHT | |
| resolver.resolve(()) | |
| let completion: (Result<Void, Error>) -> Void | |
| // WRONG | |
| completion(.success(Void())) | |
| // RIGHT | |
| completion(.success(())) |
calda
reviewed
Aug 21, 2024
| @@ -6,7 +6,6 @@ only_rules: | |||
| - legacy_constructor | |||
| - legacy_nsgeometry_functions | |||
| - unused_optional_binding | |||
| - void_return # TODO: Replace with SwiftFormat void rule | |||
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.
Summary
This PR replaces the SwiftLint
void_returnin favor to the SwiftFormatvoidrule in conjunction with the existingredundantVoidReturnTypewhich cover the same functionality and additional rules described in the PR.Reasoning
This is an effort to migrate all autocorrect rules to SwiftFormat