Removing almost unused ConsoleExtensions (#2103)

* merge two ConsoleExtensions types into one, remove unused IConsole argument

* simplify the logic

* remove almost unused public methods from ConsoleExtensions, rename it to ConsoleHelpers as there are no extensions anymore

* address code review feedback: use more reliable way of checking whether colors are supported: check OS first (in non-throwing way), then check IsOutputRedirected which won't throw at this point

Author: adamsitnik

src/System.CommandLine.ApiCompatibility.Tests/ApiCompatibilityApprovalTests.System_CommandLine_api_is_not_changed.approved.txt

@@ -102,9 +102,6 @@ System.CommandLine
   public static class CompletionSourceExtensions
     public static System.Void Add(this System.Collections.Generic.List<System.Func<System.CommandLine.Completions.CompletionContext,System.Collections.Generic.IEnumerable<System.CommandLine.Completions.CompletionItem>>> completionSources, System.Func<System.CommandLine.Completions.CompletionContext,System.Collections.Generic.IEnumerable<System.String>> completionsDelegate)
     public static System.Void Add(this System.Collections.Generic.List<System.Func<System.CommandLine.Completions.CompletionContext,System.Collections.Generic.IEnumerable<System.CommandLine.Completions.CompletionItem>>> completionSources, System.String[] completions)
-  public static class ConsoleExtensions
-    public static System.Void Write(this IConsole console, System.String value)
-    public static System.Void WriteLine(this IConsole console, System.String value)
   public class Directive : Symbol
     .ctor(System.String name)
     public CliAction Action { get; set; }

src/System.CommandLine.Tests/Invocation/CancelOnProcessTerminationTests.cs

@@ -69,7 +69,7 @@ private sealed class CustomCliAction : CliAction
 
             public async override Task<int> InvokeAsync(InvocationContext context, CancellationToken cancellationToken = default)
             {
-                context.Console.WriteLine(ChildProcessWaiting);
+                Console.WriteLine(ChildProcessWaiting);
 
                 bool infiniteDelay = context.GetValue(InfiniteDelayOption);
 

src/System.CommandLine.Tests/TestApps/NativeAOT/Program.cs

@@ -22,8 +22,8 @@ private static int Main(string[] args)
 
         void Run(InvocationContext context)
         {
-            context.Console.WriteLine($"Bool option: {context.ParseResult.GetValue(boolOption)}");
-            context.Console.WriteLine($"String option: {context.ParseResult.GetValue(stringOption)}");
+            Console.WriteLine($"Bool option: {context.ParseResult.GetValue(boolOption)}");
+            Console.WriteLine($"String option: {context.ParseResult.GetValue(stringOption)}");
         }
     }
 }

src/System.CommandLine.Tests/TestApps/Trimming/Program.cs

@@ -11,7 +11,7 @@
 
 command.SetAction(context =>
 {
-    context.Console.Write($"The file you chose was: {context.ParseResult.GetValue(fileArgument)}");
+    Console.Write($"The file you chose was: {context.ParseResult.GetValue(fileArgument)}");
 });
 
 command.Invoke(args);

src/System.CommandLine/Builder/CommandLineBuilderExtensions.cs

@@ -115,13 +115,13 @@ int Default(Exception exception, InvocationContext context)
             {
                 if (exception is not OperationCanceledException)
                 {
-                    context.Console.ResetTerminalForegroundColor();
-                    context.Console.SetTerminalForegroundRed();
+                    ConsoleHelpers.ResetTerminalForegroundColor();
+                    ConsoleHelpers.SetTerminalForegroundRed();
 
                     context.Console.Error.Write(LocalizationResources.ExceptionHandlerHeader());
                     context.Console.Error.WriteLine(exception.ToString());
 
-                    context.Console.ResetTerminalForegroundColor();
+                    ConsoleHelpers.ResetTerminalForegroundColor();
                 }
                 return errorExitCode;
             }

src/System.CommandLine/ConsoleExtensions.cs

@@ -0,0 +1,39 @@
+// Copyright (c) .NET Foundation and contributors. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using System.Runtime.InteropServices;
+
+namespace System.CommandLine
+{
+    internal static class ConsoleHelpers
+    {
+        private static readonly bool ColorsAreSupported = GetColorsAreSupported();
+
+        private static bool GetColorsAreSupported()
+#if NET7_0_OR_GREATER
+            => !(OperatingSystem.IsBrowser() || OperatingSystem.IsAndroid() || OperatingSystem.IsIOS() || OperatingSystem.IsTvOS())
+#else
+            => !(RuntimeInformation.IsOSPlatform(OSPlatform.Create("BROWSER"))
+                    || RuntimeInformation.IsOSPlatform(OSPlatform.Create("ANDROID"))
+                    || RuntimeInformation.IsOSPlatform(OSPlatform.Create("IOS"))
+                    || RuntimeInformation.IsOSPlatform(OSPlatform.Create("TVOS")))
+#endif
+            && !Console.IsOutputRedirected;
+
+        internal static void SetTerminalForegroundRed()
+        {
+            if (ColorsAreSupported)
+            {
+                Console.ForegroundColor = ConsoleColor.Red;
+            }
+        }
+
+        internal static void ResetTerminalForegroundColor()
+        {
+            if (ColorsAreSupported)
+            {
+                Console.ResetColor();
+            }
+        }
+    }
+}

src/System.CommandLine/ConsoleHelpers.cs

@@ -12,8 +12,8 @@ internal sealed class ParseErrorResultAction : CliAction
     {
         public override int Invoke(InvocationContext context)
         {
-            context.Console.ResetTerminalForegroundColor();
-            context.Console.SetTerminalForegroundRed();
+            ConsoleHelpers.ResetTerminalForegroundColor();
+            ConsoleHelpers.SetTerminalForegroundRed();
 
             foreach (var error in context.ParseResult.Errors)
             {
@@ -22,7 +22,7 @@ public override int Invoke(InvocationContext context)
 
             context.Console.Error.WriteLine();
 
-            context.Console.ResetTerminalForegroundColor();
+            ConsoleHelpers.ResetTerminalForegroundColor();
 
             new HelpOption().Action!.Invoke(context);