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

FAKE0001 Use the Fake.JavaScript.Yarn module instead

YarnHelper

Contains function to run yarn tasks

Nested types and modules

TypeDescription
InstallArgs
OBSOLETE

FAKE0001 Use the Fake.JavaScript.Yarn module instead

Arguments for the Yarn install command

YarnCommand
OBSOLETE

FAKE0001 Use the Fake.JavaScript.Yarn module instead

The list of supported Yarn commands. The Custom alternative can be used for other commands not in the list until they are implemented

YarnParams
OBSOLETE

FAKE0001 Use the Fake.JavaScript.Yarn module instead

The Yarn parameter type

Functions and values

Function or valueDescription
defaultYarnParams
Signature: YarnParams
Attributes:
[<Obsolete("FAKE0001 Use the Fake.JavaScript.Yarn module instead")>]
OBSOLETE

FAKE0001 Use the Fake.JavaScript.Yarn module instead

Yarn default parameters

parse(_arg1)
Signature: _arg1:YarnCommand -> string
parseInstallArgs(_arg1)
Signature: _arg1:InstallArgs -> string
run(yarnParams)
Signature: yarnParams:YarnParams -> unit
Attributes:
[<Obsolete("FAKE0001 Use the Fake.JavaScript.Yarn module instead")>]
OBSOLETE

FAKE0001 Use the Fake.JavaScript.Yarn module instead

Yarn(setParams)
Signature: setParams:(YarnParams -> YarnParams) -> unit
Attributes:
[<Obsolete("FAKE0001 Use the Fake.JavaScript.Yarn module instead")>]
OBSOLETE

FAKE0001 Use the Fake.JavaScript.Yarn module instead

Runs yarn with the given modification function. Make sure to have yarn installed, you can install yarn with nuget or a regular install. To change which Yarn executable to use you can set the YarnFilePath parameter with the setParams function.

Parameters

  • setParams - Function used to overwrite the Yarn default parameters.

Sample

 1: 
 2: 
 3: 
 4: 
 5: 
 6: 
 7: 
 8: 
 9: 
10: 
11: 
12: 
13: 
    Target "Web" (fun _ ->
        Yarn (fun p ->
                { p with
                    Command = Install Standard
                    WorkingDirectory = "./src/FAKESimple.Web/"
                })

        Yarn (fun p ->
                { p with
                    Command = (Run "build")
                    WorkingDirectory = "./src/FAKESimple.Web/"
                })
    )
yarnFileName
Signature: string

Default paths to Yarn