Parameter diffing

.github/workflows/run-tests.yml

@@ -21,7 +21,7 @@ jobs:
     - name: Select latest Xcode
       uses: maxim-lobanov/setup-xcode@v1
       with:
-        xcode-version: '16.1'
+        xcode-version: '16.2'
 
     - name: 🛠️ Run All Tests
       run: |

ReferencePackages/ReferencePackage/Sources/ReferencePackage/ReferencePackage.swift

@@ -140,3 +140,20 @@ public enum CustomEnum {
 
     indirect case recursive(CustomEnum)
 }
+
+public struct PublicStructThatIsOnlyAvailableInTheReferencePackage {
+
+    public var foo: String
+    public func bar() -> Void {
+        print("Hello")
+    }
+}
+
+public extension CustomEnum {
+    enum PublicEnumInExtensionOfCustomEnumThatIsOnlyAvailableInTheReferencePackage {
+        case alpha
+        case beta
+    }
+}
+
+public extension CustomEnum {}

Sources/PublicModules/PADProjectBuilder/SwiftInterfaceProducer/XcodeTools.swift

@@ -23,6 +23,7 @@ struct XcodeTools {
 
     internal enum Constants {
         static let derivedDataPath: String = ".build"
+        static let buildDirPath: String = ".build/Build"
         static let simulatorSdkCommand = "xcrun --sdk iphonesimulator --show-sdk-path"
     }
 
@@ -87,16 +88,15 @@ struct XcodeTools {
 
             let result = shell.execute(command)
             let derivedDataPath = "\(projectDirectoryPath)/\(Constants.derivedDataPath)"
+            let buildDirPath = "\(projectDirectoryPath)/\(Constants.buildDirPath)"
 
             logger?.debug(result, from: String(describing: Self.self))
 
             // It might be that the archive failed but the .swiftinterface files are still created
             // so we have to check outside if they exist.
             //
             // Also see: https://github.com/swiftlang/swift/issues/56573
-            guard fileHandler.fileExists(atPath: derivedDataPath) else {
-                print(result)
-
+            guard fileHandler.fileExists(atPath: buildDirPath) else {
                 throw XcodeToolsError(
                     errorDescription: "💥 Building project failed",
                     underlyingError: result

Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceAnalyzer/SwiftInterfaceAnalyzer.swift

@@ -81,7 +81,7 @@ struct SwiftInterfaceAnalyzer: SwiftInterfaceAnalyzing {
 
             // No matching element was found so either it was removed or added
             let changeType: IndependentSwiftInterfaceChange.ChangeType = oldFirst ?
-                .removal(lhsElement.description) :
+                .removal(lhsElement.recursiveDescription()) :
                 .addition(lhsElement.recursiveDescription())
 
             return [

Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/DeclSyntax+SwiftInterface/EnumCaseDeclSyntax+SwiftInterface.swift

@@ -22,6 +22,7 @@ extension EnumCaseDeclSyntax {
                 name: $0.name.trimmedDescription,
                 parameters: $0.parameterClause?.parameters.map {
                     .init(
+                        attributes: [],
                         firstName: $0.firstName?.trimmedDescription,
                         secondName: $0.secondName?.trimmedDescription,
                         type: $0.type.trimmedDescription,

Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/DeclSyntax+SwiftInterface/FunctionDeclSyntax+SwiftInterface.swift

@@ -23,7 +23,7 @@ extension FunctionDeclSyntax {
             }
         }
 
-        let parameters: [SwiftInterfaceFunction.Parameter] = self.signature.parameterClause.parameters.map {
+        let parameters: [SwiftInterfaceElementParameter] = self.signature.parameterClause.parameters.map {
             .init(
                 attributes: $0.attributes.sanitizedList,
                 firstName: $0.firstName.trimmedDescription,

Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/DeclSyntax+SwiftInterface/InitializerDeclSyntax+SwiftInterface.swift

@@ -23,7 +23,7 @@ extension InitializerDeclSyntax {
             }
         }
 
-        let parameters: [SwiftInterfaceFunction.Parameter] = self.signature.parameterClause.parameters.map {
+        let parameters: [SwiftInterfaceElementParameter] = self.signature.parameterClause.parameters.map {
             .init(
                 attributes: $0.attributes.sanitizedList,
                 firstName: $0.firstName.trimmedDescription,

Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/DeclSyntax+SwiftInterface/SubscriptDeclSyntax+SwiftInterface.swift

@@ -12,8 +12,9 @@ extension SubscriptDeclSyntax {
 
     func toInterfaceElement() -> SwiftInterfaceSubscript {
 
-        let parameters: [SwiftInterfaceSubscript.Parameter] = self.parameterClause.parameters.map {
+        let parameters: [SwiftInterfaceElementParameter] = self.parameterClause.parameters.map {
             .init(
+                attributes: $0.attributes.sanitizedList,
                 firstName: $0.firstName.trimmedDescription,
                 secondName: $0.secondName?.trimmedDescription,
                 type: $0.type.trimmedDescription,

Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+EnumCase.swift

@@ -6,39 +6,6 @@
 
 import Foundation
 
-extension SwiftInterfaceEnumCase {
-
-    struct Parameter {
-
-        let firstName: String?
-
-        let secondName: String?
-
-        let type: String
-
-        let defaultValue: String?
-
-        var description: String {
-            var description = [
-                firstName,
-                secondName
-            ].compactMap { $0 }.joined(separator: " ")
-
-            if description.isEmpty {
-                description += "\(type)"
-            } else {
-                description += ": \(type)"
-            }
-
-            if let defaultValue {
-                description += " = \(defaultValue)"
-            }
-
-            return description
-        }
-    }
-}
-
 class SwiftInterfaceEnumCase: SwiftInterfaceElement {
 
     /// e.g. @discardableResult, @MainActor, @objc, @_spi(...), ...
@@ -49,7 +16,7 @@ class SwiftInterfaceEnumCase: SwiftInterfaceElement {
 
     let name: String
 
-    let parameters: [Parameter]?
+    let parameters: [SwiftInterfaceElementParameter]?
 
     let rawValue: String?
 
@@ -72,7 +39,7 @@ class SwiftInterfaceEnumCase: SwiftInterfaceElement {
         attributes: [String],
         modifiers: [String],
         name: String,
-        parameters: [Parameter]?,
+        parameters: [SwiftInterfaceElementParameter]?,
         rawValue: String?
     ) {
         self.attributes = attributes
@@ -90,7 +57,7 @@ extension SwiftInterfaceEnumCase {
         guard let other = otherElement as? Self else { return [] }
         changes += diffDescription(propertyType: "attribute", oldValues: other.attributes, newValues: attributes)
         changes += diffDescription(propertyType: "modifier", oldValues: other.modifiers, newValues: modifiers)
-        changes += diffDescription(propertyType: "parameter", oldValues: other.parameters?.map(\.description), newValues: parameters?.map(\.description))
+        changes += diffDescription(oldParameters: other.parameters, newParameters: parameters)
         changes += diffDescription(propertyType: "raw value", oldValue: other.rawValue, newValue: rawValue)
         return changes.compactMap { $0 }
     }

Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Function.swift

@@ -6,45 +6,6 @@
 
 import Foundation
 
-extension SwiftInterfaceFunction {
-
-    struct Parameter {
-
-        /// e.g. @discardableResult, @MainActor, @objc, @_spi(...), ...
-        let attributes: [String]
-
-        let firstName: String
-
-        /// optional second "internal" name - can be ignored
-        let secondName: String?
-
-        let type: String
-
-        let defaultValue: String?
-
-        var description: String {
-            let names = [
-                firstName,
-                secondName
-            ].compactMap { $0 }
-
-            var description = (attributes + names).joined(separator: " ")
-
-            if description.isEmpty {
-                description += "\(type)"
-            } else {
-                description += ": \(type)"
-            }
-
-            if let defaultValue {
-                description += " = \(defaultValue)"
-            }
-
-            return description
-        }
-    }
-}
-
 class SwiftInterfaceFunction: SwiftInterfaceElement {
 
     /// e.g. @discardableResult, @MainActor, @objc, @_spi(...), ...
@@ -55,7 +16,7 @@ class SwiftInterfaceFunction: SwiftInterfaceElement {
     /// e.g. <T>
     let genericParameterDescription: String?
 
-    let parameters: [Parameter]
+    let parameters: [SwiftInterfaceElementParameter]
 
     /// e.g. async, throws, rethrows
     let effectSpecifiers: [String]
@@ -76,7 +37,7 @@ class SwiftInterfaceFunction: SwiftInterfaceElement {
     var parent: (any SwiftInterfaceElement)?
 
     var diffableSignature: String {
-        "\(name)(\(parameters.map { "\($0.firstName):" }.joined()))"
+        "\(name)(\(parameters.map(\.valueForDiffableSignature).joined()))"
     }
 
     var consolidatableName: String { name }
@@ -90,7 +51,7 @@ class SwiftInterfaceFunction: SwiftInterfaceElement {
         modifiers: [String],
         name: String,
         genericParameterDescription: String?,
-        parameters: [Parameter],
+        parameters: [SwiftInterfaceElementParameter],
         effectSpecifiers: [String],
         returnType: String?,
         genericWhereClauseDescription: String?
@@ -114,7 +75,7 @@ extension SwiftInterfaceFunction {
         changes += diffDescription(propertyType: "attribute", oldValues: other.attributes, newValues: attributes)
         changes += diffDescription(propertyType: "modifier", oldValues: other.modifiers, newValues: modifiers)
         changes += diffDescription(propertyType: "generic parameter description", oldValue: other.genericParameterDescription, newValue: genericParameterDescription)
-        changes += diffDescription(propertyType: "parameter", oldValues: other.parameters.map(\.description), newValues: parameters.map(\.description)) // TODO: Maybe have a better way to show changes
+        changes += diffDescription(oldParameters: other.parameters, newParameters: parameters)
         changes += diffDescription(propertyType: "effect", oldValues: other.effectSpecifiers, newValues: effectSpecifiers)
         changes += diffDescription(propertyType: "return type", oldValue: other.returnType, newValue: returnType)
         changes += diffDescription(propertyType: "generic where clause", oldValue: other.genericWhereClauseDescription, newValue: genericWhereClauseDescription)

Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Initializer.swift

@@ -16,7 +16,7 @@ class SwiftInterfaceInitializer: SwiftInterfaceElement {
     /// e.g. <T>
     let genericParameterDescription: String?
 
-    let parameters: [SwiftInterfaceFunction.Parameter]
+    let parameters: [SwiftInterfaceElementParameter]
 
     /// e.g. async, throws, rethrows
     let effectSpecifiers: [String]
@@ -35,7 +35,7 @@ class SwiftInterfaceInitializer: SwiftInterfaceElement {
     var parent: (any SwiftInterfaceElement)?
 
     var diffableSignature: String {
-        "init(\(parameters.map { "\($0.firstName):" }.joined()))"
+        "init(\(parameters.map { $0.valueForDiffableSignature }.joined()))"
     }
 
     var consolidatableName: String { "init" }
@@ -49,7 +49,7 @@ class SwiftInterfaceInitializer: SwiftInterfaceElement {
         modifiers: [String],
         optionalMark: String?,
         genericParameterDescription: String?,
-        parameters: [SwiftInterfaceFunction.Parameter],
+        parameters: [SwiftInterfaceElementParameter],
         effectSpecifiers: [String],
         genericWhereClauseDescription: String?
     ) {
@@ -72,7 +72,7 @@ extension SwiftInterfaceInitializer {
         changes += diffDescription(propertyType: "modifier", oldValues: other.modifiers, newValues: modifiers)
         changes += diffDescription(propertyType: "optional mark", oldValue: other.optionalMark, newValue: optionalMark)
         changes += diffDescription(propertyType: "generic parameter description", oldValue: other.genericParameterDescription, newValue: genericParameterDescription)
-        changes += diffDescription(propertyType: "parameter", oldValues: other.parameters.map(\.description), newValues: parameters.map(\.description)) // TODO: Maybe have a better way to show changes
+        changes += diffDescription(oldParameters: other.parameters, newParameters: parameters)
         changes += diffDescription(propertyType: "effect", oldValues: other.effectSpecifiers, newValues: effectSpecifiers)
         changes += diffDescription(propertyType: "generic where clause", oldValue: other.genericWhereClauseDescription, newValue: genericWhereClauseDescription)
         return changes.compactMap { $0 }

Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Subscript.swift

@@ -6,40 +6,6 @@
 
 import Foundation
 
-extension SwiftInterfaceSubscript {
-
-    struct Parameter {
-
-        let firstName: String
-
-        /// optional second "internal" name - can be ignored
-        let secondName: String?
-
-        let type: String
-
-        let defaultValue: String?
-
-        var description: String {
-            var description = [
-                firstName,
-                secondName
-            ].compactMap { $0 }.joined(separator: " ")
-
-            if description.isEmpty {
-                description += "\(type)"
-            } else {
-                description += ": \(type)"
-            }
-
-            if let defaultValue {
-                description += " = \(defaultValue)"
-            }
-
-            return description
-        }
-    }
-}
-
 class SwiftInterfaceSubscript: SwiftInterfaceElement {
 
     let name: String = "subscript"
@@ -53,7 +19,7 @@ class SwiftInterfaceSubscript: SwiftInterfaceElement {
     /// e.g. <T>
     let genericParameterDescription: String?
 
-    let parameters: [Parameter]
+    let parameters: [SwiftInterfaceElementParameter]
 
     let returnType: String
 
@@ -69,7 +35,7 @@ class SwiftInterfaceSubscript: SwiftInterfaceElement {
     var parent: (any SwiftInterfaceElement)?
 
     var diffableSignature: String {
-        "\(name)(\(parameters.map { "\($0.firstName):" }.joined()))"
+        "\(name)(\(parameters.map(\.valueForDiffableSignature).joined()))"
     }
 
     var consolidatableName: String { name }
@@ -82,7 +48,7 @@ class SwiftInterfaceSubscript: SwiftInterfaceElement {
         attributes: [String],
         modifiers: [String],
         genericParameterDescription: String?,
-        parameters: [Parameter],
+        parameters: [SwiftInterfaceElementParameter],
         returnType: String,
         genericWhereClauseDescription: String?,
         accessors: String?
@@ -105,7 +71,7 @@ extension SwiftInterfaceSubscript {
         changes += diffDescription(propertyType: "attribute", oldValues: other.attributes, newValues: attributes)
         changes += diffDescription(propertyType: "modifier", oldValues: other.modifiers, newValues: modifiers)
         changes += diffDescription(propertyType: "generic parameter description", oldValue: other.genericParameterDescription, newValue: genericParameterDescription)
-        changes += diffDescription(propertyType: "parameter", oldValues: other.parameters.map(\.description), newValues: parameters.map(\.description)) // TODO: Maybe have a better way to show changes
+        changes += diffDescription(oldParameters: other.parameters, newParameters: parameters)
         changes += diffDescription(propertyType: "return type", oldValue: other.returnType, newValue: returnType)
         changes += diffDescription(propertyType: "generic where clause", oldValue: other.genericWhereClauseDescription, newValue: genericWhereClauseDescription)
         changes += diffDescription(propertyType: "accessors", oldValue: other.accessors, newValue: accessors)