Console Color Configuration

[fossbrandon]

I'm wondering if anyone knows a way to configure the console colors at the CliFx layer before running any commands?

I started thinking about this after running into an issue where my CLI app briefly changes the foreground color before changing them back but it crashed before the reset leaving follow up runs of my app still using the changed color.

It would be nice to have the colors be configurable at the CliFx framework level so that no matter what the console colors currently are, they are reset when running the command again.

Does anyone have a way I could do this currently? If not, what do people think about adding this sort of configuration?

[Tyrrrz]

You can use these extension methods to set and auto-reset colors:

CliFx/CliFx/Infrastructure/IConsole.cs

Lines 102 to 137 in 33f95d9

	/// <summary>
	/// Sets the specified foreground color and returns an <see cref="IDisposable"/>
	/// that will reset the color back to its previous value upon disposal.
	/// </summary>
	public static IDisposable WithForegroundColor(this IConsole console, ConsoleColor foregroundColor)
	{
	var lastColor = console.ForegroundColor;
	console.ForegroundColor = foregroundColor;
	return Disposable.Create(() => console.ForegroundColor = lastColor);
	}
	/// <summary>
	/// Sets the specified background color and returns an <see cref="IDisposable"/>
	/// that will reset the color back to its previous value upon disposal.
	/// </summary>
	public static IDisposable WithBackgroundColor(this IConsole console, ConsoleColor backgroundColor)
	{
	var lastColor = console.BackgroundColor;
	console.BackgroundColor = backgroundColor;
	return Disposable.Create(() => console.BackgroundColor = lastColor);
	}
	/// <summary>
	/// Sets the specified foreground and background colors and returns an <see cref="IDisposable"/>
	/// that will reset the colors back to their previous values upon disposal.
	/// </summary>
	public static IDisposable WithColors(
	this IConsole console,
	ConsoleColor foregroundColor,
	ConsoleColor backgroundColor) =>
	Disposable.Merge(
	console.WithForegroundColor(foregroundColor),
	console.WithBackgroundColor(backgroundColor)
	);

Otherwise, a simple try/finally with Console.ResetColors() in Program.cs will suffice. Note that if your application hard-crashes (for example by getting the process killed from outside), then the finally blocks will not trigger regardless.