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

Open Fake.Tools instead (FAKE0001 - package: Fake.Tools.Pickles, module: Pickles)

PicklesHelper

Contains tasks to run the Pickles living documentation generator

Nested types and modules

TypeDescription
DocumentationFormat
OBSOLETE

Open Fake.Tools instead (FAKE0001 - package: Fake.Tools.Pickles, module: Pickles, type: DocumentationFormat)
PicklesErrorLevel
OBSOLETE

Open Fake.Tools instead (FAKE0001 - package: Fake.Tools.Pickles, module: Pickles, type: ErrorLevel)

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

Open Fake.Tools instead (FAKE0001 - package: Fake.Tools.Pickles, module: Pickles, type: PicklesParams)

The Pickles parameter type
TestResultsFormat
OBSOLETE

Open Fake.Tools instead (FAKE0001 - package: Fake.Tools.Pickles, module: Pickles, 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
Attributes:
[<Obsolete("Open Fake.Tools instead (FAKE0001 - package: Fake.Tools.Pickles, module: Pickles, function: convert)")>]
OBSOLETE

Open Fake.Tools instead (FAKE0001 - package: Fake.Tools.Pickles, module: Pickles, function: convert)

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
PicklesDefaults
Signature: PicklesParams
Attributes:
[<Obsolete("Open Fake.Tools instead (FAKE0001 - package: Fake.Tools.Pickles, module: Pickles, function: PicklesDefaults)")>]
OBSOLETE

Open Fake.Tools instead (FAKE0001 - package: Fake.Tools.Pickles, module: Pickles, function: PicklesDefaults)

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