colored output

Author: dawedawe

src/FSharp.Analyzers.Cli/Logging.fs

@@ -1,4 +1,4 @@
-namespace Console.ExampleFormatters.Custom
+module FSharp.Analyzers.Cli.CustomLogging
 
 open System
 open System.IO
@@ -11,13 +11,16 @@ open Microsoft.Extensions.Options
 type CustomOptions() =
     inherit ConsoleFormatterOptions()
 
-    member val CustomPrefix = "" with get, set
+    /// if true: no LogLevel as prefix, colored output according to LogLevel
+    /// if false: LogLevel as prefix, no colored output
+    member val UseAnalyzersMsgStyle = false with get, set
 
 type CustomFormatter(options: IOptionsMonitor<CustomOptions>) as this =
     inherit ConsoleFormatter("customName")
 
     let mutable optionsReloadToken: IDisposable = null
     let mutable formatterOptions = options.CurrentValue
+    let origColor = Console.ForegroundColor
 
     do optionsReloadToken <- options.OnChange(fun x -> this.ReloadLoggerOptions(x))
 
@@ -31,11 +34,37 @@ type CustomFormatter(options: IOptionsMonitor<CustomOptions>) as this =
         )
         =
         let message = logEntry.Formatter.Invoke(logEntry.State, logEntry.Exception)
-        this.CustomLogic(textWriter)
-        textWriter.WriteLine(message)
 
-    member private _.CustomLogic(textWriter: TextWriter) =
-        textWriter.Write(formatterOptions.CustomPrefix)
+        if formatterOptions.UseAnalyzersMsgStyle then
+            this.SetColor(textWriter, logEntry.LogLevel)
+            textWriter.WriteLine(message)
+            this.ResetColor()
+        else
+            this.WritePrefix(textWriter, logEntry.LogLevel)
+            textWriter.WriteLine(message)
+
+    member private _.WritePrefix(textWriter: TextWriter, logLevel: LogLevel) =
+        match logLevel with
+        | LogLevel.Trace -> textWriter.Write("trace: ")
+        | LogLevel.Debug -> textWriter.Write("debug: ")
+        | LogLevel.Information -> textWriter.Write("info: ")
+        | LogLevel.Warning -> textWriter.Write("warn: ")
+        | LogLevel.Error -> textWriter.Write("error: ")
+        | LogLevel.Critical -> textWriter.Write("critical: ")
+        | _ -> ()
+
+    member private _.SetColor(textWriter: TextWriter, logLevel: LogLevel) =
+        let color =
+            match logLevel with
+            | LogLevel.Error -> "\x1B[1m\x1B[31m" // ConsoleColor.Red
+            | LogLevel.Warning -> "\x1B[33m" // ConsoleColor.DarkYellow
+            | LogLevel.Information -> "\x1B[1m\x1B[34m" // ConsoleColor.Blue
+            | LogLevel.Trace -> "\x1B[1m\x1B[36m" // ConsoleColor.Cyan
+            | _ -> "\x1B[37m" // ConsoleColor.Gray
+
+        textWriter.Write(color)
+
+    member private _.ResetColor() = Console.ForegroundColor <- origColor
 
     interface IDisposable with
         member _.Dispose() = optionsReloadToken.Dispose()

src/FSharp.Analyzers.Cli/Program.fs

@@ -12,7 +12,7 @@ open Microsoft.CodeAnalysis.Sarif
 open Microsoft.CodeAnalysis.Sarif.Writers
 open Microsoft.Extensions.Logging
 open Ionide.ProjInfo
-open Console.ExampleFormatters.Custom
+open FSharp.Analyzers.Cli.CustomLogging
 
 type Arguments =
     | Project of string list
@@ -182,7 +182,7 @@ let runProject
 let fsharpFiles = set [| ".fs"; ".fsi"; ".fsx" |]
 
 let isFSharpFile (file: string) =
-    Seq.exists (fun (ext: string) -> file.EndsWith ext) fsharpFiles
+    Set.exists (fun (ext: string) -> file.EndsWith(ext, StringComparison.Ordinal)) fsharpFiles
 
 let runFscArgs
     (client: Client<CliAnalyzerAttribute, CliContext>)
@@ -229,22 +229,35 @@ let runFscArgs
     runProjectAux client projectOptions globs mappings
 
 let printMessages (msgs: AnalyzerMessage list) =
+
+    let severityToLogLevel =
+        Map.ofArray
+            [|
+                Error, LogLevel.Error
+                Warning, LogLevel.Warning
+                Info, LogLevel.Information
+                Hint, LogLevel.Trace
+            |]
+
     if List.isEmpty msgs then
         logger.LogInformation("No messages found from the analyzer(s)")
 
+    use factory =
+        LoggerFactory.Create(fun builder ->
+            builder
+                .AddCustomFormatter(fun options -> options.UseAnalyzersMsgStyle <- true)
+                .SetMinimumLevel(LogLevel.Trace)
+            |> ignore
+        )
+
+    let msgLogger = factory.CreateLogger("")
+
     msgs
     |> Seq.iter (fun analyzerMessage ->
         let m = analyzerMessage.Message
 
-        let msgLogLevel =
-            match m.Severity with
-            | Error -> LogLevel.Error
-            | Warning -> LogLevel.Warning
-            | Info -> LogLevel.Information
-            | Hint -> LogLevel.Trace
-
-        logger.Log(
-            msgLogLevel,
+        msgLogger.Log(
+            severityToLogLevel[m.Severity],
             "{0}({1},{2}): {3} {4} - {5}",
             m.Range.FileName,
             m.Range.StartLine,
@@ -273,7 +286,7 @@ let writeReport (results: AnalyzerMessage list option) (codeRoot: string option)
         let driver = ToolComponent()
         driver.Name <- "Ionide.Analyzers.Cli"
         driver.InformationUri <- Uri("https://ionide.io/FSharp.Analyzers.SDK/")
-        driver.Version <- string (System.Reflection.Assembly.GetExecutingAssembly().GetName().Version)
+        driver.Version <- string<Version> (System.Reflection.Assembly.GetExecutingAssembly().GetName().Version)
         let tool = Tool()
         tool.Driver <- driver
         let run = Run()
@@ -460,7 +473,7 @@ let main argv =
     use factory =
         LoggerFactory.Create(fun builder ->
             builder
-                .AddCustomFormatter(fun options -> options.CustomPrefix <- "")
+                .AddCustomFormatter(fun options -> options.UseAnalyzersMsgStyle <- false)
                 .SetMinimumLevel(logLevel)
             |> ignore
         )

src/FSharp.Analyzers.SDK.Testing/FSharp.Analyzers.SDK.Testing.fs

@@ -44,7 +44,7 @@ exception CompilerDiagnosticErrors of FSharpDiagnostic array
 let fsharpFiles = set [| ".fs"; ".fsi"; ".fsx" |]
 
 let isFSharpFile (file: string) =
-    Seq.exists (fun (ext: string) -> file.EndsWith ext) fsharpFiles
+    Set.exists (fun (ext: string) -> file.EndsWith(ext, StringComparison.Ordinal)) fsharpFiles
 
 let readCompilerArgsFromBinLog (build: Build) =
     if not build.Succeeded then
@@ -82,7 +82,7 @@ let readCompilerArgsFromBinLog (build: Build) =
     match args with
     | None -> failwith $"Could not parse binlog at {build.LogFilePath}, does it contain CoreCompile?"
     | Some args ->
-        let idx = args.IndexOf "-o:"
+        let idx = args.IndexOf("-o:", StringComparison.Ordinal)
         args.Substring(idx).Split [| '\n' |]
 
 let mkOptions (compilerArgs: string array) =

src/FSharp.Analyzers.SDK/FSharp.Analyzers.SDK.Client.fs

@@ -28,7 +28,7 @@ module Client =
 
     let isAnalyzer<'TAttribute when 'TAttribute :> AnalyzerAttribute> (mi: MemberInfo) =
         mi.GetCustomAttributes true
-        |> Seq.tryFind (fun n -> n.GetType().Name = typeof<'TAttribute>.Name)
+        |> Array.tryFind (fun n -> n.GetType().Name = typeof<'TAttribute>.Name)
         |> Option.map unbox<'TAttribute>
 
     let analyzerFromMember<'TAnalyzerAttribute, 'TContext
@@ -217,7 +217,7 @@ type Client<'TAttribute, 'TContext when 'TAttribute :> AnalyzerAttribute and 'TC
                 registeredAnalyzers.AddOrUpdate(path, analyzers, (fun _ _ -> analyzers))
                 |> ignore
 
-            Seq.length analyzers, analyzers |> Seq.collect snd |> Seq.length
+            Array.length analyzers, analyzers |> Seq.collect snd |> Seq.length
         else
             0, 0