Bravellian.TestDocs.Analyzers 2026.2.3.1131

.NET 10.0 This package targets .NET 10.0. The package is compatible with this framework or higher. 
dotnet add package Bravellian.TestDocs.Analyzers --version 2026.2.3.1131
                    


                    

                
NuGet\Install-Package Bravellian.TestDocs.Analyzers -Version 2026.2.3.1131
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="Bravellian.TestDocs.Analyzers" Version="2026.2.3.1131" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Bravellian.TestDocs.Analyzers" Version="2026.2.3.1131" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Bravellian.TestDocs.Analyzers" />
                    


                            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 Bravellian.TestDocs.Analyzers --version 2026.2.3.1131
                    


                    

                
#r "nuget: Bravellian.TestDocs.Analyzers, 2026.2.3.1131"
#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 Bravellian.TestDocs.Analyzers@2026.2.3.1131
#: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=Bravellian.TestDocs.Analyzers&version=2026.2.3.1131
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Bravellian.TestDocs.Analyzers&version=2026.2.3.1131
                    


                            Install as a Cake Tool

TestDocs CLI

This tool extracts XML doc metadata from MSTest, xUnit, and NUnit methods and generates test documentation under docs/testing/generated/.

Requirements

  • .NET SDK pinned in global.json
  • PowerShell 7+ (for scripts)

Run locally

pwsh ./tools/testdocs/scripts/Invoke-TestDocs.ps1

Strict mode and compliance threshold:

pwsh ./tools/testdocs/scripts/Invoke-TestDocs.ps1 -Strict -MinCompliance 0.9

CLI usage

dotnet run --project tools/testdocs/src/TestDocs.Cli -- generate

Dotnet tool usage

dotnet tool install --global Bravellian.TestDocs.Cli
bravellian-testdocs generate

Options:

  • --repoRoot <path>
  • --outDir <path>
  • --strict
  • --minCompliance <0-1>
  • --format markdown|json|both

Packing for NuGet

dotnet pack ./tools/testdocs/TestDocs.sln -c Release -o ./nupkgs

Adding metadata to tests

Follow the schema in docs/testing/test-doc-schema.md. Required tags are summary, intent, scenario, and behavior.

Analyzer package

The analyzer package (Bravellian.TestDocs.Analyzers) emits warnings for:

  • TD001: Missing required XML doc tags.
  • TD002: Placeholder or empty values in required tags.

The default code fix inserts a template with TODO placeholders. Replace them with real content to avoid TD002 warnings.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  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.

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
2026.2.3.1131 185 2/3/2026
2026.2.3.387 136 2/3/2026
2026.2.3.215 132 2/3/2026
2026.2.3.196 145 2/3/2026
2026.2.2.1402 131 2/2/2026
2026.2.2.1040 139 2/2/2026
2026.2.1.1354 136 2/1/2026
2026.2.1.1297 134 2/1/2026
2026.2.1.1217 132 2/1/2026
2026.2.1.333 137 2/1/2026
2026.2.1.326 132 2/1/2026
2026.2.1.159 142 2/1/2026
2026.1.31.455 137 1/31/2026
2026.1.30.391 142 1/30/2026
2026.1.29.1054 142 1/29/2026
2026.1.28.1297 139 1/28/2026
2026.1.28.293 132 1/28/2026
2026.1.27.1127 130 1/27/2026
2026.1.27.106 133 1/27/2026
2026.1.26.1292 131 1/26/2026
Loading failed