Adding support for macos + package swiftinterface

goergisn · goergisn · commit 00dce411461d · 2024-11-13T18:33:25.000+01:00
diff --git a/.github/workflows/build-release.yml b/.github/workflows/build-release.yml
@@ -24,7 +24,7 @@ jobs:
         
     - name: 🛠️ Build with release configuration
       run: |
-        swift build --configuration release -skipPackagePluginValidation | xcpretty --utf --color && exit ${PIPESTATUS[0]}
+        swift build --configuration release | xcpretty --utf --color && exit ${PIPESTATUS[0]}
         
     - uses: actions/upload-artifact@v4
       with:
diff --git a/.github/workflows/detect-api.changes.yml b/.github/workflows/detect-api.changes.yml
@@ -47,7 +47,7 @@ jobs:
             OLD="${{ env.target }}~${{ env.githubRepo }}"
         fi
         
-        swift run public-api-diff project --new "$NEW" --old "$OLD" --output "$PROJECT_FOLDER/api_comparison.md" --log-level debug --log-output "$PROJECT_FOLDER/logs.txt"
+        swift run public-api-diff project --new "$NEW" --old "$OLD" --platform macos --output "$PROJECT_FOLDER/api_comparison.md" --log-level debug --log-output "$PROJECT_FOLDER/logs.txt"
         cat "$PROJECT_FOLDER/logs.txt"
         cat "$PROJECT_FOLDER/api_comparison.md" >> $GITHUB_STEP_SUMMARY
       env:
diff --git a/.github/workflows/stale-issues.yml b/.github/workflows/stale-issues.yml
@@ -3,7 +3,7 @@
 # You can adjust the behavior by modifying this file.
 # For more information, see:
 # https://github.com/actions/stale
-name: Manage stale issues
+name: 🏷️ Manage stale issues
 
 on:
   schedule:
diff --git a/.swiftlint.yml b/.swiftlint.yml
@@ -0,0 +1,36 @@
+disabled_rules:
+  - trailing_whitespace
+  - nesting
+  - todo
+  - for_where
+
+excluded:
+  - Build
+  - .build
+  - Tests
+  - Internal
+  - Docs
+  - Demo
+  - Package.swift
+  - DerivedData
+  - Carthage
+  - TempProject
+  - Scripts
+
+line_length:
+  ignores_function_declarations: true
+  ignores_urls: true
+  warning: 140
+  
+file_length:
+  warning: 500
+  
+function_parameter_count:
+  warning: 10
+  error: 15
+  
+identifier_name:
+  min_length:
+    warning: 2
+  max_length:
+    warning: 40
diff --git a/Sources/ExecutableTargets/CommandLineTool/CommandLineTool+Extensions.swift b/Sources/ExecutableTargets/CommandLineTool/CommandLineTool+Extensions.swift
@@ -14,6 +14,7 @@ extension SwiftInterfaceType: ExpressibleByArgument {
         switch argument {
         case "public": self = .public
         case "private": self = .private
+        case "package": self = .package
         default: return nil
         }
     }
diff --git a/Sources/ExecutableTargets/CommandLineTool/ProjectToOutputCommand.swift b/Sources/ExecutableTargets/CommandLineTool/ProjectToOutputCommand.swift
@@ -29,6 +29,9 @@ struct ProjectToOutputCommand: AsyncParsableCommand {
     @Option(help: "Specify the old version to compare to")
     public var old: String
 
+    @Option(help: "The platform to build the project for (iOS/macOS)")
+    public var platform: ProjectPlatform
+
     /// The (optional) scheme to build
     ///
     /// Needed when comparing 2 xcode projects
@@ -74,6 +77,7 @@ struct ProjectToOutputCommand: AsyncParsableCommand {
                 oldSource: oldSource,
                 newSource: newSource,
                 projectType: projectType,
+                platform: platform,
                 swiftInterfaceType: swiftInterfaceType,
                 logger: logger
             )
@@ -136,12 +140,14 @@ private extension ProjectToOutputCommand {
         oldSource: ProjectSource,
         newSource: ProjectSource,
         projectType: ProjectType,
+        platform: ProjectPlatform,
         swiftInterfaceType: SwiftInterfaceType,
         logger: any Logging
     ) async throws -> ProjectBuilder.Result {
 
         let projectBuilder = ProjectBuilder(
             projectType: projectType,
+            platform: platform,
             swiftInterfaceType: swiftInterfaceType,
             logger: logger
         )
@@ -207,3 +213,22 @@ private extension ProjectToOutputCommand {
         )
     }
 }
+
+extension ProjectPlatform: ExpressibleByArgument {
+
+    static var mapping: [String: ProjectPlatform] = [
+        "iOS": .iOS,
+        "macOS": .macOS
+    ]
+    
+    public init?(argument: String) {
+        for (key, value) in Self.mapping {
+            if argument.compare(key, options: .caseInsensitive) == .orderedSame {
+                self = value
+                return
+            }
+        }
+
+        return nil
+    }
+}
diff --git a/Sources/PublicModules/PADProjectBuilder/ProjectBuilder.swift b/Sources/PublicModules/PADProjectBuilder/ProjectBuilder.swift
@@ -33,18 +33,21 @@ public struct ProjectBuilder {
     }
 
     private let projectType: ProjectType
+    private let platform: ProjectPlatform
     private let swiftInterfaceType: SwiftInterfaceType
     private let fileHandler: any FileHandling
     private let shell: any ShellHandling
     private let logger: (any Logging)?
 
     public init(
         projectType: ProjectType,
+        platform: ProjectPlatform,
         swiftInterfaceType: SwiftInterfaceType,
         logger: (any Logging)? = nil
     ) {
         self.init(
             projectType: projectType,
+            platform: platform,
             swiftInterfaceType: swiftInterfaceType,
             fileHandler: FileManager.default,
             shell: Shell(),
@@ -54,12 +57,14 @@ public struct ProjectBuilder {
 
     init(
         projectType: ProjectType,
+        platform: ProjectPlatform,
         swiftInterfaceType: SwiftInterfaceType,
         fileHandler: any FileHandling = FileManager.default,
         shell: any ShellHandling = Shell(),
         logger: (any Logging)?
     ) {
         self.projectType = projectType
+        self.platform = platform
         self.swiftInterfaceType = swiftInterfaceType
         self.fileHandler = fileHandler
         self.shell = shell
@@ -99,6 +104,7 @@ public struct ProjectBuilder {
         let producer = SwiftInterfaceProducer(
             workingDirectoryPath: workingDirectoryPath,
             projectType: projectType,
+            platform: platform,
             swiftInterfaceType: swiftInterfaceType,
             fileHandler: fileHandler,
             shell: shell,
diff --git a/Sources/PublicModules/PADProjectBuilder/ProjectPlatform.swift b/Sources/PublicModules/PADProjectBuilder/ProjectPlatform.swift
@@ -0,0 +1,13 @@
+//
+//  ProjectPlatform.swift
+//  public-api-diff
+//
+//  Created by Alexander Guretzki on 13/11/2024.
+//
+
+/// The platform to build the project on
+public enum ProjectPlatform {
+
+    case macOS
+    case iOS
+}
diff --git a/Sources/PublicModules/PADProjectBuilder/SwiftInterfaceProducer/SwiftInterfaceProducer.swift b/Sources/PublicModules/PADProjectBuilder/SwiftInterfaceProducer/SwiftInterfaceProducer.swift
@@ -22,6 +22,7 @@ struct SwiftInterfaceProducer {
 
     let workingDirectoryPath: String
     let projectType: ProjectType
+    let platform: ProjectPlatform
     let swiftInterfaceType: SwiftInterfaceType
     let fileHandler: any FileHandling
     let shell: any ShellHandling
@@ -122,12 +123,14 @@ extension SwiftInterfaceProducer {
         let newDerivedDataPath = try await xcodeTools.archive(
             projectDirectoryPath: newProjectDirectoryPath,
             scheme: scheme,
-            projectType: projectType
+            projectType: projectType,
+            platform: platform
         )
         let oldDerivedDataPath = try await xcodeTools.archive(
             projectDirectoryPath: oldProjectDirectoryPath,
             scheme: scheme,
-            projectType: projectType
+            projectType: projectType,
+            platform: platform
         )
 
         return (newDerivedDataPath, oldDerivedDataPath)
diff --git a/Sources/PublicModules/PADProjectBuilder/SwiftInterfaceProducer/XcodeTools.swift b/Sources/PublicModules/PADProjectBuilder/SwiftInterfaceProducer/XcodeTools.swift
@@ -49,16 +49,28 @@ struct XcodeTools {
     func archive(
         projectDirectoryPath: String,
         scheme: String,
-        projectType: ProjectType
+        projectType: ProjectType,
+        platform: ProjectPlatform
     ) async throws -> String {
+        
         var commandComponents = [
             "cd \(projectDirectoryPath);",
             "xcodebuild clean build -scheme \"\(scheme)\"",
-            "-destination \"generic/platform=iOS\"",
             "-derivedDataPath \(Constants.derivedDataPath)",
-            "-sdk `\(Constants.simulatorSdkCommand)`",
             "BUILD_LIBRARY_FOR_DISTRIBUTION=YES"
         ]
+        
+        switch platform {
+        case .iOS:
+            commandComponents += [
+                "-sdk `\(Constants.simulatorSdkCommand)`",
+                "-destination \"generic/platform=iOS\"",
+            ]
+        case .macOS:
+            commandComponents += [
+                "-destination \"generic/platform=macOS\"",
+            ]
+        }
 
         switch projectType {
         case .swiftPackage:
diff --git a/Sources/Shared/Package/SwiftPackageFileHelperModule/SwiftPackageDescription.swift b/Sources/Shared/Package/SwiftPackageFileHelperModule/SwiftPackageDescription.swift
@@ -127,14 +127,19 @@ package extension SwiftPackageDescription.Dependency {
         // TODO: Which other requirements exist?
 
         package let exact: [String]?
+        package let range: [[String: String]]?
     }
 }
 
 extension SwiftPackageDescription.Dependency.Requirement: CustomStringConvertible {
 
     package var description: String {
-        if let exactVersion = exact?.first {
-            return "exact: \"\(exactVersion)\""
+        if let version = exact?.first {
+            return "exact: \"\(version)\""
+        }
+        
+        if let lowerUpper = range?.first, let lower = lowerUpper["lower_bound"], let upper = lowerUpper["upper_bound"] {
+            return "\"\(lower)\"..<\"\(upper)\""
         }
 
         return "UNKNOWN_REQUIREMENT"
@@ -155,6 +160,7 @@ package extension SwiftPackageDescription {
             case library = "library"
             case binary = "binary"
             case test = "test"
+            case executable = "executable"
         }
 
         package let name: String
@@ -208,6 +214,7 @@ extension SwiftPackageDescription.Target.TargetType: CustomStringConvertible {
         case .binary: "binaryTarget"
         case .library: "target"
         case .test: "testTarget"
+        case .executable: "executableTarget"
         }
     }
 }
diff --git a/Sources/Shared/Package/SwiftPackageFileHelperModule/SwiftPackageFileHelper.swift b/Sources/Shared/Package/SwiftPackageFileHelperModule/SwiftPackageFileHelper.swift
@@ -152,9 +152,14 @@ private extension SwiftPackageFileHelper {
     }
 
     func decodePackageDescription(from packageDescriptionData: Data, warnings: [String]) throws -> SwiftPackageDescription {
-        var packageDescription = try JSONDecoder().decode(SwiftPackageDescription.self, from: packageDescriptionData)
-        packageDescription.warnings = warnings
-        return packageDescription
+        do {
+            var packageDescription = try JSONDecoder().decode(SwiftPackageDescription.self, from: packageDescriptionData)
+            packageDescription.warnings = warnings
+            return packageDescription
+        } catch {
+            logger?.log(String(describing: error), from: String(describing: Self.self))
+            throw error
+        }
     }
 }
 
diff --git a/Sources/Shared/Public/PADSwiftInterfaceFileLocator/SwiftInterfaceFileLocator.swift b/Sources/Shared/Public/PADSwiftInterfaceFileLocator/SwiftInterfaceFileLocator.swift
@@ -63,14 +63,18 @@ public struct SwiftInterfaceFileLocator {
         switch type {
         case .private:
             swiftInterfacePaths = swiftModuleContent.filter { $0.hasSuffix(".private.swiftinterface") }
+        case .package:
+            swiftInterfacePaths = swiftModuleContent.filter { $0.hasSuffix(".package.swiftinterface") }
         case .public:
-            swiftInterfacePaths = swiftModuleContent.filter { $0.hasSuffix(".swiftinterface") && !$0.hasSuffix(".private.swiftinterface") }
+            swiftInterfacePaths = swiftModuleContent.filter { $0.hasSuffix(".swiftinterface") && !$0.hasSuffix(".private.swiftinterface") && !$0.hasSuffix(".package.swiftinterface") }
         }
 
         guard let swiftInterfacePath = swiftInterfacePaths.first else {
             switch type {
             case .private:
                 throw FileHandlerError.pathDoesNotExist(path: "'\(completeSwiftModulePath)/\(scheme).private.swiftinterface'")
+            case .package:
+                throw FileHandlerError.pathDoesNotExist(path: "'\(completeSwiftModulePath)/\(scheme).package.swiftinterface'")
             case .public:
                 throw FileHandlerError.pathDoesNotExist(path: "'\(completeSwiftModulePath)/\(scheme).swiftinterface'")
             }
diff --git a/Sources/Shared/Public/PADSwiftInterfaceFileLocator/SwiftInterfaceType.swift b/Sources/Shared/Public/PADSwiftInterfaceFileLocator/SwiftInterfaceType.swift
@@ -10,11 +10,13 @@ import Foundation
 public enum SwiftInterfaceType {
     case `private`
     case `public`
+    case `package`
 
     var name: String {
         switch self {
         case .private: "private"
         case .public: "public"
+        case .package: "package"
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@ extension SwiftInterfaceType: ExpressibleByArgument {`
`14`	`14`	`switch argument {`
`15`	`15`	`case "public": self = .public`
`16`	`16`	`case "private": self = .private`
	`17`	`+ case "package": self = .package`
`17`	`18`	`default: return nil`
`18`	`19`	`}`
`19`	`20`	`}`