Files
Danny Mösch 40bd97038a Support arbitrary configurations in @SwiftSyntaxRule (#5275)
Almost all rules based on SwiftSyntax can be set up now by just adding
`@SwiftSyntaxRule` to the rule struct.
2023-10-16 19:34:43 +02:00

46 lines
1.6 KiB
Swift

import SwiftSyntax
@SwiftSyntaxRule
struct EmptyStringRule: OptInRule {
var configuration = SeverityConfiguration<Self>(.warning)
static let description = RuleDescription(
identifier: "empty_string",
name: "Empty String",
description: "Prefer checking `isEmpty` over comparing `string` to an empty string literal",
kind: .performance,
nonTriggeringExamples: [
Example("myString.isEmpty"),
Example("!myString.isEmpty"),
Example("\"\"\"\nfoo==\n\"\"\"")
],
triggeringExamples: [
Example(#"myString↓ == """#),
Example(#"myString↓ != """#),
Example(#"myString↓=="""#),
Example(##"myString↓ == #""#"##),
Example(###"myString↓ == ##""##"###)
]
)
}
private extension EmptyStringRule {
final class Visitor: ViolationsSyntaxVisitor<ConfigurationType> {
override func visitPost(_ node: StringLiteralExprSyntax) {
guard
// Empty string literal: `""`, `#""#`, etc.
node.segments.onlyElement?.trimmedLength == .zero,
let previousToken = node.previousToken(viewMode: .sourceAccurate),
// On the rhs of an `==` or `!=` operator
previousToken.tokenKind.isEqualityComparison,
let secondPreviousToken = previousToken.previousToken(viewMode: .sourceAccurate)
else {
return
}
let violationPosition = secondPreviousToken.endPositionBeforeTrailingTrivia
violations.append(violationPosition)
}
}
}