Add ANSI color code support to trace, use for AppVeyor

Author: csmager

src/app/FakeLib/TraceHelper.fs

@@ -167,7 +167,7 @@ let traceStartTaskUsing task description =
     traceStartTask task description
     { new IDisposable with member x.Dispose() = traceEndTask task description }
 
-let console = new ConsoleTraceListener(false, colorMap) :> ITraceListener
+let console = new ConsoleTraceListener(false, colorMap, false) :> ITraceListener
 
 open System.Diagnostics
 

src/app/FakeLib/TraceListener.fs

@@ -5,7 +5,7 @@ module Fake.TraceListener
 open System
 
 /// Defines Tracing information for TraceListeners
-type TraceData = 
+type TraceData =
     | StartMessage
     | ImportantMessage of string
     | ErrorMessage of string
@@ -36,11 +36,11 @@ type TraceData =
         | CloseTag _ -> None
 
 /// Defines a TraceListener interface
-type ITraceListener = 
+type ITraceListener =
     abstract Write : TraceData -> unit
 
 /// A default color map which maps TracePriorities to ConsoleColors
-let colorMap traceData = 
+let colorMap traceData =
     match traceData with
     | ImportantMessage _ -> ConsoleColor.Yellow
     | ErrorMessage _ -> ConsoleColor.Red
@@ -53,86 +53,120 @@ let colorMap traceData =
 /// ## Parameters
 ///  - `importantMessagesToStdErr` - Defines whether to trace important messages to StdErr.
 ///  - `colorMap` - A function which maps TracePriorities to ConsoleColors.
-type ConsoleTraceListener(importantMessagesToStdErr, colorMap) = 
-    
-    let writeText toStdErr color newLine text = 
+type ConsoleTraceListener(importantMessagesToStdErr, colorMap, useAnsiColorCodes) =
+    let writeTextConsoleColor print color text =
         let curColor = Console.ForegroundColor
         try
           try
             if curColor <> color then Console.ForegroundColor <- color
-            let printer =
-              match toStdErr, newLine with
-              | true, true -> eprintfn
-              | true, false -> eprintf
-              | false, true -> printfn
-              | false, false -> printf
-            printer "%s" text
+            print text
           with
-            | :? ArgumentException when EnvironmentHelper.isMono -> 
+            | :? ArgumentException when EnvironmentHelper.isMono ->
               printfn "* Color output has been disabled because of a bug in GNOME Terminal."
               printfn "* Hint: To workaround this bug, please set environment property TERM=xterm-256color"
               reraise()
         finally
           if curColor <> color then Console.ForegroundColor <- curColor
-    
+
+    let writeTextAnsiColor print color text =
+        let colorCode = function
+            | ConsoleColor.Black -> [30]
+            | ConsoleColor.Blue -> [34]
+            | ConsoleColor.Cyan -> [36]
+            | ConsoleColor.Gray -> [37;2]
+            | ConsoleColor.Green -> [32]
+            | ConsoleColor.Magenta -> [35]
+            | ConsoleColor.Red -> [31]
+            | ConsoleColor.White -> [37]
+            | ConsoleColor.Yellow -> [33]
+            | ConsoleColor.DarkBlue -> [34;2]
+            | ConsoleColor.DarkCyan -> [36;2]
+            | ConsoleColor.DarkGray -> [37;2]
+            | ConsoleColor.DarkGreen -> [32;2]
+            | ConsoleColor.DarkMagenta -> [35;2]
+            | ConsoleColor.DarkRed -> [31;2]
+            | ConsoleColor.DarkYellow -> [33;2]
+            | _ -> [39]
+
+        let codeStr =
+            colorCode color
+            |> List.map (sprintf "%i")
+            |> String.concat ";"
+
+        print <| sprintf "\x1b[%sm%s\x1b[0m" codeStr text
+
+    let printer toStdErr newLine =
+        match toStdErr, newLine with
+        | true, true -> eprintfn "%s"
+        | true, false -> eprintf "%s"
+        | false, true -> printfn "%s"
+        | false, false -> printf "%s"
+
     interface ITraceListener with
         /// Writes the given message to the Console.
-        member this.Write msg = 
+        member this.Write msg =
             let color = colorMap msg
+            let writeText text printer =
+                if useAnsiColorCodes
+                then writeTextAnsiColor printer color text
+                else writeTextConsoleColor printer color text
             match msg with
             | StartMessage -> ()
             | OpenTag _ -> ()
             | CloseTag _ -> ()
             | ImportantMessage text | ErrorMessage text ->
-                writeText importantMessagesToStdErr color true text
+                printer importantMessagesToStdErr true |> writeText text
             | LogMessage(text, newLine) | TraceMessage(text, newLine) ->
-                writeText false color newLine text
+                printer false newLine |> writeText text
             | FinishedMessage -> ()
 
 // If we write the stderr on those build servers the build will fail.
 let importantMessagesToStdErr = buildServer <> CCNet && buildServer <> AppVeyor && buildServer <> TeamCity
 
+// stdout is piped to the logger, so colours are lost. AppVeyor supports ANSI color codes.
+let useAnsiColors = buildServer = AppVeyor
+
 /// The default TraceListener for Console.
 let defaultConsoleTraceListener =
-  ConsoleTraceListener(importantMessagesToStdErr, colorMap)
+  ConsoleTraceListener(importantMessagesToStdErr, colorMap, useAnsiColors)
 
 /// Specifies if the XmlWriter should close tags automatically
 let mutable AutoCloseXmlWriter = false
 
 /// Implements a TraceListener which writes NAnt like XML files.
 /// ## Parameters
 ///  - `xmlOutputFile` - Defines the xml output file.
-type NAntXmlTraceListener(xmlOutputFile) = 
+type NAntXmlTraceListener(xmlOutputFile) =
     let xmlOutputPath = FullName xmlOutputFile
     let getXmlWriter() = new IO.StreamWriter(xmlOutputPath, true, encoding)
     let mutable xmlWriter : IO.StreamWriter = null
-    
-    let deleteOldFile() = 
+
+    let deleteOldFile() =
         let fi = fileInfo xmlOutputPath
-        if fi.Exists then 
+        if fi.Exists then
             fi.IsReadOnly <- false
             fi.Delete()
         if not fi.Directory.Exists then fi.Directory.Create()
-    
-    let closeWriter() = 
-        if xmlWriter <> null then 
+
+    let closeWriter() =
+        if xmlWriter <> null then
             xmlWriter.Close()
             xmlWriter <- null
-    
-    let getXml msg = 
+
+    let getXml msg =
         match msg with
         | StartMessage -> "<?xml version=\"1.0\"?>\r\n<buildresults>"
         | ImportantMessage text -> sprintf "<message level=\"Info\"><![CDATA[%s]]></message>" text // TODO: Set Level
         | LogMessage(text, _) | TraceMessage(text, _) -> sprintf "<message level=\"Info\"><![CDATA[%s]]></message>" text
         | FinishedMessage -> "</buildresults>"
         | OpenTag(tag, name) -> sprintf "<%s name=\"%s\">" tag name
         | CloseTag tag -> sprintf "</%s>" tag
-        | ErrorMessage text -> 
+        | ErrorMessage text ->
             sprintf "<failure><builderror><message level=\"Error\"><![CDATA[%s]]></message></builderror></failure>" text
-    
+
     interface ITraceListener with
         /// Writes the given message to the xml file.
-        member this.Write msg = 
+        member this.Write msg =
             if msg = StartMessage then deleteOldFile()
             if xmlWriter = null then xmlWriter <- getXmlWriter()
             msg