Merge branch 'main' of https://github.com/swiftlang/swiftly into xcode_selector

Author: cmcgee1024

Documentation/SwiftlyDocs.docc/swiftly-cli-reference.md

@@ -23,7 +23,7 @@ swiftly [--version] [--help]
 Install a new toolchain.
 
 ```
-swiftly install [<version>] [--use] [--verify|no-verify] [--post-install-file=<post-install-file>] [--progress-file=<progress-file>] [--assume-yes] [--verbose] [--version] [--help]
+swiftly install [<version>] [--use] [--verify|no-verify] [--post-install-file=<post-install-file>] [--progress-file=<progress-file>] [--format=<format>] [--assume-yes] [--verbose] [--version] [--help]
 ```
 
 **version:**
@@ -89,6 +89,11 @@ Each progress entry contains timestamp, progress percentage, and a descriptive m
 The file must be writable, else an error will be thrown.
 
 
+**--format=\<format\>:**
+
+*Output format (text, json)*
+
+
 **--assume-yes:**
 
 *Disable confirmation prompts by assuming 'yes'*
@@ -492,7 +497,7 @@ swiftly init [--no-modify-profile] [--overwrite] [--platform=<platform>] [--skip
 Update the version of swiftly itself.
 
 ```
-swiftly self-update [--assume-yes] [--verbose] [--version] [--help]
+swiftly self-update [--assume-yes] [--verbose]  [--version] [--help]
 ```
 
 **--assume-yes:**

Sources/Swiftly/Install.swift

@@ -4,7 +4,6 @@ import Foundation
 import SwiftlyCore
 import SystemPackage
 @preconcurrency import TSCBasic
-import TSCUtility
 
 struct Install: SwiftlyCommand {
     public static let configuration = CommandConfiguration(
@@ -82,14 +81,17 @@ struct Install: SwiftlyCommand {
         ))
     var progressFile: FilePath?
 
+    @Option(name: .long, help: "Output format (text, json)")
+    var format: SwiftlyCore.OutputFormat = .text
+
     @OptionGroup var root: GlobalOptions
 
     private enum CodingKeys: String, CodingKey {
-        case version, use, verify, postInstallFile, root, progressFile
+        case version, use, verify, postInstallFile, root, progressFile, format
     }
 
     mutating func run() async throws {
-        try await self.run(Swiftly.createDefaultContext())
+        try await self.run(Swiftly.createDefaultContext(format: self.format))
     }
 
     private func swiftlyHomeDir(_ ctx: SwiftlyCoreContext) -> FilePath {
@@ -267,7 +269,10 @@ struct Install: SwiftlyCommand {
         progressFile: FilePath? = nil
     ) async throws -> (postInstall: String?, pathChanged: Bool) {
         guard !config.installedToolchains.contains(version) else {
-            await ctx.message("\(version) is already installed.")
+            let installInfo = InstallInfo(
+                version: version, alreadyInstalled: true
+            )
+            try await ctx.output(installInfo)
             return (nil, false)
         }
 
@@ -315,16 +320,18 @@ struct Install: SwiftlyCommand {
                 fatalError("unreachable: xcode toolchain cannot be installed with swiftly")
             }
 
-            let animation: ProgressAnimationProtocol =
+            let animation: ProgressReporterProtocol? =
                 if let progressFile
             {
                 try JsonFileProgressReporter(ctx, filePath: progressFile)
+            } else if ctx.format == .json {
+                ConsoleProgressReporter(stream: stderrStream, header: "Downloading \(version)")
             } else {
-                PercentProgressAnimation(stream: stdoutStream, header: "Downloading \(version)")
+                ConsoleProgressReporter(stream: stdoutStream, header: "Downloading \(version)")
             }
 
             defer {
-                try? (animation as? JsonFileProgressReporter)?.close()
+                try? animation?.close()
             }
 
             var lastUpdate = Date()
@@ -353,22 +360,28 @@ struct Install: SwiftlyCommand {
 
                         lastUpdate = Date()
 
-                        animation.update(
-                            step: progress.receivedBytes,
-                            total: progress.totalBytes!,
-                            text:
-                            "Downloaded \(String(format: "%.1f", downloadedMiB)) MiB of \(String(format: "%.1f", totalMiB)) MiB"
-                        )
+                        do {
+                            try await animation?.update(
+                                step: progress.receivedBytes,
+                                total: progress.totalBytes!,
+                                text:
+                                "Downloaded \(String(format: "%.1f", downloadedMiB)) MiB of \(String(format: "%.1f", totalMiB)) MiB"
+                            )
+                        } catch {
+                            await ctx.message(
+                                "Failed to update progress: \(error.localizedDescription)"
+                            )
+                        }
                     }
                 )
             } catch let notFound as DownloadNotFoundError {
                 throw SwiftlyError(
                     message: "\(version) does not exist at URL \(notFound.url), exiting")
             } catch {
-                animation.complete(success: false)
+                try? await animation?.complete(success: false)
                 throw error
             }
-            animation.complete(success: true)
+            try await animation?.complete(success: true)
 
             if verifySignature {
                 try await Swiftly.currentPlatform.verifyToolchainSignature(
@@ -424,7 +437,11 @@ struct Install: SwiftlyCommand {
                 return (pathChanged, config)
             }
             config = newConfig
-            await ctx.message("\(version) installed successfully!")
+            let installInfo = InstallInfo(
+                version: version,
+                alreadyInstalled: false
+            )
+            try await ctx.output(installInfo)
             return (postInstallScript, pathChanged)
         }
     }

Sources/Swiftly/JsonFileProgressReporter.swift

@@ -355,3 +355,28 @@ struct InstalledToolchainsListInfo: OutputData {
         return lines.joined(separator: "\n")
     }
 }
+
+struct InstallInfo: OutputData {
+    let version: ToolchainVersion
+    let alreadyInstalled: Bool
+
+    init(version: ToolchainVersion, alreadyInstalled: Bool) {
+        self.version = version
+        self.alreadyInstalled = alreadyInstalled
+    }
+
+    var description: String {
+        "\(self.version) is \(self.alreadyInstalled ? "already installed" : "installed successfully!")"
+    }
+
+    private enum CodingKeys: String, CodingKey {
+        case version
+        case alreadyInstalled
+    }
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encode(self.version.name, forKey: .version)
+        try container.encode(self.alreadyInstalled, forKey: .alreadyInstalled)
+    }
+}

Sources/Swiftly/OutputSchema.swift

@@ -0,0 +1,86 @@
+import Foundation
+import SwiftlyCore
+import SystemPackage
+import TSCBasic
+import TSCUtility
+
+public protocol ProgressReporterProtocol {
+    /// Updates the progress animation with the current step, total steps, and an optional text message.
+    func update(step: Int, total: Int, text: String) async throws
+
+    /// Completes the progress animation, indicating success or failure.
+    func complete(success: Bool) async throws
+
+    /// Closes any resources used by the reporter, if applicable.
+    func close() throws
+}
+
+/// Progress reporter that delegates to a `PercentProgressAnimation` for console output.
+struct ConsoleProgressReporter: ProgressReporterProtocol {
+    private let reporter: PercentProgressAnimation
+
+    init(stream: WritableByteStream, header: String) {
+        self.reporter = PercentProgressAnimation(stream: stream, header: header)
+    }
+
+    func update(step: Int, total: Int, text: String) async throws {
+        self.reporter.update(step: step, total: total, text: text)
+    }
+
+    func complete(success: Bool) async throws {
+        self.reporter.complete(success: success)
+    }
+
+    func close() throws {
+        // No resources to close for console reporter
+    }
+}
+
+enum ProgressInfo: Codable {
+    case step(timestamp: Date, percent: Int, text: String)
+    case complete(success: Bool)
+}
+
+struct JsonFileProgressReporter: ProgressReporterProtocol {
+    let filePath: FilePath
+    private let encoder: JSONEncoder
+    private let ctx: SwiftlyCoreContext
+    private let fileHandle: FileHandle
+
+    init(_ ctx: SwiftlyCoreContext, filePath: FilePath, encoder: JSONEncoder = JSONEncoder()) throws
+    {
+        self.ctx = ctx
+        self.filePath = filePath
+        self.encoder = encoder
+        self.fileHandle = try FileHandle(forWritingTo: URL(fileURLWithPath: filePath.string))
+    }
+
+    private func writeProgress(_ progress: ProgressInfo) async throws {
+        let jsonData = try self.encoder.encode(progress)
+
+        self.fileHandle.write(jsonData)
+        self.fileHandle.write("\n".data(using: .utf8) ?? Data())
+        try self.fileHandle.synchronize()
+    }
+
+    func update(step: Int, total: Int, text: String) async throws {
+        guard total > 0 && step <= total else {
+            return
+        }
+        try await self.writeProgress(
+            ProgressInfo.step(
+                timestamp: Date(),
+                percent: Int(Double(step) / Double(total) * 100),
+                text: text
+            )
+        )
+    }
+
+    func complete(success: Bool) async throws {
+        try await self.writeProgress(ProgressInfo.complete(success: success))
+    }
+
+    func close() throws {
+        try self.fileHandle.close()
+    }
+}