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
CacheInfo
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.

ModuleDescription
Cache

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.

extractDirectives regex scriptContents
Signature: regex:Regex -> scriptContents:string -> seq<string>
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.

FSIPath
Signature: string
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.

FsiStartInfo(...)
Signature: workingDirectory:string -> FsiArgs -> environmentVars:seq<string * string> -> ProcessStartInfo -> unit
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.

getCacheInfoFromScript(...)
Signature: printDetails:bool -> fsiOptions:seq<string> -> scriptPath:string -> CacheInfo

gets a cache entry for the given script. We need to consider fsiOptions as they might contain --defines.

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.

handleCaching(...)
Signature: printDetails:bool -> session:IFsiSession -> fsiErrorOutput:'?10885 -> cacheDir:DirectoryInfo -> cacheInfo:CacheInfo -> unit
Type parameters: '?10885

Handles a cache store operation, this should not throw as it is executed in a finally block and therefore might eat other exceptions. And a caching error is not critical.

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

onMessage(isError)
Signature: isError:bool -> string -> unit
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.

runFAKEScriptWithFsiArgsAndRedirectMessages(...)
Signature: printDetails:bool -> FsiArgs -> env:seq<string * string> -> onErrMsg:(string -> unit) -> onOutMsg:(string -> unit) -> useCache:bool -> bool

Run the given FAKE script with fsi.exe at the given working directory. Provides full access to Fsi options and args. Redirect output and error messages.

runScriptCached(...)
Signature: printDetails:bool -> cacheInfo:CacheInfo -> out:TextWriter -> err:TextWriter -> bool

Run a script from the cache

runScriptUncached(...)
Signature: (useCache:bool * fsiOptions:seq<string>) -> printDetails:bool -> cacheInfo:CacheInfo -> out:TextWriter -> err:TextWriter -> bool

Run a given script unchacked, saves the cache if useCache is set to true. deletes any existing caching for the given script.

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.