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 Fake.DotNet.Fsc instead (FAKE0001 - package: Fake.DotNet.Fsc - module: Fake.DotNet.Fsc)

FscHelper

Contains tasks to compiles F# source file with the FSharp.Compiler.Service. There is also a tutorial about the F# compiler tasks available.

Nested types and modules

TypeDescription
Access
OBSOLETE

FAKE0001 Use the Fake.DotNet.Fsc module instead

Used to set the Accessiblity of an embeded or linked resource

DebugType
OBSOLETE

FAKE0001 Use the Fake.DotNet.Fsc module instead

Specify debugging type: full, pdbonly. ('full' is the default and enables attaching a debugger to a running program).

FscParam
OBSOLETE

FAKE0001 Use the Fake.DotNet.Fsc module instead

FscParams
OBSOLETE

Use FscHelper.FscParam instead

'fsc.exe' command line parameters

FscPlatform
OBSOLETE

Use FscHelper.PlatformType instead

The 'fsc.exe' output platforms

FscTarget
OBSOLETE

Use the FscHelper.TargetType instead

The 'fsc.exe' output target types

Optimization
OBSOLETE

FAKE0001 Use the Fake.DotNet.Fsc module instead

Optimization options that can be disabled or enabled selectively by listing them with the optimize compiler flag

PlatformType
OBSOLETE

FAKE0001 Use the Fake.DotNet.Fsc module instead

Limit which platforms the compiled code can run on: x86, Itanium, x64, anycpu32bitpreferred, or anycpu. The default is anycpu.

Profile
OBSOLETE

FAKE0001 Use the Fake.DotNet.Fsc module instead

Specify target framework profile of this assembly. Valid values are mscorlib or netcore. Default - mscorlib

ResourceInfo
OBSOLETE

FAKE0001 Use the Fake.DotNet.Fsc module instead

Specified path of a managed resource with an optional name alias and accessiblity flag resinfo format is [,[,public|private]] e.g. resource.dat,rezName,public

TargetType
OBSOLETE

FAKE0001 Use the Fake.DotNet.Fsc module instead

Functions and values

Function or valueDescription
compile fscParams inputFiles
Signature: fscParams:FscParam list -> inputFiles:string list -> int
Attributes:
[<Obsolete("FAKE0001 Use the function CompileWithResult in the Fake.DotNet.Fsc module instead")>]
OBSOLETE

FAKE0001 Use the function CompileWithResult in the Fake.DotNet.Fsc module instead

Compiles the given F# source files with the specified parameters.

Parameters

  • setParams - Function used to overwrite the default Fsc parameters.
  • inputFiles - The F# input files.

Returns

The exit status code of the compile process.

Sample

1: 
2: 
3: 
4: 
5: 
6: 
7: 
["file1.fs"; "file2.fs"]
|> compile [Out "" 
            Target Exe
            Platform AnyCpu
            References []
            Debug false 
        ]
Compile fscParams inputFiles
Signature: fscParams:FscParam list -> inputFiles:string list -> unit
Attributes:
[<Obsolete("FAKE0001 Use the Fake.DotNet.Fsc module instead")>]
OBSOLETE

FAKE0001 Use the Fake.DotNet.Fsc module instead

Compiles one or more F# source files with the specified parameters.

Parameters

  • setParams - Function used to overwrite the default Fsc parameters.
  • inputFiles - The F# input files.

Sample

1: 
2: 
3: 
4: 
5: 
6: 
7: 
["file1.fs"; "file2.fs"]
|> Compile [Out "" 
            Target Exe
            Platform AnyCpu
            References []
            Debug false 
        ]
compileFiles srcFiles opts
Signature: srcFiles:string list -> opts:string list -> int
Attributes:
[<Obsolete("FAKE0001 Use the Fake.DotNet.Fsc module instead")>]
OBSOLETE

FAKE0001 Use the Fake.DotNet.Fsc module instead

Compiles the given source file with the given options. If no options given (i.e. the second argument is an empty list), by default tries to behave the same way as would the command-line 'fsc.exe' tool.

fsc setParams inputFiles
Signature: setParams:(FscParams -> FscParams) -> inputFiles:string list -> int
Attributes:
[<Obsolete("Use FscHelper.compile instead")>]
OBSOLETE

Use FscHelper.compile instead

Compiles the given F# source files with the specified parameters.

Parameters

  • setParams - Function used to overwrite the default Fsc parameters.
  • inputFiles - The F# input files.

Returns

The exit status code of the compile process.

Sample

1: 
2: 
3: 
4: 
5: 
["file1.fs"; "file2.fs"]
|> fsc (fun parameters ->
         { parameters with Output = ...
                           FscTarget = ...
                           ... })
Fsc setParams inputFiles
Signature: setParams:(FscParams -> FscParams) -> inputFiles:string list -> unit
Attributes:
[<Obsolete("Use FscHelper.Compile instead")>]
OBSOLETE

Use FscHelper.Compile instead

Compiles one or more F# source files with the specified parameters.

Parameters

  • setParams - Function used to overwrite the default Fsc parameters.
  • inputFiles - The F# input files.

Sample

1: 
2: 
3: 
4: 
5: 
["file1.fs"; "file2.fs"]
|> Fsc (fun parameters ->
              { parameters with Output = ...
                                FscTarget = ...
                                ... })
fscList srcFiles opts
Signature: srcFiles:string list -> opts:string list -> int
Attributes:
[<Obsolete("Use FscHelper.compileFiles instead")>]
OBSOLETE

Use FscHelper.compileFiles instead

Compiles the given source file with the given options. If no options given (i.e. the second argument is an empty list), by default tries to behave the same way as would the command-line 'fsc.exe' tool.

resourceStr(arg1, arg2, arg3)
Signature: (string * string option * Access option) -> string
Attributes:
[<Obsolete("FAKE0001 Use the Fake.DotNet.Fsc module instead")>]
OBSOLETE

FAKE0001 Use the Fake.DotNet.Fsc module instead