Extend TargetSourcesBuilder to return other files than sources and resources, and extend the ExtensionEvaluator to pass them on to extensions.

Author: abertelrud

Sources/PackageLoading/PackageBuilder.swift

@@ -744,7 +744,7 @@ public final class PackageBuilder {
             fs: fileSystem,
             diags: diagnostics
         )
-        let (sources, resources, headers) = try sourcesBuilder.run()
+        let (sources, resources, headers, others) = try sourcesBuilder.run()
 
         // Make sure defaultLocalization is set if the target has localized resources.
         let hasLocalizedResources = resources.contains(where: { $0.localization != nil })
@@ -814,6 +814,7 @@ public final class PackageBuilder {
                 type: targetType,
                 sources: sources,
                 resources: resources,
+                others: others,
                 dependencies: dependencies,
                 swiftVersion: try swiftVersion(),
                 buildSettings: buildSettings

Sources/PackageLoading/TargetSourcesBuilder.swift

@@ -135,7 +135,7 @@ public struct TargetSourcesBuilder {
     }
 
     /// Run the builder to produce the sources of the target.
-    public func run() throws -> (sources: Sources, resources: [Resource], headers: [AbsolutePath]) {
+    public func run() throws -> (sources: Sources, resources: [Resource], headers: [AbsolutePath], others: [AbsolutePath]) {
         let contents = computeContents()
         var pathToRule: [AbsolutePath: Rule] = [:]
 
@@ -146,6 +146,7 @@ public struct TargetSourcesBuilder {
         // Emit an error if we found files without a matching rule in
         // tools version >= v5_3. This will be activated once resources
         // support is complete.
+        var others: [AbsolutePath] = []
         if toolsVersion >= .v5_3 {
             let filesWithNoRules = pathToRule.filter { $0.value.rule == .none }
             if !filesWithNoRules.isEmpty {
@@ -155,6 +156,7 @@ public struct TargetSourcesBuilder {
                 }
                 diags.emit(.warning(warning))
             }
+            others.append(contentsOf: filesWithNoRules.keys)
         }
 
         let headers = pathToRule.lazy.filter { $0.value.rule == .header }.map { $0.key }.sorted()
@@ -173,7 +175,7 @@ public struct TargetSourcesBuilder {
             throw Target.Error.mixedSources(targetPath)
         }
 
-        return (sources, resources, headers)
+        return (sources, resources, headers, others)
     }
 
     private struct Rule {

Sources/PackageModel/Target.swift

@@ -123,6 +123,9 @@ public class Target: ObjectIdentifierProtocol, PolymorphicCodableProtocol {
 
     /// The resource files in the target.
     public let resources: [Resource]
+    
+    /// Other kinds of files in the target.
+    public let others: [AbsolutePath]
 
     /// The list of platforms that are supported by this target.
     public let platforms: [SupportedPlatform]
@@ -143,6 +146,7 @@ public class Target: ObjectIdentifierProtocol, PolymorphicCodableProtocol {
         type: Kind,
         sources: Sources,
         resources: [Resource] = [],
+        others: [AbsolutePath] = [],
         dependencies: [Target.Dependency],
         buildSettings: BuildSettings.AssignmentTable
     ) {
@@ -153,13 +157,14 @@ public class Target: ObjectIdentifierProtocol, PolymorphicCodableProtocol {
         self.type = type
         self.sources = sources
         self.resources = resources
+        self.others = others
         self.dependencies = dependencies
         self.c99name = self.name.spm_mangledToC99ExtendedIdentifier()
         self.buildSettings = buildSettings
     }
 
     private enum CodingKeys: String, CodingKey {
-        case name, bundleName, defaultLocalization, platforms, type, sources, resources, buildSettings
+        case name, bundleName, defaultLocalization, platforms, type, sources, resources, others, buildSettings
     }
 
     public func encode(to encoder: Encoder) throws {
@@ -174,6 +179,7 @@ public class Target: ObjectIdentifierProtocol, PolymorphicCodableProtocol {
         try container.encode(type, forKey: .type)
         try container.encode(sources, forKey: .sources)
         try container.encode(resources, forKey: .resources)
+        try container.encode(others, forKey: .others)
         try container.encode(buildSettings, forKey: .buildSettings)
     }
 
@@ -186,6 +192,7 @@ public class Target: ObjectIdentifierProtocol, PolymorphicCodableProtocol {
         self.type = try container.decode(Kind.self, forKey: .type)
         self.sources = try container.decode(Sources.self, forKey: .sources)
         self.resources = try container.decode([Resource].self, forKey: .resources)
+        self.others = try container.decode([AbsolutePath].self, forKey: .others)
         // FIXME: dependencies property is skipped on purpose as it points to
         // the actual target dependency object.
         self.dependencies = []
@@ -230,6 +237,7 @@ public final class SwiftTarget: Target {
         type: Kind,
         sources: Sources,
         resources: [Resource] = [],
+        others: [AbsolutePath] = [],
         dependencies: [Target.Dependency] = [],
         swiftVersion: SwiftLanguageVersion,
         buildSettings: BuildSettings.AssignmentTable = .init()
@@ -243,6 +251,7 @@ public final class SwiftTarget: Target {
             type: type,
             sources: sources,
             resources: resources,
+            others: others,
             dependencies: dependencies,
             buildSettings: buildSettings
         )

Sources/SPMBuildCore/ExtensionEvaluator.swift

@@ -67,6 +67,8 @@ extension PackageGraph {
                 targetDir: target.sources.root.pathString,
                 packageDir: package.path.pathString,
                 sourceFiles: target.sources.paths.map{ $0.pathString },
+                resourceFiles: target.underlyingTarget.resources.map{ $0.path.pathString },
+                otherFiles: target.underlyingTarget.others.map { $0.pathString },
                 dependencies: dependencyTargets.map {
                     .init(targetName: $0.name, moduleName: $0.c99name, targetDir: $0.sources.root.pathString)
                 },
@@ -289,6 +291,8 @@ struct ExtensionEvaluationInput: Codable {
     var targetDir: String
     var packageDir: String
     var sourceFiles: [String]
+    var resourceFiles: [String]
+    var otherFiles: [String]
     var dependencies: [DependencyTarget]
     public struct DependencyTarget: Codable {
         var targetName: String

Tests/PackageLoadingTests/TargetSourcesBuilderTests.swift

@@ -143,7 +143,7 @@ class TargetSourcesBuilderTests: XCTestCase {
             toolsVersion: .minimumRequired,
             fileTypes: ["something"])
 
-        build(target: target, additionalFileRules: [somethingRule], toolsVersion: .v5, fs: fs) { _, _, _, _ in
+        build(target: target, additionalFileRules: [somethingRule], toolsVersion: .v5, fs: fs) { _, _, _, _,_  in
             // No diagnostics
         }
     }
@@ -161,7 +161,7 @@ class TargetSourcesBuilderTests: XCTestCase {
                 "/Resources/Sub/foo.txt"
             )
 
-            build(target: target, toolsVersion: .v5_3, fs: fs) { _, _, _, diagnostics in
+            build(target: target, toolsVersion: .v5_3, fs: fs) { _, _, _, _, diagnostics in
                 diagnostics.check(diagnostic: "multiple resources named 'foo.txt' in target 'Foo'", behavior: .error)
                 diagnostics.checkUnordered(diagnostic: "found 'Resources/foo.txt'", behavior: .note)
                 diagnostics.checkUnordered(diagnostic: "found 'Resources/Sub/foo.txt'", behavior: .note)
@@ -181,7 +181,7 @@ class TargetSourcesBuilderTests: XCTestCase {
                 "/Copied/foo.txt"
             )
 
-            build(target: target, toolsVersion: .v5_3, fs: fs) { _, _, _, diagnostics in
+            build(target: target, toolsVersion: .v5_3, fs: fs) { _, _, _, _, diagnostics in
                 diagnostics.check(diagnostic: "multiple resources named 'foo.txt' in target 'Foo'", behavior: .error)
                 diagnostics.checkUnordered(diagnostic: "found 'Processed/foo.txt'", behavior: .note)
                 diagnostics.checkUnordered(diagnostic: "found 'Copied/foo.txt'", behavior: .note)
@@ -201,7 +201,7 @@ class TargetSourcesBuilderTests: XCTestCase {
                 "/Copied/foo.txt"
             )
 
-            build(target: target, toolsVersion: .v5_3, fs: fs) { _, _, _, diagnostics in
+            build(target: target, toolsVersion: .v5_3, fs: fs) { _, _, _, _, diagnostics in
                 // No diagnostics
             }
         }
@@ -219,7 +219,7 @@ class TargetSourcesBuilderTests: XCTestCase {
                 "/B/Copy/foo.txt"
             )
 
-            build(target: target, toolsVersion: .v5_3, fs: fs) { _, _, _, diagnostics in
+            build(target: target, toolsVersion: .v5_3, fs: fs) { _, _, _, _, diagnostics in
                 diagnostics.check(diagnostic: "multiple resources named 'Copy' in target 'Foo'", behavior: .error)
                 diagnostics.checkUnordered(diagnostic: "found 'A/Copy'", behavior: .note)
                 diagnostics.checkUnordered(diagnostic: "found 'B/Copy'", behavior: .note)
@@ -239,7 +239,7 @@ class TargetSourcesBuilderTests: XCTestCase {
                 "/B/EN.lproj/foo.txt"
             )
 
-            build(target: target, toolsVersion: .v5_3, fs: fs) { _, _, _, diagnostics in
+            build(target: target, toolsVersion: .v5_3, fs: fs) { _, _, _, _, diagnostics in
                 diagnostics.check(diagnostic: "multiple resources named 'en.lproj/foo.txt' in target 'Foo'", behavior: .error)
                 diagnostics.checkUnordered(diagnostic: "found 'A/en.lproj/foo.txt'", behavior: .note)
                 diagnostics.checkUnordered(diagnostic: "found 'B/EN.lproj/foo.txt'", behavior: .note)
@@ -259,7 +259,7 @@ class TargetSourcesBuilderTests: XCTestCase {
                 "/B/en.lproj/foo.txt"
             )
 
-            build(target: target, toolsVersion: .v5_3, fs: fs) { _, _, _, diagnostics in
+            build(target: target, toolsVersion: .v5_3, fs: fs) { _, _, _, _, diagnostics in
                 diagnostics.check(diagnostic: "resource 'B/en.lproj' in target 'Foo' conflicts with other localization directories", behavior: .error)
             }
         }
@@ -272,7 +272,7 @@ class TargetSourcesBuilderTests: XCTestCase {
             "/en.lproj/Localizable.strings"
         )
 
-        build(target: target, toolsVersion: .v5_2, fs: fs) { _, resources, _, _ in
+        build(target: target, toolsVersion: .v5_2, fs: fs) { _, resources, _, _, _ in
             XCTAssert(resources.isEmpty)
             // No diagnostics
         }
@@ -289,7 +289,7 @@ class TargetSourcesBuilderTests: XCTestCase {
             "/Copied/en.lproj/sub/Localizable.strings"
         )
 
-        build(target: target, toolsVersion: .v5_3, fs: fs) { _, _, _, diagnostics in
+        build(target: target, toolsVersion: .v5_3, fs: fs) { _, _, _, _, diagnostics in
             diagnostics.check(diagnostic: "localization directory 'Processed/en.lproj' in target 'Foo' contains sub-directories, which is forbidden", behavior: .error)
         }
     }
@@ -303,7 +303,7 @@ class TargetSourcesBuilderTests: XCTestCase {
             "/Resources/en.lproj/Localizable.strings"
         )
 
-        build(target: target, toolsVersion: .v5_3, fs: fs) { _, _, _, diagnostics in
+        build(target: target, toolsVersion: .v5_3, fs: fs) { _, _, _, _, diagnostics in
             diagnostics.check(
                 diagnostic: .contains("""
                     resource 'Resources/en.lproj/Localizable.strings' in target 'Foo' is in a localization directory \
@@ -330,7 +330,7 @@ class TargetSourcesBuilderTests: XCTestCase {
             "/Icon.png"
         )
 
-        build(target: target, defaultLocalization: "fr", toolsVersion: .v5_3, fs: fs) { _, _, _, diagnostics in
+        build(target: target, defaultLocalization: "fr", toolsVersion: .v5_3, fs: fs) { _, _, _, _, diagnostics in
             diagnostics.check(
                 diagnostic: .contains("resource 'Icon.png' in target 'Foo' is missing the default localization 'fr'"),
                 behavior: .warning)
@@ -355,7 +355,7 @@ class TargetSourcesBuilderTests: XCTestCase {
             "/Icon.png"
         )
 
-        build(target: target, toolsVersion: .v5_3, fs: fs) { _, _, _, diagnostics in
+        build(target: target, toolsVersion: .v5_3, fs: fs) { _, _, _, _, diagnostics in
             diagnostics.checkUnordered(
                 diagnostic: .contains("resource 'Localizable.strings' in target 'Foo' has both localized and un-localized variants"),
                 behavior: .warning)
@@ -391,7 +391,7 @@ class TargetSourcesBuilderTests: XCTestCase {
             "/Other/Image.png"
         )
 
-        build(target: target, defaultLocalization: "fr", toolsVersion: .v5_3, fs: fs) { _, resources,  _, diagnostics in
+        build(target: target, defaultLocalization: "fr", toolsVersion: .v5_3, fs: fs) { _, resources, _,  _, diagnostics in
             XCTAssertEqual(Set(resources), [
                 Resource(rule: .process, path: AbsolutePath("/Processed/foo.txt"), localization: nil),
                 Resource(rule: .process, path: AbsolutePath("/Processed/En-uS.lproj/Localizable.stringsdict"), localization: "en-us"),
@@ -412,7 +412,7 @@ class TargetSourcesBuilderTests: XCTestCase {
             "/Foo/es.lproj/Image.png"
         )
 
-        build(target: try TargetDescription(name: "Foo"), defaultLocalization: "fr", toolsVersion: .v5_3, fs: fs) { _, resources, _, diagnostics in
+        build(target: try TargetDescription(name: "Foo"), defaultLocalization: "fr", toolsVersion: .v5_3, fs: fs) { _, resources, _, _, diagnostics in
             XCTAssertEqual(Set(resources), [
                 Resource(rule: .process, path: AbsolutePath("/Foo/fr.lproj/Image.png"), localization: "fr"),
                 Resource(rule: .process, path: AbsolutePath("/Foo/es.lproj/Image.png"), localization: "es"),
@@ -430,7 +430,7 @@ class TargetSourcesBuilderTests: XCTestCase {
                 "/Resources/Processed/Info.plist"
             )
 
-            build(target: target, toolsVersion: .v5_3, fs: fs) { _, _, _, diagnostics in
+            build(target: target, toolsVersion: .v5_3, fs: fs) { _, _, _, _, diagnostics in
                 diagnostics.check(
                     diagnostic: .contains("resource 'Resources/Processed/Info.plist' in target 'Foo' is forbidden"),
                     behavior: .error)
@@ -446,7 +446,7 @@ class TargetSourcesBuilderTests: XCTestCase {
                 "/Resources/Copied/Info.plist"
             )
 
-            build(target: target, toolsVersion: .v5_3, fs: fs) { _, _, _, diagnostics in
+            build(target: target, toolsVersion: .v5_3, fs: fs) { _, _, _, _, diagnostics in
                 diagnostics.check(
                     diagnostic: .contains("resource 'Resources/Copied/Info.plist' in target 'Foo' is forbidden"),
                     behavior: .error)
@@ -462,7 +462,7 @@ class TargetSourcesBuilderTests: XCTestCase {
         fs: FileSystem,
         file: StaticString = #file,
         line: UInt = #line,
-        checker: (Sources, [Resource], [AbsolutePath], DiagnosticsEngineResult) -> ()
+        checker: (Sources, [Resource], [AbsolutePath], [AbsolutePath], DiagnosticsEngineResult) -> ()
     ) {
         let diagnostics = DiagnosticsEngine()
         let builder = TargetSourcesBuilder(
@@ -478,10 +478,10 @@ class TargetSourcesBuilderTests: XCTestCase {
         )
 
         do {
-            let (sources, resources, headers) = try builder.run()
+            let (sources, resources, headers, others) = try builder.run()
 
             DiagnosticsEngineTester(diagnostics, file: file, line: line) { diagnostics in
-                checker(sources, resources, headers, diagnostics)
+                checker(sources, resources, headers, others, diagnostics)
             }
         } catch {
             XCTFail(error.localizedDescription, file: file, line: line)