Make conditional_returns_on_newline rule autocorrectable #6489
+129
−2
Conversation
This file contains hidden or 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
Added a Rewriter class to automatically fix violations where return statements are on the same line as conditional keywords (if/guard). The autocorrection: - Adds a newline before the return statement - Preserves proper indentation (4 spaces from the conditional's indentation) - Handles both if/else and guard statements - Preserves preceding statements on the same line (e.g., XCTFail()) - Respects the if_only configuration option Added test for guard statement corrections. Co-authored-by: Shelley <shelley@exe.dev>
Here's an example of your CHANGELOG entry: * Make conditional_returns_on_newline rule autocorrectable.
[ldct](https://github.com/ldct)
[#issue_number](https://github.com/realm/SwiftLint/issues/issue_number)note: There are two invisible spaces after the entry's text. Generated by 🚫 Danger |
Co-authored-by: Shelley <shelley@exe.dev>
…orrectable Co-authored-by: Shelley <shelley@exe.dev>
Co-authored-by: Shelley <shelley@exe.dev>
SimplyDanny
requested changes
Feb 12, 2026
Collaborator
SimplyDanny
left a comment
SimplyDanny
left a comment
There was a problem hiding this comment.
That's a highly appreciated enhancement. Thanks for the contribution!
| Example("↓if true { break } else { return }"): | ||
| Example("if true { break } else {\n return\n}"), | ||
| Example("↓if true { return \"YES\" } else { return \"NO\" }"): | ||
| Example("if true {\n return \"YES\"\n} else { return \"NO\" }"), |
Collaborator
There was a problem hiding this comment.
Please add another example where the if is indented, e.g.
func f() {
if true { return }
}|
|
||
| func testGuardCorrection() { | ||
| // Test guard correction with default configuration | ||
| let corrections = [ |
Collaborator
There was a problem hiding this comment.
Can be part of the example list in the rule itself. Make sure, that violating guard examples don't get fixed when the if_only option is set.
Co-authored-by: Shelley <shelley@exe.dev>
- Added guard correction examples to the rule's corrections array - Updated if_only test to override corrections (excluding guard) - Removed separate testGuardCorrection since it's now tested via RuleDescription Co-authored-by: Shelley <shelley@exe.dev>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 adds autocorrection support to the
conditional_returns_on_newlinerule.Changes
Rewriterclass to automatically fix violations where return statements are on the same line as conditional keywords (if/guard)if/elseandguardstatementsXCTFail();)if_onlyconfiguration optionExample Corrections