fix: Attempt to work around PackageDescription.Path deprecation

Author: paulgessinger

Plugins/MetaProtocolCodable/Plugin.swift

@@ -50,32 +50,32 @@ struct MetaProtocolCodable: BuildToolPlugin {
         let (allTargets, imports) = config.scanInput(for: target, in: context)
 
         // Setup folder
-        let genFolder = context.pluginWorkDirectory.appending(["ProtocolGen"])
+        let genFolder = context.pluginWorkDirectoryURL
         try FileManager.default.createDirectory(
-            atPath: genFolder.string, withIntermediateDirectories: true
+            at: genFolder, withIntermediateDirectories: true
         )
 
         // Create source scan commands
-        var intermFiles: [Path] = []
+        var intermFiles: [URL] = []
         var buildCommands = allTargets.flatMap { target in
             return target.sourceFiles(withSuffix: "swift").map { file in
                 let moduleName = target.moduleName
-                let fileName = file.path.stem
+                let fileName = file.url.lastPathComponent
                 let genFileName = "\(moduleName)-\(fileName)-gen.json"
-                let genFile = genFolder.appending([genFileName])
+                let genFile = genFolder.appending(path: genFileName)
                 intermFiles.append(genFile)
                 return Command.buildCommand(
                     displayName: """
                         Parse source file "\(fileName)" in module "\(moduleName)"
                         """,
-                    executable: tool.path,
+                    executable: tool.url,
                     arguments: [
                         "parse",
-                        file.path.string,
+                        file.url.absoluteString,
                         "--output",
-                        genFile.string,
+                        genFile.absoluteString,
                     ],
-                    inputFiles: [file.path],
+                    inputFiles: [file.url],
                     outputFiles: [genFile]
                 )
             }
@@ -84,20 +84,20 @@ struct MetaProtocolCodable: BuildToolPlugin {
         // Create syntax generation command
         let moduleName = target.moduleName
         let genFileName = "\(moduleName)+ProtocolHelperCoders.swift"
-        let genPath = genFolder.appending(genFileName)
-        var genArgs = ["generate", "--output", genPath.string]
+        let genPath = genFolder.appending(path:genFileName)
+        var genArgs = ["generate", "--output", genPath.absoluteString]
         for `import` in imports {
             genArgs.append(contentsOf: ["--module", `import`])
         }
         for file in intermFiles {
-            genArgs.append(file.string)
+            genArgs.append(file.absoluteString)
         }
         buildCommands.append(
             .buildCommand(
                 displayName: """
                     Generate protocol decoding/encoding syntax for "\(moduleName)"
                     """,
-                executable: tool.path,
+                executable: tool.url,
                 arguments: genArgs,
                 inputFiles: intermFiles,
                 outputFiles: [genPath]

Plugins/MetaProtocolCodable/PluginContext.swift

@@ -1,4 +1,5 @@
 import PackagePlugin
+import Foundation
 
 /// Provides information about the package for which the plugin is invoked,
 /// as well as contextual information based on the plugin's stated intent
@@ -24,6 +25,8 @@ protocol MetaProtocolCodablePluginContext {
     /// directories for cache files and other file system content that either
     /// it or the command will need.
     var pluginWorkDirectory: Path { get }
+    var pluginWorkDirectoryURL: URL { get }
+    
     /// The targets which are local to current context.
     ///
     /// These targets are included in the same package/project as this context.

Plugins/MetaProtocolCodable/SourceTarget/SwiftPackageTarget.swift

@@ -1,15 +1,42 @@
 import Foundation
 import PackagePlugin
 
+/// This is a workaround because PackageDescription.Target.directoryURL will not be available until version 6.1
+/// See:  https://github.com/swiftlang/swift-package-manager/blob/735ddd97fa651729921315c8e46bd790429362cb/Sources/PackagePlugin/PackageModel.swift#L184-L186///
+/// The workaround defines a custom protocol that adds the missing property, and then introduces
+/// a new initializer that accepts the actual target protocol and attempts to downcast.
+protocol CompatSourceModuleTarget: SourceModuleTarget {
+    var directoryURL: URL { get }
+}
+
 /// Represents an SwiftPM target.
 ///
 /// Uses `SourceModuleTarget` to provide conformances.
 struct SwiftPackageTarget {
     /// The actual module for this target.
     ///
     /// The conformances provided uses this module.
-    let module: any SourceModuleTarget
+    let module: any CompatSourceModuleTarget
+    
+}
+
+/// Workaround for 6.1 compatibility
+extension ClangSourceModuleTarget: CompatSourceModuleTarget {}
+extension SwiftSourceModuleTarget: CompatSourceModuleTarget {}
+
+extension SwiftPackageTarget {
+init<M>(module: M) where M: SourceModuleTarget {
+    switch module {
+    case let module as ClangSourceModuleTarget:
+        self.module = module
+        case let module as SwiftSourceModuleTarget:
+        self.module = module
+    default:
+        fatalError("Unsupported module type")
+    }
+}
 }
+    
 
 extension SwiftPackageTarget: MetaProtocolCodableSourceTarget {
     /// The name of the module produced
@@ -29,7 +56,7 @@ extension SwiftPackageTarget: MetaProtocolCodableSourceTarget {
             default:
                 nil
             }
-        }.map { Self.init(module: $0) }
+        }.map { (target: any SourceModuleTarget) in  Self.init(module: target) }
     }
 
     /// All the targets on which current target depends on.
@@ -64,17 +91,16 @@ extension SwiftPackageTarget: MetaProtocolCodableSourceTarget {
     /// - Returns: The config file path.
     func configPath(named name: String) throws -> String? {
         let fileManager = FileManager.default
-        let directory = module.directory.string
-        let contents = try fileManager.contentsOfDirectory(atPath: directory)
+        let directory = module.directoryURL
+        let contents = try fileManager.contentsOfDirectory(at: directory, includingPropertiesForKeys: nil)
         let file = contents.first { file in
-            let path = Path(file)
             return name.lowercased()
-                == path.stem
+                == file.lastPathComponent
                 .components(separatedBy: .alphanumerics.inverted)
                 .joined(separator: "")
                 .lowercased()
         }
         guard let file else { return nil }
-        return module.directory.appending([file]).string
+        return directory.appending(path: file.absoluteString).absoluteString
     }
 }