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

PicklesHelper

Contains tasks to run the Pickles living documentation generator

Nested types and modules

TypeDescription
DocumentationFormat
PicklesErrorLevel

Option which allows to specify if failure of pickles should break the build.
PicklesParams

The Pickles parameter type
TestResultsFormat

The format of the test results

Functions and values

Function or valueDescription
buildPicklesArgs(parameters)
Signature: parameters:PicklesParams -> string
Pickles(setParams)
Signature: setParams:(PicklesParams -> PicklesParams) -> unit

Runs pickles living documentation generator via the given tool Will fail if the pickles command line tool terminates with a non zero exit code.

The pickles command line tool terminates with a non-zero exit code if there is any error.

Parameters

  • setParams - Function used to manipulate the default PicklesParams value

Sample usage

1: 
2: 
3: 
4: 
5: 

Target "BuildDoc" (fun _ ->
   Pickles (fun p -> { p with
                       FeatureDirectory = currentDirectory @@ "Specs"
                       OutputDirectory = currentDirectory @@ "SpecDocs" })
)
PicklesDefaults
Signature: PicklesParams

The Pickles default parameters

Defaults

  • ToolPath - The pickles.exe if it exists in a subdirectory of the current directory
  • FeatureDirectory - 'currentDirectory'
  • FeatureFileLanguage - 'None' (defaults to en)
  • OutputDirectory - currentDirectory @@ "Documentation"
  • OutputFileFormat - DHTML
  • TestResultsFormat - Nunit
  • LinkedTestResultFiles - []
  • SystemUnderTestName - None
  • SystemUnderTestVersion - None
  • TimeOut - 5 minutes
  • ErrorLevel - Error
  • IncludeExperimentalFeatures - None