Add quoteArguments option (default: true) to shellOut command

Author: finestructure

Package.resolved

@@ -13,9 +13,15 @@ let package = Package(
     products: [
         .library(name: "ShellOut", targets: ["ShellOut"])
     ],
+    dependencies: [
+        .package(url: "https://github.com/SwiftPackageIndex/ShellQuote", from: "1.0.0"),
+    ],
     targets: [
         .target(
             name: "ShellOut",
+            dependencies: [
+                .product(name: "ShellQuote", package: "ShellQuote")
+            ],
             path: "Sources"
         ),
         .testTarget(

Package.swift

@@ -6,6 +6,7 @@
 
 import Foundation
 import Dispatch
+import ShellQuote
 
 // MARK: - API
 
@@ -35,8 +36,11 @@ import Dispatch
     process: Process = .init(),
     outputHandle: FileHandle? = nil,
     errorHandle: FileHandle? = nil,
-    environment: [String : String]? = nil
+    environment: [String : String]? = nil,
+    quoteArguments: Bool = true
 ) throws -> String {
+    let arguments = quoteArguments ? arguments.map(ShellQuote.quote) : arguments
+    print("*** arguments: ", arguments)
     let command = "cd \(path.escapingSpaces) && \(command) \(arguments.joined(separator: " "))"
 
     return try process.launchBash(

Sources/ShellOut.swift

@@ -174,4 +174,9 @@ class ShellOutTests: XCTestCase {
         try shellOut(to: .generateSwiftPackageXcodeProject(), at: packagePath)
         XCTAssertTrue(try shellOut(to: "ls -a", at: packagePath).contains("SwiftPackageManagerTest.xcodeproj"))
     }
+
+    func testArgumentQuoting() throws {
+        XCTAssertEqual(try shellOut(to: "echo", arguments: ["foo ; echo bar"]), "foo ; echo bar")
+        XCTAssertEqual(try shellOut(to: "echo", arguments: ["foo ; echo bar"], quoteArguments: false), "foo\nbar")
+    }
 }