Adds option to configure the Foreground Done Color (#97)

Co-authored-by: Martijn Laarman <[email protected]>

src/ShellProgressBar.Example/Examples/AlternateFinishedColorExample.cs

@@ -0,0 +1,41 @@
+using System;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace ShellProgressBar.Example.Examples
+{
+	public class AlternateFinishedColorExample : ExampleBase
+	{
+		protected override void Start()
+		{
+			var options = new ProgressBarOptions
+			{
+				ForegroundColor = ConsoleColor.Yellow,
+				ForegroundColorDone = ConsoleColor.DarkGreen,
+				ForegroundColorError = ConsoleColor.Red,
+				BackgroundColor = ConsoleColor.DarkGray,
+				BackgroundCharacter = '\u2593'
+			};
+
+			using (var pbar = new ProgressBar(100, "100 ticks", options))
+			{
+				Task.Run(
+					() =>
+					{
+						for (var i = 0; i < 10; i++)
+						{
+							Task.Delay(10).Wait();
+							pbar.Tick($"Step {i}");
+						}
+						pbar.WriteErrorLine("The task ran into an issue!");
+						// OR pbar.ObservedError = true;
+					}).Wait();
+				pbar.Message= "Indicate the task is done, but the status is not Green.";
+			}
+
+			Task.Delay(5000).Wait();
+		}
+
+
+	}
+}

src/ShellProgressBar.Example/Program.cs

@@ -12,6 +12,7 @@ class Program
 	{
 		private static readonly IList<IProgressBarExample> TestCases = new List<IProgressBarExample>
 		{
+			/*
 			new PersistMessageExample(),
 			new FixedDurationExample(),
 			new DeeplyNestedProgressBarTreeExample(),
@@ -28,6 +29,8 @@ class Program
 			new EstimatedDurationExample(),
 			new IndeterminateProgressExample(),
 			new IndeterminateChildrenNoCollapseExample(),
+			*/
+			new AlternateFinishedColorExample()
 		};
 
 		private static readonly IList<IProgressBarExample> Examples = new List<IProgressBarExample>
@@ -42,7 +45,8 @@ class Program
 			new MessageBeforeAndAfterExample(),
 			new DeeplyNestedProgressBarTreeExample(),
 			new EstimatedDurationExample(),
-			new DownloadProgressExample()
+			new DownloadProgressExample(),
+			new AlternateFinishedColorExample()
 		};
 
 		static void Main(string[] args)

src/ShellProgressBar/ProgressBar.cs

@@ -277,6 +277,7 @@ public override void WriteLine(string message)
 		}
 		public override void WriteErrorLine(string message)
 		{
+			this.ObservedError = true;
 			_stickyMessages.Enqueue(new ConsoleOutLine(message, error: true));
 			DisplayProgress();
 		}

src/ShellProgressBar/ProgressBarBase.cs

@@ -36,12 +36,17 @@ protected virtual void OnDone() { }
 
 		public DateTime? EndTime { get; protected set; }
 
+		public bool ObservedError { get; set; }
+
 		private ConsoleColor? _dynamicForegroundColor = null;
 		public ConsoleColor ForegroundColor
 		{
 			get
 			{
 				var realColor = _dynamicForegroundColor ?? this.Options.ForegroundColor;
+				if (this.ObservedError && this.Options.ForegroundColorError.HasValue)
+					return this.Options.ForegroundColorError.Value;
+
 				return EndTime.HasValue
 					? this.Options.ForegroundColorDone ?? realColor
 					: realColor;

src/ShellProgressBar/ProgressBarOptions.cs

@@ -31,6 +31,14 @@ public string MessageEncodingName
 		/// <summary> The foreground color the progressbar has reached a 100 percent</summary>
 		public ConsoleColor? ForegroundColorDone { get; set; }
 
+		/// <summary>
+		/// The foreground color the progressbar when it has observed an error
+		/// <para>If set this takes priority over any other color as soon as an error is observed</para>
+		/// Use either <see cref="ProgressBarBase.ObservedError"/> or <see cref="ProgressBarBase.WriteErrorLine"/> to
+		/// put the progressbar in errored state
+		/// </summary>
+		public ConsoleColor? ForegroundColorError { get; set; }
+
 		/// <summary> The background color of the remainder of the progressbar</summary>
 		public ConsoleColor? BackgroundColor { get; set; }
 

src/ShellProgressBar/ShellProgressBar.csproj

@@ -16,7 +16,7 @@
     <PackageTags>console;shell;terminal;progress;progressbar</PackageTags>
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies.net461" Version="1.0.0">
+    <PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies.net461" Version="1.0.2">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>