SnapshotAssertions 0.2.0

Prefix Reserved
.NET 10.0 This package targets .NET 10.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package SnapshotAssertions --version 0.2.0
                    


                    

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


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="SnapshotAssertions" />
                    


                            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 SnapshotAssertions --version 0.2.0
                    


                    

                
#r "nuget: SnapshotAssertions, 0.2.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 SnapshotAssertions@0.2.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=SnapshotAssertions&version=0.2.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=SnapshotAssertions&version=0.2.0
                    


                            Install as a Cake Tool

SnapshotAssertions

NuGet License: MIT .NET

Scope: Test projects only. Not intended for production code.

Framework-agnostic core for text-snapshot assertions.

Most users want SnapshotAssertions.TUnit, not this package directly. This is the shared engine; framework-specific adapter packages add the assertion entry points your test framework expects.

What's in this package

  • SnapshotComparer — string-against-file comparison with line-ending, BOM, trailing-whitespace, and trailing-newline options.
  • SnapshotFileResolver — TestContext-aware default file naming (Snapshots/{TestClass}.{TestMethod}.expected.txt) and explicit-path resolution.
  • SnapshotAcceptMode — env-var-driven accept logic (SNAPSHOT_ACCEPT=1 writes the actual content over the expected baseline) with a CI=true guard so accidental pipeline acceptance is impossible.
  • SnapshotOptions — line-ending, BOM, whitespace, and trailing-newline configuration with strict defaults.
  • LineDiffRenderer — terminal line-based diff display, truncated to the first 20 differing lines for very large diffs (LineDiffRenderer.MaxDifferingLines = 20).
  • SnapshotScrubber + Scrubbers factory (v0.2.0+) — text-transform pipeline that replaces volatile substrings (GUIDs, ISO 8601 timestamps, Unix-epoch-millis numbers, custom regex matches) with stable indexed tokens before comparison. Five built-ins (Scrubbers.Guid, Scrubbers.Iso8601Timestamp, Scrubbers.UnixEpochMillis, two Scrubbers.Pattern overloads), one curated chain (Scrubbers.Default), and SnapshotScrubberState for stable indexed-token assignment across recurring values.

Test-framework adapters

Package Test framework Status
SnapshotAssertions.TUnit TUnit Available now
SnapshotAssertions.NUnit NUnit Possible if there is demand
SnapshotAssertions.xUnit xUnit Possible if there is demand
SnapshotAssertions.MSTest MSTest Possible if there is demand

If you'd find a non-TUnit adapter useful, open a feature request — adapters are not built proactively.

Installation

dotnet add package SnapshotAssertions.TUnit

SnapshotAssertions comes transitively. You don't need to install it directly unless you're building your own adapter package.

Stability

The public surfaces above are semver-bound. Breaking changes require a major version bump. The exact text format of line-based diff output is not stable and may gain extra detail or change formatting in any release.

License

MIT — Copyright (c) 2026 John Verheij

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.

  • net10.0

    • No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on SnapshotAssertions:

Package Downloads
SnapshotAssertions.TUnit

TUnit-native text-snapshot assertions using [AssertionExtension]. Provides Assert.That(actual).MatchesSnapshot() / .MatchesSnapshotFile() with line-based diff display, accept-via-environment-variable workflow, and CI guard. AOT-compatible, trimmable, no reflection. Designed for API-surface verification and small text snapshots; coexists with Verify for object-graph cases.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.6.1 214 6/5/2026
0.6.0 140 6/4/2026
0.5.0 102 6/3/2026
0.4.0 1,491 5/16/2026
0.3.0 512 5/12/2026
0.2.0 286 5/7/2026
0.1.0 185 5/5/2026

See CHANGELOG.md