Files
SwiftLint/Source/SwiftLintFramework/Rules/Style/SingleTestClassRule.swift
T
JP Simard 4bd7da32ea Reduce visibility of rules to be internal (#4533)
There's no reason to expose these publicly and this will make it nicer
to move to a new module outside of the core SwiftLint functionality.
2022-11-09 11:01:26 -05:00

81 lines
2.8 KiB
Swift

import SwiftSyntax
struct SingleTestClassRule: SourceKitFreeRule, OptInRule, ConfigurationProviderRule {
var configuration = SeverityConfiguration(.warning)
static let description = RuleDescription(
identifier: "single_test_class",
name: "Single Test Class",
description: "Test files should contain a single QuickSpec or XCTestCase class.",
kind: .style,
nonTriggeringExamples: [
Example("class FooTests { }\n"),
Example("class FooTests: QuickSpec { }\n"),
Example("class FooTests: XCTestCase { }\n")
],
triggeringExamples: [
Example("""
↓class FooTests: QuickSpec { }
↓class BarTests: QuickSpec { }
"""),
Example("""
↓class FooTests: QuickSpec { }
↓class BarTests: QuickSpec { }
↓class TotoTests: QuickSpec { }
"""),
Example("""
↓class FooTests: XCTestCase { }
↓class BarTests: XCTestCase { }
"""),
Example("""
↓class FooTests: XCTestCase { }
↓class BarTests: XCTestCase { }
↓class TotoTests: XCTestCase { }
"""),
Example("""
↓class FooTests: QuickSpec { }
↓class BarTests: XCTestCase { }
"""),
Example("""
↓class FooTests: QuickSpec { }
↓class BarTests: XCTestCase { }
class TotoTests { }
"""),
Example("""
final ↓class FooTests: QuickSpec { }
↓class BarTests: XCTestCase { }
class TotoTests { }
""")
]
)
init() {}
func validate(file: SwiftLintFile) -> [StyleViolation] {
let classes = TestClassVisitor(viewMode: .sourceAccurate)
.walk(tree: file.syntaxTree, handler: \.violations)
guard classes.count > 1 else { return [] }
return classes.map { position in
return StyleViolation(ruleDescription: Self.description,
severity: configuration.severity,
location: Location(file: file, position: position.position),
reason: "\(classes.count) test classes found in this file.")
}
}
}
private class TestClassVisitor: ViolationsSyntaxVisitor {
private let testClasses: Set = ["QuickSpec", "XCTestCase"]
override var skippableDeclarations: [DeclSyntaxProtocol.Type] { .all }
override func visitPost(_ node: ClassDeclSyntax) {
guard node.inheritanceClause.containsInheritedType(inheritedTypes: testClasses) else {
return
}
violations.append(node.classKeyword.positionAfterSkippingLeadingTrivia)
}
}