68 lines
1.8 KiB
Swift
68 lines
1.8 KiB
Swift
import SwiftSyntax
|
|
|
|
struct XCTFailMessageRule: SwiftSyntaxRule, ConfigurationProviderRule {
|
|
var configuration = SeverityConfiguration(.warning)
|
|
|
|
init() {}
|
|
|
|
static let description = RuleDescription(
|
|
identifier: "xctfail_message",
|
|
name: "XCTFail Message",
|
|
description: "An XCTFail call should include a description of the assertion.",
|
|
kind: .idiomatic,
|
|
nonTriggeringExamples: [
|
|
Example("""
|
|
func testFoo() {
|
|
XCTFail("bar")
|
|
}
|
|
"""),
|
|
Example("""
|
|
func testFoo() {
|
|
XCTFail(bar)
|
|
}
|
|
""")
|
|
],
|
|
triggeringExamples: [
|
|
Example("""
|
|
func testFoo() {
|
|
↓XCTFail()
|
|
}
|
|
"""),
|
|
Example("""
|
|
func testFoo() {
|
|
↓XCTFail("")
|
|
}
|
|
""")
|
|
]
|
|
)
|
|
|
|
func makeVisitor(file: SwiftLintFile) -> ViolationsSyntaxVisitor {
|
|
Visitor(viewMode: .sourceAccurate)
|
|
}
|
|
}
|
|
|
|
private extension XCTFailMessageRule {
|
|
final class Visitor: ViolationsSyntaxVisitor {
|
|
override func visitPost(_ node: FunctionCallExprSyntax) {
|
|
guard
|
|
let expression = node.calledExpression.as(IdentifierExprSyntax.self),
|
|
expression.identifier.text == "XCTFail",
|
|
node.argumentList.isEmptyOrEmptyString
|
|
else {
|
|
return
|
|
}
|
|
|
|
violations.append(node.positionAfterSkippingLeadingTrivia)
|
|
}
|
|
}
|
|
}
|
|
|
|
private extension TupleExprElementListSyntax {
|
|
var isEmptyOrEmptyString: Bool {
|
|
if isEmpty {
|
|
return true
|
|
}
|
|
return count == 1 && first?.expression.as(StringLiteralExprSyntax.self)?.isEmptyString == true
|
|
}
|
|
}
|