Restructure frameworks

.jazzy.yaml

@@ -19,14 +19,3 @@ custom_categories:
   - name: Rules
     children:
       - Rule Directory
-  - name: Reporters
-    children:
-      - CSVReporter
-      - CheckstyleReporter
-      - CodeClimateReporter
-      - EmojiReporter
-      - GitHubActionsLoggingReporter
-      - HTMLReporter
-      - JSONReporter
-      - JUnitReporter
-      - MarkdownReporter

BUILD

@@ -127,7 +127,7 @@ swift_library(
     srcs = glob(
         ["Source/SwiftLintFramework/**/*.swift"],
     ),
-    copts = copts + strict_concurrency_copts,
+    copts = copts,  # TODO: strict_concurrency_copts
     module_name = "SwiftLintFramework",
     visibility = ["//visibility:public"],
     deps = [

Makefile

@@ -30,15 +30,15 @@ VERSION_STRING=$(shell ./tools/get-version)
 
 all: build
 
-sourcery: Source/SwiftLintBuiltInRules/Models/BuiltInRules.swift Source/SwiftLintCore/Models/ReportersList.swift Tests/GeneratedTests/GeneratedTests.swift
+sourcery: Source/SwiftLintBuiltInRules/Models/BuiltInRules.swift Source/SwiftLintFramework/Models/ReportersList.swift Tests/GeneratedTests/GeneratedTests.swift
 
 Source/SwiftLintBuiltInRules/Models/BuiltInRules.swift: Source/SwiftLintBuiltInRules/Rules/**/*.swift .sourcery/BuiltInRules.stencil
 	./tools/sourcery --sources Source/SwiftLintBuiltInRules/Rules --templates .sourcery/BuiltInRules.stencil --output .sourcery
 	mv .sourcery/BuiltInRules.generated.swift Source/SwiftLintBuiltInRules/Models/BuiltInRules.swift
 
-Source/SwiftLintCore/Models/ReportersList.swift: Source/SwiftLintCore/Reporters/*.swift .sourcery/ReportersList.stencil
-	./tools/sourcery --sources Source/SwiftLintCore/Reporters --templates .sourcery/ReportersList.stencil --output .sourcery
-	mv .sourcery/ReportersList.generated.swift Source/SwiftLintCore/Models/ReportersList.swift
+Source/SwiftLintFramework/Models/ReportersList.swift: Source/SwiftLintFramework/Reporters/*.swift .sourcery/ReportersList.stencil
+	./tools/sourcery --sources Source/SwiftLintFramework/Reporters --templates .sourcery/ReportersList.stencil --output .sourcery
+	mv .sourcery/ReportersList.generated.swift Source/SwiftLintFramework/Models/ReportersList.swift
 
 Tests/GeneratedTests/GeneratedTests.swift: Source/SwiftLint*/Rules/**/*.swift .sourcery/GeneratedTests.stencil
 	./tools/sourcery --sources Source/SwiftLintBuiltInRules/Rules --templates .sourcery/GeneratedTests.stencil --output .sourcery
@@ -173,7 +173,7 @@ endif
 	$(eval NEW_VERSION_AND_NAME := $(filter-out $@,$(MAKECMDGOALS)))
 	$(eval NEW_VERSION := $(shell echo $(NEW_VERSION_AND_NAME) | sed 's/:.*//' ))
 	@sed -i '' 's/## Main/## $(NEW_VERSION_AND_NAME)/g' CHANGELOG.md
-	@sed 's/__VERSION__/$(NEW_VERSION)/g' tools/Version.swift.template > Source/SwiftLintCore/Models/Version.swift
+	@sed 's/__VERSION__/$(NEW_VERSION)/g' tools/Version.swift.template > Source/SwiftLintFramework/Models/Version.swift
 	@sed -e '3s/.*/    version = "$(NEW_VERSION)",/' -i '' MODULE.bazel
 	make clean
 	make package

Source/SwiftLintBuiltInRules/Rules/Metrics/FunctionBodyLengthRule.swift

@@ -1,3 +1,5 @@
+import SwiftLintCore
+
 struct FunctionBodyLengthRule: SwiftSyntaxRule {
     var configuration = SeverityLevelsConfiguration<Self>(warning: 50, error: 100)
 

Source/SwiftLintBuiltInRules/Rules/Metrics/TypeBodyLengthRule.swift

@@ -1,3 +1,5 @@
+import SwiftLintCore
+
 private func wrapExample(
     prefix: String = "",
     _ type: String,

Source/SwiftLintCore/Extensions/NSRegularExpression+SwiftLint.swift

@@ -15,7 +15,7 @@ public struct RegularExpression: Hashable, Comparable, ExpressibleByStringLitera
         try! self.init(pattern: value)
     }
 
-    var pattern: String { regex.pattern }
+    package var pattern: String { regex.pattern }
 
     var numberOfCaptureGroups: Int { regex.numberOfCaptureGroups }
 

Source/SwiftLintCore/Extensions/SwiftLintFile+Cache.swift

@@ -50,7 +50,7 @@ private let syntaxKindsByLinesCache = Cache { $0.syntaxKindsByLine() }
 private let syntaxTokensByLinesCache = Cache { $0.syntaxTokensByLine() }
 private let linesWithTokensCache = Cache { $0.computeLinesWithTokens() }
 
-internal typealias AssertHandler = () -> Void
+package typealias AssertHandler = () -> Void
 // Re-enable once all parser diagnostics in tests have been addressed.
 // https://github.com/realm/SwiftLint/issues/3348
 package var parserDiagnosticsDisabledForTests = false
@@ -114,7 +114,7 @@ extension SwiftLintFile {
         }
     }
 
-    internal var assertHandler: AssertHandler? {
+    package var assertHandler: AssertHandler? {
         get {
             return assertHandlerCache.get(self)
         }

Source/SwiftLintCore/Models/Command.swift

@@ -13,7 +13,7 @@ public struct Command: Equatable {
 
         /// - returns: The inverse action that can cancel out the current action, restoring the SwifttLint engine's
         ///            state prior to the current action.
-        internal func inverse() -> Action {
+        package func inverse() -> Action {
             switch self {
             case .enable: return .disable
             case .disable: return .enable
@@ -143,7 +143,7 @@ public struct Command: Equatable {
     /// If the command doesn't have a modifier, it is returned as-is.
     ///
     /// - returns: The expanded commands.
-    internal func expand() -> [Command] {
+    package func expand() -> [Command] {
         guard let modifier else {
             return [self]
         }

Source/SwiftLintCore/Models/Example.swift

@@ -37,7 +37,7 @@ public struct Example: Sendable {
     /// why a rule is applied and where not. Complex examples with rarely used language constructs or
     /// pathological use cases which are indeed important to test but not helpful for understanding can be
     /// hidden from the documentation with this option.
-    let excludeFromDocumentation: Bool
+    package let excludeFromDocumentation: Bool
 
     /// Specifies whether the test example should be the only example run during the current test case execution.
     package var isFocused: Bool

Source/SwiftLintCore/Models/Issue.swift

@@ -58,17 +58,17 @@ public enum Issue: LocalizedError, Equatable {
     /// - parameter error: Any `Error`.
     ///
     /// - returns: A `SwiftLintError.genericWarning` containig the message of the `error` argument.
-    static func wrap(error: some Error) -> Self {
+    package static func wrap(error: some Error) -> Self {
         error as? Issue ?? Self.genericWarning(error.localizedDescription)
     }
 
     /// Make this issue an error.
-    var asError: Self {
+    package var asError: Self {
         Self.genericError(message)
     }
 
     /// The issues description which is ready to be printed to the console.
-    var errorDescription: String {
+    package var errorDescription: String {
         switch self {
         case .genericError:
             return "error: \(message)"

Source/SwiftLintCore/Models/RuleList.swift

@@ -40,7 +40,7 @@ public struct RuleList {
 
     // MARK: - Internal
 
-    internal func allRulesWrapped(configurationDict: [String: Any] = [:]) throws -> [ConfigurationRuleWrapper] {
+    package func allRulesWrapped(configurationDict: [String: Any] = [:]) throws -> [ConfigurationRuleWrapper] {
         var rules = [String: ConfigurationRuleWrapper]()
 
         // Add rules where configuration exists
@@ -72,11 +72,11 @@ public struct RuleList {
         return Array(rules.values)
     }
 
-    internal func identifier(for alias: String) -> String? {
+    package func identifier(for alias: String) -> String? {
         return aliases[alias]
     }
 
-    internal func allValidIdentifiers() -> [String] {
+    package func allValidIdentifiers() -> [String] {
         return list.flatMap { _, rule -> [String] in
             rule.description.allIdentifiers
         }

Source/SwiftLintCore/Models/StyleViolation.swift

@@ -20,7 +20,14 @@ public struct StyleViolation: CustomStringConvertible, Equatable, Codable {
 
     /// A printable description for this violation.
     public var description: String {
-        return XcodeReporter.generateForSingleViolation(self)
+        // {full_path_to_file}{:line}{:character}: {error,warning}: {content}
+        [
+            "\(location): ",
+            "\(severity.rawValue): ",
+            "\(ruleName) Violation: ",
+            reason,
+            " (\(ruleIdentifier))"
+        ].joined()
     }
 
     /// Creates a `StyleViolation` by specifying its properties directly.

Source/SwiftLintCore/RuleConfigurations/RegexConfiguration.swift

@@ -11,7 +11,7 @@ public struct RegexConfiguration<Parent: Rule>: SeverityBasedRuleConfiguration,
     public var message = "Regex matched"
     /// The regular expression to apply to trigger violations for this custom rule.
     @ConfigurationElement(key: "regex")
-    var regex: RegularExpression!
+    package var regex: RegularExpression!
     /// Regular expressions to include when matching the file path.
     public var included: [NSRegularExpression] = []
     /// Regular expressions to exclude when matching the file path.
@@ -102,7 +102,7 @@ public struct RegexConfiguration<Parent: Rule>: SeverityBasedRuleConfiguration,
         hasher.combine(identifier)
     }
 
-    func shouldValidate(filePath: String) -> Bool {
+    package func shouldValidate(filePath: String) -> Bool {
         let pathRange = filePath.fullNSRange
         let isIncluded = included.isEmpty || included.contains { regex in
             regex.firstMatch(in: filePath, range: pathRange) != nil

Source/SwiftLintBuiltInRules/Visitors/BodyLengthRuleVisitor.swift → Source/SwiftLintCore/Visitors/BodyLengthRuleVisitor.swift

@@ -1,11 +1,16 @@
 import SwiftSyntax
 
-final class BodyLengthRuleVisitor<Parent: Rule>: ViolationsSyntaxVisitor<SeverityLevelsConfiguration<Parent>> {
+/// Visitor that collection violations of code block lengths.
+public final class BodyLengthRuleVisitor<Parent: Rule>: ViolationsSyntaxVisitor<SeverityLevelsConfiguration<Parent>> {
     private let kind: Kind
 
-    enum Kind {
+    /// The code block types to check.
+    public enum Kind {
+        /// Closure code blocks.
         case closure
+        /// Function body blocks.
         case function
+        /// Type (class, enum, ...) member blocks.
         case type
 
         fileprivate var name: String {
@@ -20,12 +25,18 @@ final class BodyLengthRuleVisitor<Parent: Rule>: ViolationsSyntaxVisitor<Severit
         }
     }
 
-    init(kind: Kind, file: SwiftLintFile, configuration: SeverityLevelsConfiguration<Parent>) {
+    /// Initializer.
+    ///
+    /// - Parameters:
+    ///   - kind: The code block type to check. See ``Kind``.
+    ///   - file: The file to collect violation for.
+    ///   - configuration: The configuration that defines the acceptable limits.
+    public init(kind: Kind, file: SwiftLintFile, configuration: SeverityLevelsConfiguration<Parent>) {
         self.kind = kind
         super.init(configuration: configuration, file: file)
     }
 
-    override func visitPost(_ node: EnumDeclSyntax) {
+    override public func visitPost(_ node: EnumDeclSyntax) {
         if kind == .type {
             registerViolations(
                 leftBrace: node.memberBlock.leftBrace,
@@ -35,7 +46,7 @@ final class BodyLengthRuleVisitor<Parent: Rule>: ViolationsSyntaxVisitor<Severit
         }
     }
 
-    override func visitPost(_ node: ClassDeclSyntax) {
+    override public func visitPost(_ node: ClassDeclSyntax) {
         if kind == .type {
             registerViolations(
                 leftBrace: node.memberBlock.leftBrace,
@@ -45,7 +56,7 @@ final class BodyLengthRuleVisitor<Parent: Rule>: ViolationsSyntaxVisitor<Severit
         }
     }
 
-    override func visitPost(_ node: StructDeclSyntax) {
+    override public func visitPost(_ node: StructDeclSyntax) {
         if kind == .type {
             registerViolations(
                 leftBrace: node.memberBlock.leftBrace,
@@ -55,7 +66,7 @@ final class BodyLengthRuleVisitor<Parent: Rule>: ViolationsSyntaxVisitor<Severit
         }
     }
 
-    override func visitPost(_ node: ActorDeclSyntax) {
+    override public func visitPost(_ node: ActorDeclSyntax) {
         if kind == .type {
             registerViolations(
                 leftBrace: node.memberBlock.leftBrace,
@@ -65,7 +76,7 @@ final class BodyLengthRuleVisitor<Parent: Rule>: ViolationsSyntaxVisitor<Severit
         }
     }
 
-    override func visitPost(_ node: ClosureExprSyntax) {
+    override public func visitPost(_ node: ClosureExprSyntax) {
         if kind == .closure {
             registerViolations(
                 leftBrace: node.leftBrace,
@@ -75,7 +86,7 @@ final class BodyLengthRuleVisitor<Parent: Rule>: ViolationsSyntaxVisitor<Severit
         }
     }
 
-    override func visitPost(_ node: FunctionDeclSyntax) {
+    override public func visitPost(_ node: FunctionDeclSyntax) {
         if kind == .function, let body = node.body {
             registerViolations(
                 leftBrace: body.leftBrace,
@@ -85,7 +96,7 @@ final class BodyLengthRuleVisitor<Parent: Rule>: ViolationsSyntaxVisitor<Severit
         }
     }
 
-    override func visitPost(_ node: InitializerDeclSyntax) {
+    override public func visitPost(_ node: InitializerDeclSyntax) {
         if kind == .function, let body = node.body {
             registerViolations(
                 leftBrace: body.leftBrace,

Source/SwiftLintCore/Reporters/XcodeReporter.swift → Source/SwiftLintFramework/Reporters/XcodeReporter.swift

@@ -16,13 +16,6 @@ struct XcodeReporter: Reporter {
     ///
     /// - returns: The report for a single violation.
     internal static func generateForSingleViolation(_ violation: StyleViolation) -> String {
-        // {full_path_to_file}{:line}{:character}: {error,warning}: {content}
-        return [
-            "\(violation.location): ",
-            "\(violation.severity.rawValue): ",
-            "\(violation.ruleName) Violation: ",
-            violation.reason,
-            " (\(violation.ruleIdentifier))"
-        ].joined()
+        violation.description
     }
 }

Tests/SwiftLintFrameworkTests/CollectingRuleTests.swift

@@ -1,4 +1,4 @@
-@testable import SwiftLintCore
+@testable import SwiftLintFramework
 import SwiftLintTestHelpers
 import XCTest
 

Tests/SwiftLintFrameworkTests/CommandTests.swift

@@ -1,7 +1,7 @@
 // swiftlint:disable file_length
 import Foundation
 import SourceKittenFramework
-@testable import SwiftLintCore
+@testable import SwiftLintFramework
 import XCTest
 
 private extension Command {

Tests/SwiftLintFrameworkTests/ConfigurationAliasesTests.swift

@@ -1,4 +1,4 @@
-@testable import SwiftLintCore
+@testable import SwiftLintFramework
 import XCTest
 
 final class ConfigurationAliasesTests: SwiftLintTestCase {

Tests/SwiftLintFrameworkTests/ConfigurationTests+Mock.swift

@@ -1,4 +1,4 @@
-import SwiftLintCore
+import SwiftLintFramework
 
 // swiftlint:disable:next blanket_disable_command
 // swiftlint:disable nesting identifier_name

Tests/SwiftLintFrameworkTests/ConfigurationTests+MultipleConfigs.swift

@@ -1,5 +1,5 @@
 @testable import SwiftLintBuiltInRules
-@testable import SwiftLintCore
+@testable import SwiftLintFramework
 import XCTest
 
 // swiftlint:disable file_length

Tests/SwiftLintFrameworkTests/ConfigurationTests.swift

@@ -1,6 +1,6 @@
 import Foundation
 import SourceKittenFramework
-@testable import SwiftLintCore
+@testable import SwiftLintFramework
 import XCTest
 
 // swiftlint:disable file_length

Tests/SwiftLintFrameworkTests/CustomRulesTests.swift

@@ -1,5 +1,5 @@
 import SourceKittenFramework
-@testable import SwiftLintCore
+@testable import SwiftLintFramework
 import XCTest
 
 class CustomRulesTests: SwiftLintTestCase {

Tests/SwiftLintFrameworkTests/ExpiringTodoRuleTests.swift

@@ -1,4 +1,5 @@
 @testable import SwiftLintBuiltInRules
+import SwiftLintFramework
 import XCTest
 
 class ExpiringTodoRuleTests: SwiftLintTestCase {

Tests/SwiftLintFrameworkTests/GlobTests.swift

@@ -1,4 +1,4 @@
-@testable import SwiftLintCore
+@testable import SwiftLintFramework
 import XCTest
 
 final class GlobTests: SwiftLintTestCase {

Tests/SwiftLintFrameworkTests/LinterCacheTests.swift

@@ -1,5 +1,5 @@
 import Foundation
-@testable import SwiftLintCore
+@testable import SwiftLintFramework
 import XCTest
 
 private struct CacheTestHelper {

Tests/SwiftLintFrameworkTests/ReporterTests.swift

@@ -1,7 +1,7 @@
 import Foundation
 import SourceKittenFramework
 @testable import SwiftLintBuiltInRules
-@testable import SwiftLintCore
+@testable import SwiftLintFramework
 import XCTest
 
 class ReporterTests: SwiftLintTestCase {

Tests/SwiftLintFrameworkTests/SourceKitCrashTests.swift

@@ -1,4 +1,4 @@
-@testable import SwiftLintCore
+@testable import SwiftLintFramework
 import XCTest
 
 class SourceKitCrashTests: SwiftLintTestCase {

Tests/SwiftLintFrameworkTests/YamlParserTests.swift

@@ -1,4 +1,4 @@
-@testable import SwiftLintCore
+@testable import SwiftLintFramework
 import XCTest
 
 class YamlParserTests: SwiftLintTestCase {