refactor(progressconfig): convert bools to OutputMode enum

PhantomInTheWire · PhantomInTheWire · commit 3fc3c7317feb · 2025-12-12T15:22:31.000+05:30
Signed-off-by: Karan &lt;karanlokchandani@protonmail.com&gt;
diff --git a/Sources/ContainerBuild/BuildImageResolver.swift b/Sources/ContainerBuild/BuildImageResolver.swift
@@ -66,7 +66,7 @@ struct BuildImageResolver: BuildPipelineHandler {
                 showProgressBar: true,
                 showSize: true,
                 showSpeed: true,
-                disableProgressUpdates: self.quiet
+                outputMode: self.quiet ? .none : .ansi
             )
             let progress = ProgressBar(config: progressConfig)
             defer { progress.finish() }
diff --git a/Sources/ContainerCommands/Container/ContainerRun.swift b/Sources/ContainerCommands/Container/ContainerRun.swift
@@ -65,15 +65,14 @@ extension Application {
 
             var progressConfig: ProgressConfig
             switch self.progressFlags.progress {
-            case .none: progressConfig = try ProgressConfig(disableProgressUpdates: true)
+            case .none: progressConfig = try ProgressConfig(outputMode: .none)
             case .ansi, .plain, .color:
                 progressConfig = try ProgressConfig(
                     showTasks: true,
                     showItems: true,
                     ignoreSmallSize: true,
                     totalTasks: 6,
-                    color: self.progressFlags.progress == .color,
-                    plain: self.progressFlags.progress == .plain
+                    outputMode: self.progressFlags.progress.outputMode
                 )
             }
 
diff --git a/Sources/ContainerCommands/Image/ImagePull.swift b/Sources/ContainerCommands/Image/ImagePull.swift
@@ -82,15 +82,14 @@ extension Application {
 
             var progressConfig: ProgressConfig
             switch self.progressFlags.progress {
-            case .none: progressConfig = try ProgressConfig(disableProgressUpdates: true)
+            case .none: progressConfig = try ProgressConfig(outputMode: .none)
             case .ansi, .plain, .color:
                 progressConfig = try ProgressConfig(
                     showTasks: true,
                     showItems: true,
                     ignoreSmallSize: true,
                     totalTasks: 2,
-                    color: self.progressFlags.progress == .color,
-                    plain: self.progressFlags.progress == .plain
+                    outputMode: self.progressFlags.progress.outputMode
                 )
             }
 
diff --git a/Sources/ContainerCommands/Image/ImagePush.swift b/Sources/ContainerCommands/Image/ImagePush.swift
@@ -69,16 +69,15 @@ extension Application {
 
             var progressConfig: ProgressConfig
             switch self.progressFlags.progress {
-            case .none: progressConfig = try ProgressConfig(disableProgressUpdates: true)
+            case .none: progressConfig = try ProgressConfig(outputMode: .none)
             case .ansi, .color, .plain:
                 progressConfig = try ProgressConfig(
                     description: "Pushing image \(image.reference)",
                     itemsName: "blobs",
                     showItems: true,
                     showSpeed: false,
                     ignoreSmallSize: true,
-                    color: self.progressFlags.progress == .color,
-                    plain: self.progressFlags.progress == .plain
+                    outputMode: self.progressFlags.progress.outputMode
                 )
             }
 
diff --git a/Sources/ContainerCommands/ProgressTypeExtension.swift b/Sources/ContainerCommands/ProgressTypeExtension.swift
@@ -0,0 +1,30 @@
+//===----------------------------------------------------------------------===//
+// Copyright © 2025 Apple Inc. and the container project authors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//   https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//===----------------------------------------------------------------------===//
+
+import ContainerClient
+import TerminalProgress
+
+extension Flags.Progress.ProgressType {
+    /// Converts the progress type to a ProgressConfig output mode.
+    var outputMode: ProgressConfig.OutputMode {
+        switch self {
+        case .none: .none
+        case .ansi: .ansi
+        case .plain: .plain
+        case .color: .color
+        }
+    }
+}
diff --git a/Sources/TerminalProgress/ProgressBar+Terminal.swift b/Sources/TerminalProgress/ProgressBar+Terminal.swift
@@ -63,7 +63,7 @@ extension ProgressBar {
     }
 
     func displayText(_ text: String, terminating: String = "\r") {
-        if config.plain {
+        if config.outputMode == .plain {
             display(text + "\n")
             return
         }
diff --git a/Sources/TerminalProgress/ProgressBar.swift b/Sources/TerminalProgress/ProgressBar.swift
@@ -72,7 +72,7 @@ public final class ProgressBar: Sendable {
             $0.subDescription = ""
             $0.tasks += 1
         }
-        if config.plain {
+        if config.outputMode == .plain {
             render(force: true)
         }
     }
@@ -83,7 +83,7 @@ public final class ProgressBar: Sendable {
         resetCurrentTask()
 
         state.withLock { $0.subDescription = subDescription }
-        if config.plain {
+        if config.outputMode == .plain {
             render(force: true)
         }
     }
@@ -102,7 +102,7 @@ public final class ProgressBar: Sendable {
     /// Starts an animation of the progress bar.
     /// - Parameter intervalSeconds: The time interval between updates in seconds.
     public func start(intervalSeconds: TimeInterval = 0.04) {
-        if config.plain {
+        if config.outputMode == .plain {
             return
         }
         Task(priority: .utility) {
@@ -121,7 +121,7 @@ public final class ProgressBar: Sendable {
         // The last render.
         render(force: true)
 
-        if !config.disableProgressUpdates && !config.clearOnFinish {
+        if config.outputMode != .none && !config.clearOnFinish {
             displayText(state.withLock { $0.output }, terminating: "\n")
         }
 
@@ -143,7 +143,7 @@ extension ProgressBar {
     }
 
     func render(force: Bool = false) {
-        guard term != nil && !config.disableProgressUpdates && (force || !state.withLock { $0.finished }) else {
+        guard term != nil && config.outputMode != .none && (force || !state.withLock { $0.finished }) else {
             return
         }
         let output = draw()
@@ -298,7 +298,7 @@ extension ProgressBar {
     }
 
     private func colorize(_ text: String, _ color: String) -> String {
-        guard config.color else { return text }
+        guard config.outputMode == .color else { return text }
         return "\(color)\(text)\(Color.reset)"
     }
 
diff --git a/Sources/TerminalProgress/ProgressConfig.swift b/Sources/TerminalProgress/ProgressConfig.swift
@@ -18,6 +18,17 @@ import Foundation
 
 /// A configuration for displaying a progress bar.
 public struct ProgressConfig: Sendable {
+    /// The output mode for progress display.
+    public enum OutputMode: Sendable {
+        /// No progress output.
+        case none
+        /// ANSI control sequences without color (default).
+        case ansi
+        /// Plain text output, one line per update.
+        case plain
+        /// ANSI control sequences with color.
+        case color
+    }
     /// The file handle for progress updates.
     let terminal: FileHandle
     /// The initial description of the progress bar.
@@ -63,12 +74,8 @@ public struct ProgressConfig: Sendable {
     public let theme: ProgressTheme
     /// The flag indicating whether to clear the progress bar before resetting the cursor.
     public let clearOnFinish: Bool
-    /// The flag indicating whether to update the progress bar.
-    public let disableProgressUpdates: Bool
-    /// The flag indicating whether to use colors.
-    public let color: Bool
-    /// The flag indicating whether to use plain output (no ANSI codes, one line per update).
-    public let plain: Bool
+    /// The output mode for progress display.
+    public let outputMode: OutputMode
     /// Creates a new instance of `ProgressConfig`.
     /// - Parameters:
     ///   - terminal: The file handle for progress updates. The default value is `FileHandle.standardError`.
@@ -91,9 +98,7 @@ public struct ProgressConfig: Sendable {
     ///   - width: The width of the progress bar in characters. The default value is `120`.
     ///   - theme: The theme of the progress bar. The default value is `nil`.
     ///   - clearOnFinish: The flag indicating whether to clear the progress bar before resetting the cursor. The default is `true`.
-    ///   - disableProgressUpdates: The flag indicating whether to update the progress bar. The default is `false`.
-    ///   - color: A flag indicating whether to enable ANSI color output. The default value is `false`.
-    ///   - plain: A flag indicating whether to force plain output with no control sequences. The default value is `false`.
+    ///   - outputMode: The output mode for progress display. The default value is `.ansi`.
     public init(
         terminal: FileHandle = .standardError,
         description: String = "",
@@ -115,9 +120,7 @@ public struct ProgressConfig: Sendable {
         width: Int = 120,
         theme: ProgressTheme? = nil,
         clearOnFinish: Bool = true,
-        disableProgressUpdates: Bool = false,
-        color: Bool = false,
-        plain: Bool = false
+        outputMode: OutputMode = .ansi
     ) throws {
         if let totalTasks {
             guard totalTasks > 0 else {
@@ -140,11 +143,11 @@ public struct ProgressConfig: Sendable {
         self.initialSubDescription = subDescription
         self.initialItemsName = itemsName
 
-        self.showSpinner = plain ? false : showSpinner
+        self.showSpinner = (outputMode == .plain || outputMode == .none) ? false : showSpinner
         self.showTasks = showTasks
         self.showDescription = showDescription
         self.showPercent = showPercent
-        self.showProgressBar = plain ? false : showProgressBar
+        self.showProgressBar = (outputMode == .plain || outputMode == .none) ? false : showProgressBar
         self.showItems = showItems
         self.showSize = showSize
         self.showSpeed = showSpeed
@@ -158,9 +161,7 @@ public struct ProgressConfig: Sendable {
         self.width = width
         self.theme = theme ?? DefaultProgressTheme()
         self.clearOnFinish = clearOnFinish
-        self.disableProgressUpdates = disableProgressUpdates
-        self.color = plain ? false : color
-        self.plain = plain
+        self.outputMode = outputMode
     }
 }
 

Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ struct BuildImageResolver: BuildPipelineHandler {`
`66`	`66`	`showProgressBar: true,`
`67`	`67`	`showSize: true,`
`68`	`68`	`showSpeed: true,`
`69`		`- disableProgressUpdates: self.quiet`
	`69`	`+ outputMode: self.quiet ? .none : .ansi`
`70`	`70`	`)`
`71`	`71`	`let progress = ProgressBar(config: progressConfig)`
`72`	`72`	`defer { progress.finish() }`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ extension ProgressBar {`
`63`	`63`	`}`
`64`	`64`
`65`	`65`	`func displayText(_ text: String, terminating: String = "\r") {`
`66`		`- if config.plain {`
	`66`	`+ if config.outputMode == .plain {`
`67`	`67`	`display(text + "\n")`
`68`	`68`	`return`
`69`	`69`	`}`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ public final class ProgressBar: Sendable {`
`72`	`72`	`$0.subDescription = ""`
`73`	`73`	`$0.tasks += 1`
`74`	`74`	`}`
`75`		`- if config.plain {`
	`75`	`+ if config.outputMode == .plain {`
`76`	`76`	`render(force: true)`
`77`	`77`	`}`
`78`	`78`	`}`
`@@ -83,7 +83,7 @@ public final class ProgressBar: Sendable {`
`83`	`83`	`resetCurrentTask()`
`84`	`84`
`85`	`85`	`state.withLock { $0.subDescription = subDescription }`
`86`		`- if config.plain {`
	`86`	`+ if config.outputMode == .plain {`
`87`	`87`	`render(force: true)`
`88`	`88`	`}`
`89`	`89`	`}`
`@@ -102,7 +102,7 @@ public final class ProgressBar: Sendable {`
`102`	`102`	`/// Starts an animation of the progress bar.`
`103`	`103`	`/// - Parameter intervalSeconds: The time interval between updates in seconds.`
`104`	`104`	`public func start(intervalSeconds: TimeInterval = 0.04) {`
`105`		`- if config.plain {`
	`105`	`+ if config.outputMode == .plain {`
`106`	`106`	`return`
`107`	`107`	`}`
`108`	`108`	`Task(priority: .utility) {`
`@@ -121,7 +121,7 @@ public final class ProgressBar: Sendable {`
`121`	`121`	`// The last render.`
`122`	`122`	`render(force: true)`
`123`	`123`
`124`		`- if !config.disableProgressUpdates && !config.clearOnFinish {`
	`124`	`+ if config.outputMode != .none && !config.clearOnFinish {`
`125`	`125`	`displayText(state.withLock { $0.output }, terminating: "\n")`
`126`	`126`	`}`
`127`	`127`
`@@ -143,7 +143,7 @@ extension ProgressBar {`
`143`	`143`	`}`
`144`	`144`
`145`	`145`	`func render(force: Bool = false) {`
`146`		`- guard term != nil && !config.disableProgressUpdates && (force \|\| !state.withLock { $0.finished }) else {`
	`146`	`+ guard term != nil && config.outputMode != .none && (force \|\| !state.withLock { $0.finished }) else {`
`147`	`147`	`return`
`148`	`148`	`}`
`149`	`149`	`let output = draw()`
`@@ -298,7 +298,7 @@ extension ProgressBar {`
`298`	`298`	`}`
`299`	`299`
`300`	`300`	`private func colorize(_ text: String, _ color: String) -> String {`
`301`		`- guard config.color else { return text }`
	`301`	`+ guard config.outputMode == .color else { return text }`
`302`	`302`	`return "\(color)\(text)\(Color.reset)"`
`303`	`303`	`}`
`304`	`304`