Note: This is the migration API reference for FAKE 5. The new (modularized) API documentation can be found here. If the API is already migrated you can check here if exists in a module. More information regarding the migration can be found here

Trace

This module contains function which allow to trace build output

Nested types and modules

TypeDescription
ConsoleTraceListener

Implements a TraceListener for System.Console.

FAKEException
ITraceListener

Defines a TraceListener interface

TraceData

Defines Tracing information for TraceListeners

VerboseLevel

Functions and values

Function or valueDescription
colorMap(traceData)
Signature: traceData:TraceData -> ConsoleColor

A default color map which maps TracePriorities to ConsoleColors

defaultConsoleTraceListener
Signature: ITraceListener

The default TraceListener for Console.

fakePath
Signature: string

Gets the path of the current FAKE instance

listeners
Signature: List<ITraceListener>

A List with all registered listeners

log(message)
Signature: message:string -> unit

Logs the specified string

postMessage(x)
Signature: x:TraceData -> unit

Allows to post messages to all trace listeners

trace(message)
Signature: message:string -> unit

Writes a trace to the command line (in green)

traceError(error)
Signature: error:string -> unit

Traces an error (in red)

tracef(fmt)
Signature: fmt:StringFormat<'?21182,unit> -> '?21182
Type parameters: '?21182

Writes a message to the command line (in green) and without a line break

traceFAKE(fmt)
Signature: fmt:StringFormat<'a,unit> -> 'a
Type parameters: 'a

Writes a trace to the command line (in yellow)

tracefn(fmt)
Signature: fmt:StringFormat<'a,unit> -> 'a
Type parameters: 'a

Writes a message to the command line (in green)