Note: This API documentation is for FAKE version 4. The migration API documentation can be found here. The API documentation for the new fake 5 modules can be found here

YarnHelper

Contains function to run yarn tasks

Nested types and modules

TypeDescription
InstallArgs

Arguments for the Yarn install command

YarnCommand

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

YarnParams

The Yarn parameter type

Functions and values

Function or valueDescription
defaultYarnParams
Signature: YarnParams

Yarn default parameters

parse(_arg1)
Signature: _arg1:YarnCommand -> string
parseInstallArgs(_arg1)
Signature: _arg1:InstallArgs -> string
run(yarnParams)
Signature: yarnParams:YarnParams -> unit
Yarn(setParams)
Signature: setParams:(YarnParams -> YarnParams) -> unit

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