FAKE - F# Make - A DSL for build tasks and more FAKE
6.0.0

Lookig for older versions of the documentation, pre FAKE v6? See 

v5.fake.build

Npm Module

Helpers to run the npm tool.

Example


 Npm.install (fun o ->
         { o with
             WorkingDirectory = "./src/FAKESimple.Web/"
         })

Types

Type Description

InstallArgs

Arguments for the Npm install command

NpmCommand

The list of supported Npm commands.

NpmParams

The Npm parameter type

Functions and values

Function or value Description

Npm.defaultNpmParams

Full Usage: Npm.defaultNpmParams

Returns: NpmParams

Npm default parameters

Returns: NpmParams

Npm.exec command setParams

Full Usage: Npm.exec command setParams

Parameters:
    command : string - Command to run
    setParams : NpmParams -> NpmParams - Set command parameters

Run npm <command>. Used to run any command.

command : string

Command to run

setParams : NpmParams -> NpmParams

Set command parameters

Example


 Npm.exec "--v" (fun o ->
         { o with
             WorkingDirectory = "./src/FAKESimple.Web/"
         })

Npm.install setParams

Full Usage: Npm.install setParams

Parameters:

Run npm install

setParams : NpmParams -> NpmParams

Set command parameters

Example


 Npm.install (fun o ->
         { o with
             WorkingDirectory = "./src/FAKESimple.Web/"
         })

Npm.installForced setParams

Full Usage: Npm.installForced setParams

Parameters:

Run npm install --force

setParams : NpmParams -> NpmParams

Set command parameters

Example


 Npm.installForced (fun o ->
         { o with
             WorkingDirectory = "./src/FAKESimple.Web/"
         })

Npm.run command setParams

Full Usage: Npm.run command setParams

Parameters:
    command : string - Command to run
    setParams : NpmParams -> NpmParams - Set command parameters

Run npm run <command>

command : string

Command to run

setParams : NpmParams -> NpmParams

Set command parameters

Example


 Npm.run "someCommand" (fun o ->
         { o with
             WorkingDirectory = "./src/FAKESimple.Web/"
         })

Npm.runSilent command setParams

Full Usage: Npm.runSilent command setParams

Parameters:
    command : string - Command to run
    setParams : NpmParams -> NpmParams - Set command parameters

Run npm run --silent <command>. Suppresses npm error output. See npm:8821.

command : string

Command to run

setParams : NpmParams -> NpmParams

Set command parameters

Example


 Npm.runSilent "someCommand" (fun o ->
         { o with
             WorkingDirectory = "./src/FAKESimple.Web/"
         })

Npm.runTest command setParams

Full Usage: Npm.runTest command setParams

Parameters:
    command : string - Command to run
    setParams : NpmParams -> NpmParams - Set command parameters

Run npm run --silent <command>. Suppresses npm error output and will raise an FailedTestsException exception after the script execution instead of failing, useful for CI. See npm:8821.

command : string

Command to run

setParams : NpmParams -> NpmParams

Set command parameters

Example


 Npm.runTest "test" (fun o ->
         { o with
             WorkingDirectory = "./src/FAKESimple.Web/"
         })

Npm.test setParams

Full Usage: Npm.test setParams

Parameters:

Run npm test --silent. Suppresses npm error output and will raise an FailedTestsException exception after the script execution instead of failing, useful for CI. See npm:8821.

setParams : NpmParams -> NpmParams

Set command parameters

Example


 Npm.test (fun o ->
         { o with
             WorkingDirectory = "./src/FAKESimple.Web/"
         })