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

OBSOLETE

use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')

TraceHelper

This module contains function which allow to trace build output

Nested types and modules

TypeDescription
FAKEException
OBSOLETE

use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')

Functions and values

Function or valueDescription
closeAllOpenTags()
Signature: unit -> unit
Attributes:
[<Obsolete("use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')")>]
OBSOLETE

use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')

closeTag(tag)
Signature: tag:string -> unit
Attributes:
[<Obsolete("use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')")>]
OBSOLETE

use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')

Removes an opening tag from the internal tag stack

console
Signature: ITraceListener
Attributes:
[<Obsolete("use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')")>]
OBSOLETE

use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')

exceptionAndInnersToString(ex)
Signature: ex:Exception -> string
Attributes:
[<Obsolete("use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')")>]
OBSOLETE

use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')

Converts an exception and its inner exceptions to a nice string.

fakePath
Signature: string
Attributes:
[<Obsolete("Don't use anymore, there is no equivalent, please open an issue in FAKE if you need help.")>]
OBSOLETE

Don't use anymore, there is no equivalent, please open an issue in FAKE if you need help.

Gets the path of the current FAKE instance

fakeVersion
Signature: string
Attributes:
[<Obsolete("use Fake.Runtime.Environment.fakeVersion instead (open Fake.Runtime and use 'Environment.')")>]
OBSOLETE

use Fake.Runtime.Environment.fakeVersion instead (open Fake.Runtime and use 'Environment.')

Gets the FAKE version no.

fakeVersionStr
Signature: string
Attributes:
[<Obsolete("use Fake.Runtime.Environment.fakeVersionStr instead (open Fake.Runtime and use 'Environment.')")>]
OBSOLETE

use Fake.Runtime.Environment.fakeVersionStr instead (open Fake.Runtime and use 'Environment.')

Gets the FAKE Version string

log(message)
Signature: message:string -> unit
Attributes:
[<Obsolete("use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')")>]
OBSOLETE

use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')

Logs the specified string

Log message files
Signature: message:string -> files:seq<string> -> unit
Attributes:
[<Obsolete("use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.logItems')")>]
OBSOLETE

use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.logItems')

Logs the given files with the message.

logf(fmt)
Signature: fmt:StringFormat<'?13471,unit> -> '?13471
Type parameters: '?13471 Attributes:
[<Obsolete("use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')")>]
OBSOLETE

use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')

Logs the specified message (without line break)

logfn(fmt)
Signature: fmt:StringFormat<'a,unit> -> 'a
Type parameters: 'a Attributes:
[<Obsolete("use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')")>]
OBSOLETE

use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')

Logs the specified message

logToConsole(msg, eventLogEntry)
Signature: (msg:string * eventLogEntry:EventLogEntryType) -> unit
Attributes:
[<Obsolete("use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')")>]
OBSOLETE

use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')

Traces the message to the console

logVerbosefn(fmt)
Signature: fmt:StringFormat<'a,unit> -> 'a
Type parameters: 'a Attributes:
[<Obsolete("use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')")>]
OBSOLETE

use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')

Logs the specified string if the verbose mode is activated.

openTag(tag)
Signature: tag:string -> unit
Attributes:
[<Obsolete("use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')")>]
OBSOLETE

use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')

Puts an opening tag on the internal tag stack

openTags
Signature: ThreadLocal<string list>
trace(message)
Signature: message:string -> unit
Attributes:
[<Obsolete("use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')")>]
OBSOLETE

use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')

Writes a trace to the command line (in green)

traceEndBuild()
Signature: unit -> unit
Attributes:
[<Obsolete("use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')")>]
OBSOLETE

use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')

Traces the end of the build

traceEndTarget(name)
Signature: name:string -> unit
Attributes:
[<Obsolete("This method is unsafe, please use nuget 'Fake.Core.Trace', open Fake.Core and use 'use _ = Trace.traceTarget' to properly finish the target on errors or use traceStartTargetUnsafe if you know what you do")>]
OBSOLETE

This method is unsafe, please use nuget 'Fake.Core.Trace', open Fake.Core and use 'use _ = Trace.traceTarget' to properly finish the target on errors or use traceStartTargetUnsafe if you know what you do

Traces the end of a target

traceEndTask task description
Signature: task:string -> description:string -> unit
Attributes:
[<Obsolete("This method is unsafe, please use nuget 'Fake.Core.Trace', open Fake.Core and use 'use _ = Trace.traceTask' to properly finish the task on errors or use traceStartTaskUnsafe if you know what you do")>]
OBSOLETE

This method is unsafe, please use nuget 'Fake.Core.Trace', open Fake.Core and use 'use _ = Trace.traceTask' to properly finish the task on errors or use traceStartTaskUnsafe if you know what you do

Traces the end of a task

TraceEnvironmentVariables()
Signature: unit -> unit
Attributes:
[<Obsolete("use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')")>]
OBSOLETE

use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')

Traces the EnvironmentVariables

traceError(error)
Signature: error:string -> unit
Attributes:
[<Obsolete("use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')")>]
OBSOLETE

use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')

Traces an error (in red)

traceException(ex)
Signature: ex:Exception -> unit
Attributes:
[<Obsolete("use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')")>]
OBSOLETE

use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')

Traces an exception details (in red)

tracef(fmt)
Signature: fmt:StringFormat<'a,unit> -> 'a
Type parameters: 'a Attributes:
[<Obsolete("use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')")>]
OBSOLETE

use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')

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 Attributes:
[<Obsolete("use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')")>]
OBSOLETE

use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')

Writes a trace to the command line (in yellow)

tracefn(fmt)
Signature: fmt:StringFormat<'a,unit> -> 'a
Type parameters: 'a Attributes:
[<Obsolete("use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')")>]
OBSOLETE

use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')

Writes a message to the command line (in green)

traceHeader(name)
Signature: name:string -> unit
Attributes:
[<Obsolete("use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')")>]
OBSOLETE

use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')

Traces a header

traceImportant(text)
Signature: text:string -> unit
Attributes:
[<Obsolete("use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')")>]
OBSOLETE

use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')

Writes a trace to stderr (in yellow)

traceLine()
Signature: unit -> unit
Attributes:
[<Obsolete("use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')")>]
OBSOLETE

use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')

Traces a line

traceStartBuild()
Signature: unit -> unit
Attributes:
[<Obsolete("use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')")>]
OBSOLETE

use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')

Traces the begin of the build

traceStartTarget(...)
Signature: name:string -> description:string -> dependencyString:string -> unit
Attributes:
[<Obsolete("This method is unsafe, please use nuget 'Fake.Core.Trace', open Fake.Core and use 'use _ = Trace.traceTarget' to properly finish the target on errors or use traceStartTargetUnsafe if you know what you do")>]
OBSOLETE

This method is unsafe, please use nuget 'Fake.Core.Trace', open Fake.Core and use 'use _ = Trace.traceTarget' to properly finish the target on errors or use traceStartTargetUnsafe if you know what you do

Traces the begin of a target

traceStartTask task description
Signature: task:string -> description:string -> unit
Attributes:
[<Obsolete("This method is unsafe, please use nuget 'Fake.Core.Trace', open Fake.Core and use 'use _ = Trace.traceTask' to properly finish the task on errors or use traceStartTaskUnsafe if you know what you do")>]
OBSOLETE

This method is unsafe, please use nuget 'Fake.Core.Trace', open Fake.Core and use 'use _ = Trace.traceTask' to properly finish the task on errors or use traceStartTaskUnsafe if you know what you do

Traces the begin of a task

traceStartTaskUsing task description
Signature: task:string -> description:string -> IDisposable
Attributes:
[<Obsolete("Please use nuget 'Fake.Core.Trace', open Fake.Core and use 'use _ = Trace.traceTask' to properly finish the task on errors or use traceStartTaskUnsafe if you know what you do")>]
OBSOLETE

Please use nuget 'Fake.Core.Trace', open Fake.Core and use 'use _ = Trace.traceTask' to properly finish the task on errors or use traceStartTaskUnsafe if you know what you do

Traces the begin of a task and closes it again after disposing of the return value (call it with 'use')

traceVerbose(s)
Signature: s:string -> unit
Attributes:
[<Obsolete("use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')")>]
OBSOLETE

use nuget 'Fake.Core.Trace' instead (open Fake.Core and use 'Trace.')

Writes a trace to the command line (in green) if the verbose mode is activated.