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.
80 lines
2.9 KiB
Swift
80 lines
2.9 KiB
Swift
/// User-facing documentation for a SwiftLint rule.
|
|
struct RuleDocumentation {
|
|
private let ruleType: Rule.Type
|
|
|
|
/// If this rule is an opt-in rule.
|
|
var isOptInRule: Bool { ruleType is OptInRule.Type }
|
|
|
|
/// If this rule is an analyzer rule.
|
|
var isAnalyzerRule: Bool { ruleType is AnalyzerRule.Type }
|
|
|
|
/// If this rule is a linter rule.
|
|
var isLinterRule: Bool { !isAnalyzerRule }
|
|
|
|
/// If this rule uses SourceKit.
|
|
var usesSourceKit: Bool { !(ruleType is SourceKitFreeRule.Type) }
|
|
|
|
/// If this rule is disabled by default.
|
|
var isDisabledByDefault: Bool { ruleType is OptInRule.Type }
|
|
|
|
/// If this rule is enabled by default.
|
|
var isEnabledByDefault: Bool { !isDisabledByDefault }
|
|
|
|
/// Creates a RuleDocumentation instance from a Rule type.
|
|
///
|
|
/// - parameter ruleType: A subtype of the `Rule` protocol to document.
|
|
init(_ ruleType: Rule.Type) {
|
|
self.ruleType = ruleType
|
|
}
|
|
|
|
/// The name of the documented rule.
|
|
var ruleName: String { ruleType.description.name }
|
|
|
|
/// The identifier of the documented rule.
|
|
var ruleIdentifier: String { ruleType.description.identifier }
|
|
|
|
/// The name of the file on disk for this rule documentation.
|
|
var fileName: String { "\(ruleType.description.identifier).md" }
|
|
|
|
/// The contents of the file for this rule documentation.
|
|
var fileContents: String {
|
|
let description = ruleType.description
|
|
var content = [h1(description.name), description.description, detailsSummary(ruleType.init())]
|
|
let nonTriggeringExamples = description.nonTriggeringExamples.filter { !$0.excludeFromDocumentation }
|
|
if nonTriggeringExamples.isNotEmpty {
|
|
content += [h2("Non Triggering Examples")]
|
|
content += nonTriggeringExamples.map(formattedCode)
|
|
}
|
|
let triggeringExamples = description.triggeringExamples.filter { !$0.excludeFromDocumentation }
|
|
if triggeringExamples.isNotEmpty {
|
|
content += [h2("Triggering Examples")]
|
|
content += triggeringExamples.map(formattedCode)
|
|
}
|
|
return content.joined(separator: "\n\n")
|
|
}
|
|
}
|
|
|
|
private func h1(_ text: String) -> String { "# \(text)" }
|
|
|
|
private func h2(_ text: String) -> String { "## \(text)" }
|
|
|
|
private func detailsSummary(_ rule: Rule) -> String {
|
|
return """
|
|
* **Identifier:** \(type(of: rule).description.identifier)
|
|
* **Enabled by default:** \(rule is OptInRule ? "No" : "Yes")
|
|
* **Supports autocorrection:** \(rule is CorrectableRule ? "Yes" : "No")
|
|
* **Kind:** \(type(of: rule).description.kind)
|
|
* **Analyzer rule:** \(rule is AnalyzerRule ? "Yes" : "No")
|
|
* **Minimum Swift compiler version:** \(type(of: rule).description.minSwiftVersion.rawValue)
|
|
* **Default configuration:** \(rule.configurationDescription)
|
|
"""
|
|
}
|
|
|
|
private func formattedCode(_ example: Example) -> String {
|
|
return """
|
|
```swift
|
|
\(example.code)
|
|
```
|
|
"""
|
|
}
|