Pepper.Attributes 1.0.0

.NET Standard 2.0

The owner has unlisted this package. This could mean that the package is deprecated, has security vulnerabilities or shouldn't be used anymore.

dotnet add package Pepper.Attributes --version 1.0.0

NuGet\Install-Package Pepper.Attributes -Version 1.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="Pepper.Attributes" Version="1.0.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Pepper.Attributes" Version="1.0.0" />
                    

                            Directory.Packages.props

<PackageReference Include="Pepper.Attributes" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add Pepper.Attributes --version 1.0.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Pepper.Attributes, 1.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.

#:package Pepper.Attributes@1.0.0

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=Pepper.Attributes&version=1.0.0
                    

                            Install as a Cake Addin

#tool nuget:?package=Pepper.Attributes&version=1.0.0
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Pepper

BDD-style test documentation generator for .NET. Generate living documentation from your automated tests without step definitions or complex workflows.

Features

Framework Support: NUnit, xUnit, and MSTest
Multiple Output Formats: PDF, HTML, and JSON
Step Extraction: Automatically documents test steps from method calls
Custom Attributes: Add metadata using Pepper attributes
Category Filtering: Generate reports for specific test categories
Customizable Reports: Multiple styles, fonts, and custom logos

Installation

dotnet add package Pepper.Attributes

Quick Start

1. Add Attributes to Your Tests

using Pepper.Attributes;

[Test]
[CaseDescription("Verify user can log in with valid credentials")]
public void Login_WithValidCredentials_ShouldSucceed()
{
    NavigateToLoginPage();
    EnterCredentials("testuser", "password123");
    ClickLoginButton();
    VerifyDashboardIsDisplayed();
}

[StepDescription("Navigate to the login page")]
public void NavigateToLoginPage() { /* ... */ }

[StepDescription("Enter username '{username}' and password")]
public void EnterCredentials(string username, string password) { /* ... */ }

[StepDescription("Click the login button")]
public void ClickLoginButton() { /* ... */ }

[StepDescription("Verify the dashboard is displayed")]
public void VerifyDashboardIsDisplayed() { /* ... */ }

2. Generate Documentation

pepper -generateReport -project "path/to/TestProject" -output "TestReport.pdf"
pepper -generateReport -project "path/to/TestProject" -output "TestReport.html"

Available Attributes

Attribute	Description
`[CaseDescription("...")]`	Describes what a test case validates
`[StepDescription("...")]`	Describes what a method does (supports `{parameter}` templates)
`[StepIgnore]`	Excludes a method from documentation
`[CustomAttribute("Key", "Value")]`	Adds custom metadata (e.g., TestRail IDs)

CLI Options

Option	Description
`-generateReport`	Generate report (PDF or HTML based on output extension)
`-generateJson`	Generate JSON export
`-project`	Path to test project directory
`-output`	Output file path
`-reportName`	Custom report title
`-font`	Font family (calibri, arial, times, courier, consolas)
`-reportStyle`	Layout style (structured, simple)
`-categories`	Filter by categories (e.g., "Smoke,Regression")
`-logoSource`	Path to custom logo image
`-includeCustoms`	Include custom attributes in report
`-config`	Path to configuration file

Configuration File

Create a pepper.config.json file:

{
  "project": "./",
  "output": "TestDocumentation.pdf",
  "reportName": "My Test Suite",
  "font": "calibri",
  "reportStyle": "structured",
  "generateJson": true,
  "categories": "Smoke,Regression"
}

License

MIT - see LICENSE for details.

Support

If you find Pepper useful, consider sponsoring the project on GitHub.

Links

Website: https://pepperbdd.io
Documentation: https://pepperbdd.io/docs

Product	Compatible and additional computed target framework versions.
.NET	net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. 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.
.NET Core	netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed.
.NET Standard	netstandard2.0 is compatible. netstandard2.1 was computed.
.NET Framework	net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed.
MonoAndroid	monoandroid was computed.
MonoMac	monomac was computed.
MonoTouch	monotouch was computed.
Tizen	tizen40 was computed. tizen60 was computed.
Xamarin.iOS	xamarinios was computed.
Xamarin.Mac	xamarinmac was computed.
Xamarin.TVOS	xamarintvos was computed.
Xamarin.WatchOS	xamarinwatchos was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

.NETStandard 2.0
- 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