Merge pull request #74 from SwiftPackageIndex/processing-env-variable

Inject SPI_PROCESSING into ShellOut commands

Author: finestructure

Package.resolved

@@ -1,4 +1,4 @@
-// swift-tools-version:5.8
+// swift-tools-version:6.0
 
 // Copyright Dave Verwer, Sven A. Schmidt, and other contributors.
 //
@@ -18,12 +18,12 @@ import PackageDescription
 
 let package = Package(
     name: "validator",
-    platforms: [.macOS(.v10_15)],
+    platforms: [.macOS(.v15)],
     products: [
       .executable(name: "validator", targets: ["validator"])
     ],
     dependencies: [
-        .package(url: "https://github.com/JohnSundell/ShellOut.git", from: "2.3.0"),
+        .package(url: "https://github.com/SwiftPackageIndex/ShellOut.git", from: "3.0.0"),
         .package(url: "https://github.com/SwiftPackageIndex/CanonicalPackageURL.git", from: "0.0.6"),
         .package(url: "https://github.com/apple/swift-algorithms.git", from: "1.0.0"),
         .package(url: "https://github.com/apple/swift-argument-parser", from: "1.0.0"),
@@ -45,5 +45,6 @@ let package = Package(
         .testTarget(name: "ValidatorTests",
                     dependencies: ["ValidatorCore"],
                     exclude: ["Fixtures"]),
-    ]
+    ],
+    swiftLanguageModes: [.version("5")]
 )

Package.swift

@@ -17,8 +17,8 @@ import ShellOut
 
 extension ShellOutCommand {
 #if os(macOS)
-    static let packageDump = ShellOutCommand(string: "/usr/bin/xcrun swift package dump-package")
+    static let packageDump = ShellOutCommand(command: "/usr/bin/xcrun", arguments: ["swift", "package", "dump-package"])
 #else
-    static let packageDump = ShellOutCommand(string: "swift package dump-package")
+    static let packageDump = ShellOutCommand(command: "swift", arguments: ["package", "dump-package"])
 #endif
 }

Sources/ValidatorCore/Extensions/ShellOut+ext.swift

@@ -103,7 +103,8 @@ extension Package {
                 }
             }
             do {
-                guard let pkgJSON = try Current.shell.run(command: .packageDump, at: tempDir)
+                guard let pkgJSON = try await Current.shell.run(command: .packageDump, at: tempDir)
+                    .stdout
                         .data(using: .utf8) else {
                     throw AppError.dumpPackageError("package dump did not return data")
                 }

Sources/ValidatorCore/Package.swift

@@ -17,21 +17,29 @@ import ShellOut
 
 
 struct Shell {
-    var run: (ShellOutCommand, String, FileHandle?, FileHandle?) throws -> String
+    var run: (ShellOutCommand, String, FileHandle?, FileHandle?) async throws -> (stdout: String, stderr: String)
 
     @discardableResult
-    func run(command: ShellOutCommand, at path: String = ".") throws -> String {
-        return try run(command, path, nil, nil)
+    func run(command: ShellOutCommand, at path: String = ".") async throws -> (stdout: String, stderr: String) {
+        try await run(command, path, nil, nil)
     }
 
-    static let live: Self = .init(run: { cmd, path, stdout, stderr in
-        try ShellOut.shellOut(to: cmd,
-                              at: path,
-                              outputHandle: stdout,
-                              errorHandle: stderr)
-    })
+    static var live: Self {
+        .init(run: { cmd, path, stdout, stderr in
+            try await ShellOut.shellOut(
+                to: cmd,
+                at: path,
+                outputHandle: stdout,
+                errorHandle: stderr,
+                environment: ProcessInfo.processInfo.environment
+                    .merging(["SPI_PROCESSING": "1"], uniquingKeysWith: { $1 })
+            )
+        })
+    }
 
-    static let mock: Self = .init(
-        run: { _, _, _, _ in fatalError("not implemented") }
-    )
+    static var mock: Self {
+        .init(
+            run: { _, _, _, _ in fatalError("not implemented") }
+        )
+    }
 }