Merge pull request #7 from xt0rted/console-logging

xt0rted · web-flow · commit 4c3245c1ad7f · 2022-03-26T02:18:08.000-04:00
Use console colors only if supported
diff --git a/src/ConsoleWriter.cs b/src/ConsoleWriter.cs
@@ -5,14 +5,17 @@ namespace RunScript;
 using System.CommandLine.Rendering;
 using System.Globalization;
 
-internal class ConsoleWriter
+internal class ConsoleWriter : IConsoleWriter
 {
     private readonly IConsole _console;
+    private readonly IFormatProvider? _consoleFormatProvider;
+
     private readonly bool _verbose;
 
-    public ConsoleWriter(IConsole console, bool verbose)
+    public ConsoleWriter(IConsole console, IFormatProvider consoleFormatProvider, bool verbose)
     {
         _console = console ?? throw new ArgumentNullException(nameof(console));
+        _consoleFormatProvider = consoleFormatProvider ?? throw new ArgumentNullException(nameof(consoleFormatProvider));
         _verbose = verbose;
     }
 
@@ -25,7 +28,7 @@ private void WriteLine(AnsiControlCode textColor, bool verbose, string? message
 
         if (message is not null)
         {
-            _console.Out.Write(textColor.EscapeSequence);
+            _console.Out.Write(textColor.ToString(null, _consoleFormatProvider));
 
             if (args?.Length > 0)
             {
@@ -36,33 +39,29 @@ private void WriteLine(AnsiControlCode textColor, bool verbose, string? message
                 _console.Out.Write(message);
             }
 
-            _console.Out.Write(Ansi.Color.Foreground.Default.EscapeSequence);
+            _console.Out.Write(Ansi.Color.Foreground.Default.ToString(null, _consoleFormatProvider));
         }
 
         _console.Out.Write(Environment.NewLine);
     }
-    public void AlertAboutVerbose()
-        => VerboseLine("Verbose mode is on. This will print more information.");
+
+    public void VerboseBanner()
+        => LineVerbose("Verbose mode is on. This will print more information.");
 
     public void BlankLine()
         => WriteLine(Ansi.Color.Foreground.LightGray, verbose: false, null);
-    public void BlankVerboseLine()
+
+    public void BlankLineVerbose()
         => WriteLine(Ansi.Color.Foreground.LightGray, verbose: true, null);
 
     public void Line(string? message, params object?[] args)
         => WriteLine(Ansi.Color.Foreground.LightGray, verbose: false, message, args);
-    public void VerboseLine(string? message = null, params object?[] args)
-        => WriteLine(Ansi.Color.Foreground.LightGray, verbose: true, "> " + message, args);
 
-    //public void SecondaryLine(string? message, params object?[] args) =>
-    //    WriteLine(Ansi.Color.Foreground.DarkGray, verbose: false, message, args);
-    //public void VerboseSecondaryLine(string? message, params object?[] args) =>
-    //    WriteLine(Ansi.Color.Foreground.DarkGray, verbose: true, "> " + message, args);
+    public void LineVerbose(string? message = null, params object?[] args)
+        => WriteLine(Ansi.Color.Foreground.LightGray, verbose: true, "> " + message, args);
 
     internal void Information(string? message, params object?[] args)
         => WriteLine(Ansi.Color.Foreground.Cyan, verbose: false, message, args);
-    //public void VerboseInformation(string? message, params object?[] args) =>
-    //    WriteLine(Ansi.Color.Foreground.Cyan, verbose: true, "> " + message, args);
 
     public void Banner(params string?[] messages)
     {
@@ -78,6 +77,6 @@ public void Banner(params string?[] messages)
         BlankLine();
     }
 
-    //public void Error(string? message, params object?[] args) =>
-    //    WriteLine(Ansi.Color.Foreground.Red, verbose: false, message, args);
+    public void Error(string? message, params object?[] args)
+        => WriteLine(Ansi.Color.Foreground.Red, verbose: false, message, args);
 }
diff --git a/src/EnvironmentCommand.cs b/src/EnvironmentCommand.cs
@@ -6,22 +6,28 @@ namespace RunScript;
 
 public class EnvironmentCommand : Command, ICommandHandler
 {
-    public EnvironmentCommand()
+    private readonly IFormatProvider _consoleFormatProvider;
+
+    public EnvironmentCommand(IFormatProvider consoleFormatProvider)
         : base("env", "List available environment variables")
-        => Handler = this;
+    {
+        _consoleFormatProvider = consoleFormatProvider ?? throw new ArgumentNullException(nameof(consoleFormatProvider));
+
+        Handler = this;
+    }
 
     public Task<int> InvokeAsync(InvocationContext context)
     {
         if (context is null) throw new ArgumentNullException(nameof(context));
 
-        var console = new ConsoleWriter(context.Console, context.ParseResult.GetValueForOption(GlobalOptions.Verbose));
-        console.AlertAboutVerbose();
+        var writer = new ConsoleWriter(context.Console, _consoleFormatProvider, context.ParseResult.GetValueForOption(GlobalOptions.Verbose));
 
-        console.Banner(Name);
+        writer.VerboseBanner();
+        writer.Banner(Name);
 
         foreach (var (key, value) in environmentVariables().OrderBy(v => v.Key, StringComparer.InvariantCulture))
         {
-            console.Line("{0}={1}", key, value);
+            writer.Line("{0}={1}", key, value);
         }
 
         return Task.FromResult(0);
diff --git a/src/IConsoleWriter.cs b/src/IConsoleWriter.cs
@@ -0,0 +1,18 @@
+namespace RunScript;
+
+internal interface IConsoleWriter
+{
+    void VerboseBanner();
+
+    void BlankLine();
+
+    void BlankLineVerbose();
+
+    void Line(string? message, params object?[] args);
+
+    void LineVerbose(string? message = null, params object?[] args);
+
+    void Banner(params string?[] messages);
+
+    void Error(string? message, params object?[] args);
+}
diff --git a/src/Program.cs b/src/Program.cs
@@ -3,6 +3,7 @@
 using System.CommandLine;
 using System.CommandLine.Builder;
 using System.CommandLine.Parsing;
+using System.CommandLine.Rendering;
 
 using RunScript;
 
@@ -17,13 +18,18 @@
 }
 catch (Exception ex)
 {
-    logError(ex.Message);
+    Console.ForegroundColor = ConsoleColor.Red;
+    Console.WriteLine(ex.Message);
+    Console.ResetColor();
 
     return 1;
 }
 
+var consoleFormatProvider = new ConsoleFormatInfo();
 var rootCommand = new RootCommand();
+
 rootCommand.TreatUnmatchedTokensAsErrors = false;
+
 rootCommand.AddGlobalOption(GlobalOptions.IfPresent);
 rootCommand.AddGlobalOption(GlobalOptions.ScriptShell);
 rootCommand.AddGlobalOption(GlobalOptions.Verbose);
@@ -34,14 +40,15 @@
         name,
         script,
         project,
-        workingDirectory);
+        workingDirectory,
+        consoleFormatProvider);
 
     rootCommand.AddCommand(runScript);
 }
 
 if (!project.Scripts!.ContainsKey("env"))
 {
-    rootCommand.AddCommand(new EnvironmentCommand());
+    rootCommand.AddCommand(new EnvironmentCommand(consoleFormatProvider));
 }
 
 var parser = new CommandLineBuilder(rootCommand)
@@ -55,13 +62,16 @@
     .UseParseErrorReporting()
     .UseExceptionHandler((ex, ctx) =>
     {
-        if (ctx.ParseResult.HasOption(GlobalOptions.Verbose))
+        var verbose = ctx.ParseResult.HasOption(GlobalOptions.Verbose);
+        var writer = new ConsoleWriter(ctx.Console, consoleFormatProvider, verbose);
+
+        if (verbose)
         {
-            logError(ex.ToString());
+            writer.Error(ex.ToString());
         }
         else
         {
-            logError(ex.Message);
+            writer.Error(ex.Message);
         }
     })
     .CancelOnProcessTermination()
@@ -71,10 +81,3 @@
 var parseResult = parser.Parse(args);
 
 return await parseResult.InvokeAsync();
-
-static void logError(string message)
-{
-    Console.ForegroundColor = ConsoleColor.Red;
-    Console.WriteLine(message);
-    Console.ResetColor();
-}
diff --git a/src/RunScriptCommand.cs b/src/RunScriptCommand.cs
@@ -16,20 +16,23 @@ public class RunScriptCommand : Command, ICommandHandler
 
     private readonly Project _project;
     private readonly string _workingDirectory;
+    private readonly IFormatProvider _consoleFormatProvider;
 
     private readonly ImmutableArray<string> _scriptNames;
 
     public RunScriptCommand(
         string name,
         string? description,
         Project project,
-        string workingDirectory)
+        string workingDirectory,
+        IFormatProvider consoleFormatProvider)
         : base(name, description)
     {
         if (string.IsNullOrEmpty(workingDirectory)) throw new ArgumentException($"'{nameof(workingDirectory)}' cannot be null or empty.", nameof(workingDirectory));
 
         _project = project ?? throw new ArgumentNullException(nameof(project));
         _workingDirectory = workingDirectory;
+        _consoleFormatProvider = consoleFormatProvider ?? throw new ArgumentNullException(nameof(consoleFormatProvider));
 
         _scriptNames = ImmutableArray.Create(new[] { "pre" + Name, Name, "post" + Name });
 
@@ -40,8 +43,9 @@ public async Task<int> InvokeAsync(InvocationContext context)
     {
         if (context is null) throw new ArgumentNullException(nameof(context));
 
-        var console = new ConsoleWriter(context.Console, context.ParseResult.GetValueForOption(GlobalOptions.Verbose));
-        console.AlertAboutVerbose();
+        var writer = new ConsoleWriter(context.Console, _consoleFormatProvider, context.ParseResult.GetValueForOption(GlobalOptions.Verbose));
+
+        writer.VerboseBanner();
 
         var scriptShell = context.ParseResult.GetValueForOption(GlobalOptions.ScriptShell);
         var (shell, isCmd) = GetScriptShell(scriptShell ?? _project.ScriptShell);
@@ -55,7 +59,7 @@ public async Task<int> InvokeAsync(InvocationContext context)
                 : null;
 
             var result = await RunScriptAsync(
-                console,
+                writer,
                 script,
                 _project.Scripts![script],
                 shell,
@@ -84,7 +88,7 @@ public async Task<int> InvokeAsync(InvocationContext context)
     }
 
     private async Task<int> RunScriptAsync(
-        ConsoleWriter console,
+        IConsoleWriter writer,
         string name,
         string? cmd,
         string shell,
@@ -101,9 +105,9 @@ private async Task<int> RunScriptAsync(
             toExecute += string.Join(" ", args);
         }
 
-        console.Banner(name, toExecute);
-        console.VerboseLine("Using shell: {0}", shell);
-        console.BlankVerboseLine();
+        writer.Banner(name, toExecute);
+        writer.LineVerbose("Using shell: {0}", shell);
+        writer.BlankLineVerbose();
 
         using (var process = new Process())
         {
