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

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

FSIHelper

Contains helper functions which allow to interact with the F# Interactive.

Nested types and modules

TypeDescription
FsiArgs
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Script
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Functions and values

Function or valueDescription
createDirectiveRegex(id)
Signature: id:string -> Regex
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

executeBuildScriptWithArgsAndFsiArgsAndReturnMessages(...)
Signature: script:string -> scriptArgs:string [] -> fsiArgs:string [] -> useCache:bool -> bool * ConsoleMessage list
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Run the given buildscript with fsi.exe and allows for extra arguments to the script. Returns output.

executeBuildScriptWithArgsAndReturnMessages(...)
Signature: script:string -> scriptArgs:string [] -> useCache:bool -> bool * ConsoleMessage list
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Run the given buildscript with fsi.exe and allows for extra arguments to the script. Returns output.

executeFSI workingDirectory script env
Signature: workingDirectory:string -> script:string -> env:seq<string * string> -> bool * seq<ConsoleMessage>
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Run the given buildscript with fsi.exe

executeFSIWithArgs(...)
Signature: workingDirectory:string -> script:string -> extraFsiArgs:string list -> env:seq<string * string> -> bool
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Run the given build script with fsi.exe and allows for extra arguments to FSI.

executeFSIWithArgsAndReturnMessages(...)
Signature: workingDirectory:string -> script:string -> extraFsiArgs:string list -> env:seq<string * string> -> bool * seq<ConsoleMessage>
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Run the given build script with fsi.exe and allows for extra arguments to FSI. Returns output.

executeFSIWithScriptArgsAndReturnMessages(...)
Signature: script:string -> scriptArgs:string [] -> bool * seq<ConsoleMessage>
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Run the given build script with fsi.exe and allows for extra arguments to the script. Returns output.

fsiPath
Signature: string
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

The path to the F# Interactive tool.

fsiStartInfo(...)
Signature: script:string -> workingDirectory:string -> env:seq<string * string> -> info:ProcessStartInfo -> unit
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Creates a ProcessStartInfo which is configured to the F# Interactive.

getAllScriptContents(pathsAndContents)
Signature: pathsAndContents:seq<Script> -> seq<string>
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

getAllScripts(scriptPath)
Signature: scriptPath:string -> seq<Script>
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

getIncludedAssembly(scriptContents)
Signature: scriptContents:string -> seq<string>
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

getScriptHash(...)
Signature: pathsAndContents:seq<Script> -> fsiOptions:seq<string> -> string
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

getSearchPaths(scriptContents)
Signature: scriptContents:string -> seq<string>
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

hashRegex
Signature: Regex
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

loadRegex
Signature: Regex
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

nameParser(scriptFileName)
Signature: scriptFileName:string -> string * (string -> string) * (string -> string option)
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

because it is used by test code

rAssemblyRegex
Signature: Regex
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

runBuildScript(...)
Signature: printDetails:bool -> script:string -> extraFsiArgs:string list -> env:seq<string * string> -> useCache:bool -> bool
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Run the given buildscript with fsi.exe

runBuildScriptAt(...)
Signature: printDetails:bool -> script:string -> extraFsiArgs:string list -> env:seq<string * string> -> useCache:bool -> bool
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Run the given buildscript with fsi.exe at the given working directory.

runBuildScriptWithFsiArgsAt(...)
Signature: printDetails:bool -> FsiArgs -> env:seq<string * string> -> useCache:bool -> bool
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Run the given buildscript with fsi.exe at the given working directory. Provides full access to Fsi options and args.

searchPathRegex
Signature: Regex
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.