-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2308 from Dschee/conditional-returns-on-newline
Add `if_only` option to rule conditional_returns_on_newline
- Loading branch information
Showing
8 changed files
with
98 additions
and
20 deletions.
There are no files selected for viewing
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
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
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
30 changes: 30 additions & 0 deletions
30
...wiftLintFramework/Rules/RuleConfigurations/ConditionalReturnsOnNewlineConfiguration.swift
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| import Foundation | ||
|
|
||
| public struct ConditionalReturnsOnNewlineConfiguration: RuleConfiguration { | ||
| private(set) var severityConfiguration = SeverityConfiguration(.warning) | ||
| private(set) var ifOnly = false | ||
|
|
||
| public var consoleDescription: String { | ||
| return [severityConfiguration.consoleDescription, "if_only: \(ifOnly)"].joined(separator: ", ") | ||
| } | ||
|
|
||
| public mutating func apply(configuration: Any) throws { | ||
| guard let configuration = configuration as? [String: Any] else { | ||
| throw ConfigurationError.unknownConfiguration | ||
| } | ||
|
|
||
| ifOnly = configuration["if_only"] as? Bool ?? false | ||
|
|
||
| if let severityString = configuration["severity"] as? String { | ||
| try severityConfiguration.apply(configuration: severityString) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| extension ConditionalReturnsOnNewlineConfiguration: Equatable { | ||
| public static func == (lhs: ConditionalReturnsOnNewlineConfiguration, | ||
| rhs: ConditionalReturnsOnNewlineConfiguration) -> Bool { | ||
| return lhs.severityConfiguration == rhs.severityConfiguration && | ||
| lhs.ifOnly == rhs.ifOnly | ||
| } | ||
| } |
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
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
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
37 changes: 37 additions & 0 deletions
37
Tests/SwiftLintFrameworkTests/ConditionalReturnsOnNewlineRuleTests.swift
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| @testable import SwiftLintFramework | ||
| import XCTest | ||
|
|
||
| class ConditionalReturnsOnNewlineRuleTests: XCTestCase { | ||
| func testConditionalReturnsOnNewlineWithDefaultConfiguration() { | ||
| // Test with default parameters | ||
| verifyRule(ConditionalReturnsOnNewlineRule.description) | ||
| } | ||
|
|
||
| func testConditionalReturnsOnNewlineWithIfOnly() { | ||
| // Test with `if_only` set to true | ||
| let nonTriggeringExamples = [ | ||
| "guard true else {\n return true\n}", | ||
| "guard true,\n let x = true else {\n return true\n}", | ||
| "if true else {\n return true\n}", | ||
| "if true,\n let x = true else {\n return true\n}", | ||
| "if textField.returnKeyType == .Next {", | ||
| "if true { // return }", | ||
| "/*if true { */ return }", | ||
| "guard true else { return }" | ||
| ] | ||
| let triggeringExamples = [ | ||
| "↓if true { return }", | ||
| "↓if true { break } else { return }", | ||
| "↓if true { break } else { return }", | ||
| "↓if true { return \"YES\" } else { return \"NO\" }" | ||
| ] | ||
|
|
||
| let alwaysOnSameLineDescription = ConditionalReturnsOnNewlineRule.description | ||
| .with(triggeringExamples: triggeringExamples) | ||
| .with(nonTriggeringExamples: nonTriggeringExamples) | ||
|
|
||
| verifyRule(alwaysOnSameLineDescription, | ||
| ruleConfiguration: ["if_only": true]) | ||
|
|
||
| } | ||
| } |