dnrops
/
SwiftLint
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add new `duplicate_conditions` rule (#4771)

This commit is contained in:
1in1 2023-03-05 10:05:23 +00:00 committed by GitHub
parent 4f9a608cf4
commit 4fee8e6a0c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 236 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
CHANGELOG.md
View File

@ -18,6 +18,11 @@
#### Enhancements
* Add `duplicate_conditions` rule which warns when a condition is duplicated
in separate branches of the same branching statement (if-else, or switch).
[1in1](https://github.com/1in1)
[#4666](https://github.com/realm/SwiftLint/issues/4666)
* Add local links to rule descriptions to every rule listed
in `Rule Directory.md`.
[kattouf](https://github.com/kattouf)

1
Source/SwiftLintFramework/Models/PrimaryRuleList.swift
View File

@ -43,6 +43,7 @@ let builtInRules: [Rule.Type] = [
DiscouragedObjectLiteralRule.self,
DiscouragedOptionalBooleanRule.self,
DiscouragedOptionalCollectionRule.self,
DuplicateConditionsRule.self,
DuplicateEnumCasesRule.self,
DuplicateImportsRule.self,
DuplicatedKeyInDictionaryLiteralRule.self,

223
Source/SwiftLintFramework/Rules/Lint/DuplicateConditionsRule.swift Normal file
View File

@ -0,0 +1,223 @@
import SwiftSyntax
struct DuplicateConditionsRule: SwiftSyntaxRule, ConfigurationProviderRule {
var configuration = SeverityConfiguration(.error)
init() {}
static let description = RuleDescription(
identifier: "duplicate_conditions",
name: "Duplicate Conditions",
description: "Duplicate sets of conditions in the same branch instruction should be avoided",
kind: .lint,
nonTriggeringExamples: [
Example("""
if x < 5 {
foo()
} else if y == "s" {
bar()
}
"""),
Example("""
if x < 5 {
foo()
}
if x < 5 {
bar()
}
"""),
Example("""
if x < 5, y == "s" {
foo()
} else if x < 5 {
bar()
}
"""),
Example("""
switch x {
case \"a\":
foo()
bar()
}
"""),
Example("""
switch x {
case \"a\" where y == "s":
foo()
case \"a\" where y == "t":
bar()
}
"""),
Example("""
if let x = maybeAbc {
foo()
} else if let x = maybePqr {
bar()
}
"""),
Example("""
if let x = maybeAbc, let z = x.maybeY {
foo()
} else if let x = maybePqr, let z = x.maybeY {
bar()
}
"""),
Example("""
if case .p = x {
foo()
} else if case .q = x {
bar()
}
"""),
Example("""
if true {
if true { foo() }
}
""")
],
triggeringExamples: [
Example("""
if ↓x < 5 {
foo()
} else if y == "s" {
bar()
} else if ↓x < 5 {
baz()
}
"""),
Example("""
if z {
if ↓x < 5 {
foo()
} else if y == "s" {
bar()
} else if ↓x < 5 {
baz()
}
}
"""),
Example("""
if ↓x < 5, y == "s" {
foo()
} else if x < 10 {
bar()
} else if ↓y == "s", x < 5 {
baz()
}
"""),
Example("""
switch x {
case ↓\"a\", \"b\":
foo()
case \"c\", ↓\"a\":
bar()
}
"""),
Example("""
switch x {
case ↓\"a\" where y == "s":
foo()
case ↓\"a\" where y == "s":
bar()
}
"""),
Example("""
if ↓let xyz = maybeXyz {
foo()
} else if ↓let xyz = maybeXyz {
bar()
}
"""),
Example("""
if ↓let x = maybeAbc, let z = x.maybeY {
foo()
} else if ↓let x = maybeAbc, let z = x.maybeY {
bar()
}
"""),
Example("""
if ↓#available(macOS 10.15, *) {
foo()
} else if ↓#available(macOS 10.15, *) {
bar()
}
"""),
Example("""
if ↓case .p = x {
foo()
} else if ↓case .p = x {
bar()
}
"""),
Example("""
if ↓x < 5 {}
else if ↓x < 5 {}
else if ↓x < 5 {}
""")
]
)
func makeVisitor(file: SwiftLintFile) -> ViolationsSyntaxVisitor {
Visitor(viewMode: .sourceAccurate)
}
}
private extension DuplicateConditionsRule {
final class Visitor: ViolationsSyntaxVisitor {
override func visitPost(_ node: IfExprSyntax) {
if node.parent?.is(IfExprSyntax.self) == true {
// We can skip these cases - they will be picked up when we visit the top level `if`
return
}
var maybeCurr: IfExprSyntax? = node
var statementChain: [IfExprSyntax] = []
while let curr = maybeCurr {
statementChain.append(curr)
maybeCurr = curr.elseBody?.as(IfExprSyntax.self)
}
let positionsByConditions = statementChain
.reduce(into: [Set<String>: [AbsolutePosition]]()) { acc, elt in
let conditions = elt.conditions.map {
$0.condition.debugDescription(includeChildren: true, includeTrivia: false)
}
let location = elt.conditions.positionAfterSkippingLeadingTrivia
acc[Set(conditions), default: []].append(location)
}
addViolations(Array(positionsByConditions.values))
}
override func visitPost(_ node: SwitchCaseListSyntax) {
let switchCases = node.compactMap { $0.as(SwitchCaseSyntax.self) }
let positionsByCondition = switchCases
.reduce(into: [String: [AbsolutePosition]]()) { acc, elt in
// Defaults don't have a condition to worry about
guard case let .case(caseLabel) = elt.label else { return }
for caseItem in caseLabel.caseItems {
let pattern = caseItem
.pattern
.debugDescription(includeChildren: true, includeTrivia: false)
let whereClause = caseItem
.whereClause?
.debugDescription(includeChildren: true, includeTrivia: false)
?? ""
let location = caseItem.positionAfterSkippingLeadingTrivia
acc[pattern + whereClause, default: []].append(location)
}
}
addViolations(Array(positionsByCondition.values))
}
private func addViolations(_ positionsByCondition: [[AbsolutePosition]]) {
let duplicatedPositions = positionsByCondition
.filter { $0.count > 1 }
.flatMap { $0 }
violations.append(contentsOf: duplicatedPositions)
}
}
}

8
Tests/GeneratedTests/GeneratedTests.swift
View File

@ -1,4 +1,4 @@
// Generated using Sourcery 2.0.0 — https://github.com/krzysztofzablocki/Sourcery
// Generated using Sourcery 2.0.1 — https://github.com/krzysztofzablocki/Sourcery
// DO NOT EDIT
@_spi(TestHelper)
@testable import SwiftLintFramework
@ -241,6 +241,12 @@ class DiscouragedOptionalCollectionRuleGeneratedTests: XCTestCase {
}
}
class DuplicateConditionsRuleGeneratedTests: XCTestCase {
func testWithDefaultConfiguration() {
verifyRule(DuplicateConditionsRule.description)
}
}
class DuplicateEnumCasesRuleGeneratedTests: XCTestCase {
func testWithDefaultConfiguration() {
verifyRule(DuplicateEnumCasesRule.description)