mirror of
https://github.com/realm/SwiftLint.git
synced 2026-05-07 20:12:49 +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.
65 lines
2.6 KiB
Swift
65 lines
2.6 KiB
Swift
import SourceKittenFramework
|
|
|
|
/// A rule that leverages the Swift source's pre-typechecked Abstract Syntax Tree to recurse into the source's
|
|
/// structure, validating the rule recursively in nested source bodies.
|
|
public protocol ASTRule: Rule {
|
|
/// The kind of token being recursed over.
|
|
associatedtype KindType: RawRepresentable
|
|
|
|
/// Executes the rule on a file and a subset of its AST structure, returning any violations to the rule's
|
|
/// expectations.
|
|
///
|
|
/// - parameter file: The file for which to execute the rule.
|
|
/// - parameter kind: The kind of token being recursed over.
|
|
/// - parameter dictionary: The dictionary for an AST subset to validate.
|
|
///
|
|
/// - returns: All style violations to the rule's expectations.
|
|
func validate(file: SwiftLintFile, kind: KindType, dictionary: SourceKittenDictionary) -> [StyleViolation]
|
|
|
|
/// Get the `kind` from the specified dictionary.
|
|
///
|
|
/// - parameter dictionary: The `SourceKittenDictionary` representing the source structure from which to extract the
|
|
/// `kind`.
|
|
///
|
|
/// - returns: The `kind` from the specified dictionary, if one was found.
|
|
func kind(from dictionary: SourceKittenDictionary) -> KindType?
|
|
}
|
|
|
|
public extension ASTRule {
|
|
func validate(file: SwiftLintFile) -> [StyleViolation] {
|
|
return validate(file: file, dictionary: file.structureDictionary)
|
|
}
|
|
|
|
/// Executes the rule on a file and a subset of its AST structure, returning any violations to the rule's
|
|
/// expectations.
|
|
///
|
|
/// - parameter file: The file for which to execute the rule.
|
|
/// - parameter dictionary: The dictionary for an AST subset to validate.
|
|
///
|
|
/// - returns: All style violations to the rule's expectations.
|
|
func validate(file: SwiftLintFile, dictionary: SourceKittenDictionary) -> [StyleViolation] {
|
|
return dictionary.traverseDepthFirst { subDict in
|
|
guard let kind = self.kind(from: subDict) else { return nil }
|
|
return validate(file: file, kind: kind, dictionary: subDict)
|
|
}
|
|
}
|
|
}
|
|
|
|
public extension ASTRule where KindType == SwiftDeclarationKind {
|
|
func kind(from dictionary: SourceKittenDictionary) -> KindType? {
|
|
return dictionary.declarationKind
|
|
}
|
|
}
|
|
|
|
public extension ASTRule where KindType == SwiftExpressionKind {
|
|
func kind(from dictionary: SourceKittenDictionary) -> KindType? {
|
|
return dictionary.expressionKind
|
|
}
|
|
}
|
|
|
|
public extension ASTRule where KindType == StatementKind {
|
|
func kind(from dictionary: SourceKittenDictionary) -> KindType? {
|
|
return dictionary.statementKind
|
|
}
|
|
}
|