mirror of
https://github.com/realm/SwiftLint.git
synced 2026-06-06 20:18:40 +00:00
JP Simard
86d60400c1
Over the years, SwiftLintFramework had become a fairly massive monolith, containing over 400 source files with both core infrastructure and rules. Architecturally, the rules should rely on the core infrastructure but not the other way around. There are two exceptions to this: `custom_rules` and `superfluous_disable_command` which need special integration with the linter infrastructure. Now the time has come to formalize this architecture and one way to do that is to move the core SwiftLint functionality out of SwiftLintFramework and into a new SwiftLintCore module that the rules can depend on. Beyond enforcing architectural patterns, this also has the advantage of speeding up incremental compilation by skipping rebuilding the core functionality when iterating on rules. Because the core functionality is always useful when building rules, I'm opting to import SwiftLintCore in SwiftLintFramework as `@_exported` so that it's implicitly available to all files in SwiftLintFramework without needing to import it directly. In a follow-up I'll also split the built-in rules and the extra rules into their own modules. More modularization is possible from there, but not planned. The bulk of this PR just moves files from `Source/SwiftLintFramework/*` to `Source/SwiftLintCore/*`. There are some other changes that can't be split up into their own PRs: * Change jazzy to document the SwiftLintCore module instead of SwiftLintFramework. * Change imports in unit tests to reflect where code was moved to. * Update `sourcery` make rule to reflect where code was moved to. * Create a new `coreRules` array and register those rules with the registry. This allows the `custom_rules` and `superfluous_disable_command` rule implementations to remain internal to the SwiftLintCore module, preventing more implementation details from leaking across architectural layers. * Move `RuleRegistry.registerAllRulesOnce()` out of the type declaration and up one level so it can access rules defined downstream from SwiftLintCore.
41 lines
1.5 KiB
Swift
41 lines
1.5 KiB
Swift
/// An interface for reporting violations as strings.
|
|
public protocol Reporter: CustomStringConvertible {
|
|
/// The unique identifier for this reporter.
|
|
static var identifier: String { get }
|
|
|
|
/// Whether or not this reporter can output incrementally as violations are found or if all violations must be
|
|
/// collected before generating the report.
|
|
static var isRealtime: Bool { get }
|
|
|
|
/// A more detailed description of the reporter's output.
|
|
static var description: String { get }
|
|
|
|
/// For CustomStringConvertible conformance.
|
|
var description: String { get }
|
|
|
|
/// Return a string with the report for the specified violations.
|
|
///
|
|
/// - parameter violations: The violations to report.
|
|
///
|
|
/// - returns: The report.
|
|
static func generateReport(_ violations: [StyleViolation]) -> String
|
|
}
|
|
|
|
public extension Reporter {
|
|
/// For CustomStringConvertible conformance.
|
|
var description: String { Self.description }
|
|
}
|
|
|
|
/// Returns the reporter with the specified identifier. Traps if the specified identifier doesn't correspond to any
|
|
/// known reporters.
|
|
///
|
|
/// - parameter identifier: The identifier corresponding to the reporter.
|
|
///
|
|
/// - returns: The reporter type.
|
|
public func reporterFrom(identifier: String) -> Reporter.Type {
|
|
guard let reporter = reportersList.first(where: { $0.identifier == identifier }) else {
|
|
queuedFatalError("no reporter with identifier '\(identifier)' available.")
|
|
}
|
|
return reporter
|
|
}
|