Refactored JSON Output for Install Command

Author: roulpriya

Sources/Swiftly/Install.swift

@@ -82,14 +82,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 +270,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)
         }
 
@@ -313,10 +319,12 @@ struct Install: SwiftlyCommand {
                 }
             }
 
-            let animation: ProgressAnimationProtocol =
+            let animation: ProgressAnimationProtocol? =
                 if let progressFile
             {
                 try JsonFileProgressReporter(ctx, filePath: progressFile)
+            } else if ctx.format == .json {
+                nil
             } else {
                 PercentProgressAnimation(stream: stdoutStream, header: "Downloading \(version)")
             }
@@ -351,7 +359,7 @@ struct Install: SwiftlyCommand {
 
                         lastUpdate = Date()
 
-                        animation.update(
+                        animation?.update(
                             step: progress.receivedBytes,
                             total: progress.totalBytes!,
                             text:
@@ -363,10 +371,10 @@ struct Install: SwiftlyCommand {
                 throw SwiftlyError(
                     message: "\(version) does not exist at URL \(notFound.url), exiting")
             } catch {
-                animation.complete(success: false)
+                animation?.complete(success: false)
                 throw error
             }
-            animation.complete(success: true)
+            animation?.complete(success: true)
 
             if verifySignature {
                 try await Swiftly.currentPlatform.verifyToolchainSignature(
@@ -422,7 +430,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/OutputSchema.swift

@@ -339,3 +339,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)
+    }
+}