livingdoc feature-folder

livingdoc feature-folder - Generates living documentation from feature files from the file system.

Synopsis

  livingdoc feature-folder
      [--project-language <projectLanguage>]
      [--test-execution-json <testExecutionJson>]
      [--title <title>]
      [--project-name <project-name>]
      [--work-item-url-template <workItemUrlTemplate>]
      [--work-item-prefix <workItemPrefix>]
      [--binding-assemblies <bindingAssembly1 [bindingAssembly2 ...]>]
      [--output <output>]
      [--output-type <HTML|JSON>]
    <featureFolder>

Arguments

<featureFolder>

Relative (from the working directory) or absolute path of the root folder containing the feature files. If the path to the file contains a space, make sure to enclose it in quotes.

Note: If you also want to see test results in your living documentation, you MUST provide the Test Project Root folder and not a subfolder.

Options

  • --project-language <projectLanguage>

    The language used in your feature files. See Gherkin languages.


  • -t|--test-execution-json <testExecutionJson>

    Relative (from the working directory) or absolute path of the test execution JSON files generated by the SpecFlow.Plus.LivingDocPlugin during test execution.

NOTE: If you used the SpecFlow+ Runner with its parallel execution features you may end up with multiple JSON files.
You can include multiple JSON files separated by a space in the command-line tool as per below

  • -t|--test-execution-json <testExecutionJson_1 testExecutionJson_2 ... >

    OR

    Use a wild card (*) to include them all:

  • -t|--test-execution-json <testExecutionJson*>


  • --binding-assemblies <bindingAssembly1 [bindingAssembly2 ...]>

    Relative (from the working directory) or absolute path of the SpecFlow binding assemblies separated by space. The <TestAssembly> does not have to be specified as a binding assembly because it is always scanned for SpecFlow bindings.


  • --output <output>

    Relative (from the working directory) or absolute path to the generated output file. Default value: LivingDoc.html

NOTE: If the directory given in the “–output” path does not already exist, LivingDoc CLI will automatically create the output directories in the given output path.

The last element in a path ending in a slash or backslash is treated as a directory (not a file name),if a directory with the same name does not exist.
For example, report in –output ./out/out2/report/ is treated as a directory if it does not exist yet. However, if a directory named report does exist in the path, then report is treated as a directory regardless of the path ending in a slash/backslash or not.


  • --output-type <HTML|JSON>

    The type of output file to be generated. The HTML output is the living documentation report. The JSON output contains the pre-parsed feature data optionally extended with further information (test execution results, binding information, etc.). Default value: HTML


  • --work-item-prefix <workItemPrefix>

    The name of the special tag you mark the scenarios with to link them to the corresponding work items.


  • --work-item-url-template <workItemTemplate>

    The URL template to use to generate the external links. e.g: https://dev.azure.com/fabrikam/FabrikamProj/_workitems/edit/{id}


  • --title <title>

    The title/header of the generated document. Default value: The root folder node’s name.


  • --project-name <project-name>

    This name is used by the root node in the tree. Default value: The name of the folder containing the feature files.