Bravellian.TestDocs.Cli 2026.2.3.1131

dotnet tool install --global Bravellian.TestDocs.Cli --version 2026.2.3.1131
                    
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest
                    
if you are setting up this repo
dotnet tool install --local Bravellian.TestDocs.Cli --version 2026.2.3.1131
                    
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=Bravellian.TestDocs.Cli&version=2026.2.3.1131
                    
nuke :add-package Bravellian.TestDocs.Cli --version 2026.2.3.1131
                    

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.

This package has no dependencies.

Version Downloads Last Updated
2026.2.3.1131 219 2/3/2026
2026.2.3.387 142 2/3/2026
2026.2.3.215 141 2/3/2026
2026.2.3.196 142 2/3/2026
2026.2.2.1402 142 2/2/2026
2026.2.2.1040 145 2/2/2026
2026.2.1.1354 140 2/1/2026
2026.2.1.1297 136 2/1/2026
2026.2.1.1217 147 2/1/2026
2026.2.1.333 150 2/1/2026
2026.2.1.326 141 2/1/2026
2026.2.1.159 140 2/1/2026
2026.1.31.455 148 1/31/2026
2026.1.30.391 145 1/30/2026
2026.1.29.1054 147 1/29/2026
2026.1.28.1297 148 1/28/2026
2026.1.28.293 142 1/28/2026
2026.1.27.1127 143 1/27/2026
2026.1.27.106 141 1/27/2026
2026.1.26.1292 131 1/26/2026
Loading failed