Merge pull request #7 from SwiftPackageIndex/general-improvements

General package improvements

Author: finestructure

.github/workflows/ci.yml

@@ -32,7 +32,7 @@ jobs:
       matrix:
         image: [
           'swift:5.8',
-          'swiftlang/swift@sha256:f212429011a4c3592ffaa660fd78b5bc149e9df7920da02dfc0e7a761582fa10' # swiftlang/swift:nightly-5.9-focal 2023-08-16
+          'swift:5.9'
         ]
     container:
       image: ${{ matrix.image }}

.gitignore

@@ -2,5 +2,5 @@
 /.build
 /Packages
 /*.xcodeproj
-.swiftpm
-.vscode/
+/.swiftpm
+/.vscode

Makefile

@@ -1,27 +1,24 @@
 import Foundation
 
-
 public enum Argument: Equatable {
     case quoted(QuotedString)
     case verbatim(String)
 
-    public init(quoted string: String) {
-        self = .quoted(.init(string))
+    public init(quoted string: some StringProtocol) {
+        self = .quoted(.init(.init(string)))
     }
 
-    public init(verbatim string: String) {
-        self = .verbatim(string)
+    public init(verbatim string: some StringProtocol) {
+        self = .verbatim(.init(string))
     }
 }
 
-
 extension Argument: ExpressibleByStringLiteral {
     public init(stringLiteral value: StringLiteralType) {
         self = .quoted(.init(value))
     }
 }
 
-
 extension Argument: CustomStringConvertible {
     public var description: String {
         switch self {
@@ -33,19 +30,17 @@ extension Argument: CustomStringConvertible {
     }
 }
 
-
 extension Argument {
     public static func url(_ url: URL) -> Self { url.absoluteString.verbatim }
 }
 
 
-extension String {
+extension StringProtocol {
     public var quoted: Argument { .init(quoted: self) }
     public var verbatim: Argument { .init(verbatim: self) }
 }
 
-
-extension Array where Element == String {
+extension Sequence<StringProtocol> {
     public var quoted: [Argument] { map(\.quoted) }
     public var verbatim: [Argument] { map(\.verbatim) }
 }

ShellOut.podspec

@@ -1,6 +1,5 @@
 import ShellQuote
 
-
 public struct QuotedString: Equatable {
     public var unquoted: String
     public var quoted: String
@@ -11,7 +10,6 @@ public struct QuotedString: Equatable {
     }
 }
 
-
 extension QuotedString: CustomStringConvertible {
     public var description: String { quoted }
 }

Sources/Argument.swift

@@ -102,13 +102,14 @@ private extension TSCBasic.Process {
         environment: [String : String]? = nil,
         at: String? = nil
     ) async throws -> (stdout: String, stderr: String) {
-        let process = try Self.init(
+        let actualCwd = try at.map { try .init(validating: $0) } ?? TSCBasic.localFileSystem.currentWorkingDirectory ?? .root
+        let process = Self.init(
             arguments: [command] + arguments,
             environment: environment ?? ProcessEnv.vars,
-            workingDirectory: at.map { try .init(validating: $0) } ?? TSCBasic.localFileSystem.currentWorkingDirectory ?? .root,
+            workingDirectory: actualCwd,
             outputRedirection: .collect(redirectStderr: false),
             startNewProcessGroup: false,
-            loggingHandler: nil
+            loggingHandler: logger.map { logger in { logger.debug("\($0)", metadata: ["cwd": .string(actualCwd.pathString)]) } }
         )
 
         try process.launch()

Sources/QuotedString.swift

@@ -15,7 +15,7 @@ public extension ShellOutCommand {
 
     /// Create a file with a given name and contents (will overwrite any existing file with the same name)
     static func createFile(named name: String, contents: String) -> ShellOutCommand {
-        .bash(arguments: ["-c", #"echo \#(contents.quoted) > \#(name.quoted)"#.verbatim])
+        .bash(arguments: ["-c", "echo \(contents.quoted) > \(name.quoted)".verbatim])
     }
 
     /// Move a file from one path to another

Sources/ShellOut.swift

@@ -35,12 +35,6 @@ extension ShellOutError: LocalizedError {
 
 private extension Data {
     func shellOutput() -> String {
-        let output = String(decoding: self, as: UTF8.self)
-
-        guard !output.hasSuffix("\n") else {
-            return String(output.dropLast())
-        }
-
-        return output
+        .init(String(decoding: self, as: UTF8.self).trimmingSuffix(while: { $0.isNewline }))
     }
 }