Add swift lint plugin

.github/workflows/build-release.yml

@@ -24,7 +24,7 @@ jobs:
 
     - name: 🛠️ Build with release configuration
       run: |
-        swift build --configuration release | xcpretty --utf --color && exit ${PIPESTATUS[0]}
+        swift build --configuration release -skipPackagePluginValidation | xcpretty --utf --color && exit ${PIPESTATUS[0]}
 
     - uses: actions/upload-artifact@v4
       with:

.github/workflows/run-tests.yml

@@ -25,4 +25,4 @@ jobs:
 
     - name: 🛠️ Run All Tests
       run: |
-        xcodebuild test -scheme public-api-diff -destination "platform=iOS,name=Any iOS Device" | xcpretty --utf --color && exit ${PIPESTATUS[0]}
+        xcodebuild test -scheme public-api-diff -destination "platform=iOS,name=Any iOS Device" -skipPackagePluginValidation | xcpretty --utf --color && exit ${PIPESTATUS[0]}

Package.swift

@@ -34,12 +34,13 @@ let package = Package(
         .package(url: "https://github.com/apple/swift-argument-parser", from: "1.5.0"),
         .package(url: "https://github.com/swiftlang/swift-syntax", from: "600.0.1"),
         .package(url: "https://github.com/nicklockwood/SwiftFormat", from: "0.54.6"),
-        .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.4.3")
+        .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.4.3"),
+        .package(url: "https://github.com/SimplyDanny/SwiftLintPlugins", from: "0.57.0")
     ],
     targets: [
-        
+
         // MARK: - Executable Targets
-        
+
         .executableTarget(
             name: "public-api-diff",
             dependencies: [
@@ -50,19 +51,22 @@ let package = Package(
                 "PADSwiftInterfaceFileLocator",
                 .product(name: "ArgumentParser", package: "swift-argument-parser")
             ],
-            path: "Sources/ExecutableTargets/CommandLineTool"
+            path: "Sources/ExecutableTargets/CommandLineTool",
+            plugins: [
+                .plugin(name: "SwiftLintBuildToolPlugin", package: "SwiftLintPlugins")
+            ]
         ),
-        
+
         // MARK: - Public Modules
-        
+
         .target(
             name: "PADSwiftInterfaceDiff",
             dependencies: [
                 "PADCore",
                 "PADLogging",
                 "FileHandlingModule",
                 .product(name: "SwiftSyntax", package: "swift-syntax"),
-                .product(name: "SwiftParser", package: "swift-syntax"),
+                .product(name: "SwiftParser", package: "swift-syntax")
             ],
             path: "Sources/PublicModules/PADSwiftInterfaceDiff"
         ),
@@ -94,9 +98,9 @@ let package = Package(
             dependencies: ["PADCore"],
             path: "Sources/PublicModules/PADOutputGenerator"
         ),
-        
+
         // MARK: - Shared/Public
-        
+
         .target(
             name: "PADCore",
             path: "Sources/Shared/Public/PADCore"
@@ -111,9 +115,9 @@ let package = Package(
             dependencies: ["FileHandlingModule", "ShellModule", "PADLogging"],
             path: "Sources/Shared/Public/PADSwiftInterfaceFileLocator"
         ),
-        
+
         // MARK: - Shared/Package
-        
+
         .target(
             name: "FileHandlingModule",
             path: "Sources/Shared/Package/FileHandlingModule"
@@ -127,9 +131,9 @@ let package = Package(
             dependencies: ["FileHandlingModule", "ShellModule", "PADLogging"],
             path: "Sources/Shared/Package/SwiftPackageFileHelperModule"
         ),
-        
+
         // MARK: - Test Targets
-        
+
         .testTarget(
             name: "UnitTests",
             dependencies: [

ReferencePackages/ReferencePackage/Sources/ReferencePackage/ReferencePackage.swift

@@ -24,7 +24,7 @@ import Foundation
 
 public protocol CustomProtocol {
     typealias CustomAssociatedType = Equatable
-    
+
     var getSetVar: any CustomAssociatedType { get set }
     var getVar: any CustomAssociatedType { get }
     func function() -> any CustomAssociatedType
@@ -40,26 +40,26 @@ public struct CustomStruct: CustomProtocol {
 // MARK: - Generic public class
 
 public class CustomClass<T: Equatable> {
-    
+
     public weak var weakObject: CustomClass?
     lazy var lazyVar: String = { "I am a lazy" }()
     @_spi(SomeSpi)
     @_spi(AnotherSpi)
     open var computedVar: String { "I am computed" }
     package let constantLet: String = "I'm a let"
     public var optionalVar: T?
-    
+
     @MainActor
     public func asyncThrowingFunc() async throws {}
     public func rethrowingFunc(throwingArg: @escaping () throws -> String) rethrows {}
-    
+
     public init(weakObject: CustomClass? = nil, optionalVar: T? = nil) {
         self.weakObject = weakObject
         self.optionalVar = optionalVar
     }
-    
+
     public init() {}
-    
+
     public convenience init(value: T) {
         self.init(optionalVar: value)
     }
@@ -70,12 +70,12 @@ public class CustomClass<T: Equatable> {
 @_spi(SystemProgrammingInterface)
 open class OpenSpiConformingClass: CustomProtocol {
     public typealias CustomAssociatedType = any Equatable
-    
+
     public var getSetVar: CustomAssociatedType
     public var getVar: CustomAssociatedType
     @inlinable
     public func function() -> CustomAssociatedType { fatalError() }
-    
+
     public init(getSetVar: CustomAssociatedType, getVar: CustomAssociatedType) {
         self.getSetVar = getSetVar
         self.getVar = getVar
@@ -106,11 +106,11 @@ public actor CustomActor {}
 
 public enum OperatorNamespace: String {
     case someValue = "1"
-    
+
     public static prefix func ++ (_ counter: OperatorNamespace) -> String {
         counter.rawValue
     }
-    
+
     public static postfix func ++ (_ counter: OperatorNamespace) -> String {
         counter.rawValue
     }
@@ -137,6 +137,6 @@ public enum CustomEnum {
     case caseWithString(String)
     case caseWithTuple(String, Int)
     case caseWithBlock((Int) throws -> Void)
-    
+
     indirect case recursive(CustomEnum)
 }

ReferencePackages/UpdatedPackage/Sources/ReferencePackage/ReferencePackage.swift

@@ -32,7 +32,7 @@ public protocol ParentProtocol<ParentType> {
 public protocol CustomProtocol<CustomAssociatedType, AnotherAssociatedType>: ParentProtocol<Double> {
     associatedtype CustomAssociatedType: Equatable
     associatedtype AnotherAssociatedType: Strideable
-    
+
     var getSetVar: AnotherAssociatedType { get set }
     var getVar: CustomAssociatedType { get }
     func function() -> CustomAssociatedType
@@ -41,16 +41,16 @@ public protocol CustomProtocol<CustomAssociatedType, AnotherAssociatedType>: Par
 public struct CustomStruct<T: Strideable>: CustomProtocol {
     public typealias CustomAssociatedType = Int
     public typealias AnotherAssociatedType = Double
-    public typealias Iterator = Array<AnotherAssociatedType>
-    
+    public typealias Iterator = [AnotherAssociatedType]
+
     @available(macOS, unavailable, message: "Unavailable on macOS")
     public struct NestedStruct {
         @available(*, deprecated, renamed: "nestedVar")
         public let nestedLet: String = "let"
         @available(swift, introduced: 5.9)
         public let nestedVar: String = "var"
     }
-    
+
     public var getSetVar: Double
     public var getVar: Int
     @discardableResult
@@ -60,34 +60,34 @@ public struct CustomStruct<T: Strideable>: CustomProtocol {
 // MARK: - Generic public class
 
 public class CustomClass<T: Equatable> {
-    
+
     public weak var weakObject: CustomClass?
     public lazy var lazyVar: String = { "I am a lazy" }()
     @_spi(SomeSpi)
     @_spi(AnotherSpi)
     open var computedVar: String { "I am computed" }
     package let constantLet: String = "I'm a let"
     public var optionalVar: T?
-    
+
     public let a = 0, b = 0, c = 0, d: Double = 5.0
-    
+
     @MainActor
-    public func asyncThrowingFunc<Element>(_ element: Element) async throws -> Void where Element: Strideable {}
+    public func asyncThrowingFunc<Element>(_ element: Element) async throws where Element: Strideable {}
     public func rethrowingFunc(throwingArg: @escaping () throws -> String) rethrows {}
-    
+
     public init(weakObject: CustomClass? = nil, optionalVar: T? = nil) {
         self.weakObject = weakObject
         self.optionalVar = optionalVar
-        
+
         lazyVar = "Great!"
     }
-    
+
     public init?() {}
-    
+
     public convenience init!(value: T) {
         self.init(optionalVar: value)
     }
-    
+
     public subscript(index: Int) -> T? {
         get { optionalVar }
         set { optionalVar = newValue }
@@ -107,13 +107,13 @@ extension Array {
 open class OpenSpiConformingClass<T: Equatable & Strideable>: CustomProtocol {
     public typealias CustomAssociatedType = T
     public typealias AnotherAssociatedType = T
-    public typealias Iterator = Array<Double>
-    
+    public typealias Iterator = [Double]
+
     public var getSetVar: T
     public var getVar: T
     @inlinable
     public func function() -> T where T: Equatable { getVar }
-    
+
     public init(getSetVar: T, getVar: T) {
         self.getSetVar = getSetVar
         self.getVar = getVar
@@ -144,11 +144,11 @@ public actor CustomActor: SimpleProtocol {}
 
 public enum OperatorNamespace: String {
     case someValue = "1"
-    
+
     public static prefix func ++ (_ counter: OperatorNamespace) -> String {
         counter.rawValue
     }
-    
+
     public static postfix func ++ (_ counter: OperatorNamespace) -> String {
         counter.rawValue
     }
@@ -176,7 +176,7 @@ public enum CustomEnum<T> {
     case caseWithTuple(_ foo: String, bar: Int)
     case caseWithBlock((Int) throws -> Void)
     case a, b, c, d, e(NestedStructInExtension)
-    
+
     indirect case recursive(CustomEnum)
 }
 
@@ -186,7 +186,7 @@ public enum RawValueEnum: String {
 }
 
 extension CustomEnum: SimpleProtocol {
-    
+
     public struct NestedStructInExtension {
         public let string: String
         public init(string: String = "Hello") {
@@ -196,14 +196,14 @@ extension CustomEnum: SimpleProtocol {
 }
 
 extension CustomEnum.NestedStructInExtension {
-    
+
     var description: String {
         return string
     }
 }
 
 public extension CustomEnum where T == String {
-    
+
     var titleOfCaseWithNamedString: String? {
         if case let .caseWithNamedString(title) = self {
             return title

Sources/ExecutableTargets/CommandLineTool/CommandLineTool+Extensions.swift

@@ -1,7 +1,13 @@
+//
+// Copyright (c) 2024 Adyen N.V.
+//
+// This file is open source and available under the MIT license. See the LICENSE file for more info.
+//
+
 import ArgumentParser
 
-import PADSwiftInterfaceFileLocator
 import PADLogging
+import PADSwiftInterfaceFileLocator
 
 extension SwiftInterfaceType: ExpressibleByArgument {
     public init?(argument: String) {

Sources/ExecutableTargets/CommandLineTool/CommandLineTool.swift

@@ -10,14 +10,14 @@ import Foundation
 import PADCore
 import PADLogging
 
-import PADSwiftInterfaceDiff
-import PADProjectBuilder
 import PADOutputGenerator
 import PADPackageFileAnalyzer
+import PADProjectBuilder
+import PADSwiftInterfaceDiff
 
 @main
 struct PublicApiDiff: AsyncParsableCommand {
-    
+
     static var configuration: CommandConfiguration = .init(
         commandName: "public-api-diff",
         subcommands: [
@@ -26,14 +26,14 @@ struct PublicApiDiff: AsyncParsableCommand {
             FrameworkToOutputCommand.self
         ]
     )
-    
+
     public func run() async throws {
         fatalError("No sub command provided")
     }
 }
 
 extension PublicApiDiff {
-    
+
     static func logger(
         with logLevel: LogLevel,
         logOutputFilePath: String?
@@ -43,7 +43,7 @@ extension PublicApiDiff {
             loggers += [LogFileLogger(outputFilePath: logOutputFilePath)]
         }
         loggers += [SystemLogger().withLogLevel(logLevel)]
-        
+
         return LoggingGroup(with: loggers)
     }
 }