stepreport.cli
1.0.54
dotnet tool install --global stepreport.cli --version 1.0.54
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest
dotnet tool install --local stepreport.cli --version 1.0.54
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=stepreport.cli&version=1.0.54
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
nuke :add-package stepreport.cli --version 1.0.54
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Reqnroll.StepReport ๐งช
A .NET CLI tool that extracts all Reqnroll step definitions from your C# files and outputs them into a structured JSON file (steps.json
).
Perfect for QA/SDETs who want to integrate step definitions into documentation tools, Gherkin editors, or test step visualizers.
๐ฆ Installation
Make sure you have .NET SDK 6.0 or later installed.
dotnet tool install -g stepreport.cli
๐ Usage
Navigate to your Reqnroll project folder or pass the path as an argument:
bash
Copy
Edit
stepreport "C:\Path\To\Your\Project"
This will:
Scan all .cs files for [Given], [When], and [Then] attributes
Extract each step with its expression, parameters, and folder name
Output a steps.json file in the same directory
๐งพ Example Output of steps.json
[
{
"StepDefinitionType": "Given",
"Expression": "the user is on the login page",
"Parameters": [],
"Folder": "Authentication"
},
{
"StepDefinitionType": "When",
"Expression": "the user submits their email \\\"(.*)\\\"",
"Parameters": ["string"],
"Folder": "Authentication"
}
]
๐ Features
Supports nested folders and multiple step definition files
Recognizes parameter types like int, decimal, bool, and string
Avoids duplicates across files/folders
๐You can then upload the json file to https://gherkinbuilder.com/ and create feature files with your steps! ๐
Product | Versions 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. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.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.