TickSpec.Build 4.0.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package TickSpec.Build --version 4.0.0                

                    
                

            
NuGet\Install-Package TickSpec.Build -Version 4.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="TickSpec.Build" Version="4.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add TickSpec.Build --version 4.0.0                

                    
                

            
#r "nuget: TickSpec.Build, 4.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install TickSpec.Build as a Cake Addin
#addin nuget:?package=TickSpec.Build&version=4.0.0

// Install TickSpec.Build as a Cake Tool
#tool nuget:?package=TickSpec.Build&version=4.0.0

TickSpec.Build generates test classes to execute TickSpec (Gherkin/BDD) based specifications

TickSpec.Build fixtures FeatureFixtures.fs

It automatically integrates into the build process as "BeforeCompile" target when integrated via NuGet package.

HTML documentation

TickSpec.Build additionally supports generating HTML documents for the feature files

TickSpec.Build doc ./src ./html

When generating the HTML files to the output location the F# project local folders are preserved.

Using --toc html a HTML table of contents and with --toc json a Json table of contents can be generated.

Styling

The generated HTML documents intentionally only contain HTML fragments of type "article" so that those articles can easily be integrated in an existing HTML documentation.

These articles provide the following CSS classes for styling:

  • gherkin-keyword applies to the keywords like GIVEN, WHEN, THEN
  • gherkin-scenario-body applies to the body of a scenario
  • gherkin-scenario applies to a complete scenario
  • gherkin-tags applies to the tags attached to scenarios
  • gherkin-description applies to a comment provided above a scenario
  • gherkin-scenario-title applies to the title of a scenario
  • gherkin-feature-title applies to the feature title

If you want to use the generated articles as a standalone documentation use --toc html to generate a standalone HTML document. Put a style.css next to the ToC.html to define the CSS classes listed above

MsBuild integration

To integrate the HTML generation into your MsBuild based build process set the property FeatureFileHtmlOutput to the location the HTML files should be generated too. By default, only the feature files local to this project are considered. You can change this by setting the property FeatureFileHtmlInput.

The format of the table of contents can be set using property TickSpecBuildTocFormat.

Story behind this project

The following articles tell the story behind this project:

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
4.0.0 122 11/2/2024
3.0.0 256 1/27/2024
2.10.0 193 12/6/2023
2.9.0 192 4/12/2023
2.8.0 187 4/11/2023
2.7.0 176 4/11/2023
2.6.0 190 4/11/2023
2.5.0 190 4/10/2023
2.4.0 190 4/10/2023
2.3.0 202 4/10/2023
2.2.0 258 3/27/2023
2.1.0 214 3/27/2023
2.0.0 217 3/27/2023
1.1.0 247 3/8/2023
1.0.0 245 3/7/2023