Meziantou.Framework.DiffEngine 1.0.0

Prefix Reserved
dotnet add package Meziantou.Framework.DiffEngine --version 1.0.0
                    
NuGet\Install-Package Meziantou.Framework.DiffEngine -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="Meziantou.Framework.DiffEngine" Version="1.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Meziantou.Framework.DiffEngine" Version="1.0.0" />
                    
Directory.Packages.props
<PackageReference Include="Meziantou.Framework.DiffEngine" />
                    
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 Meziantou.Framework.DiffEngine --version 1.0.0
                    
#r "nuget: Meziantou.Framework.DiffEngine, 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 Meziantou.Framework.DiffEngine@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=Meziantou.Framework.DiffEngine&version=1.0.0
                    
Install as a Cake Addin
#tool nuget:?package=Meziantou.Framework.DiffEngine&version=1.0.0
                    
Install as a Cake Tool

Meziantou.Framework.DiffEngine

Meziantou.Framework.DiffEngine resolves installed diff tools and provides launch arguments for comparing two files.

This package is designed for snapshot testing scenarios and is API-compatible with the subset needed by:

  • Meziantou.Framework.SnapshotTesting
  • Meziantou.Framework.InlineSnapshotTesting

Supported public API

  • DiffTool enum
  • DiffTools.TryFindByName(DiffTool, out ResolvedTool?)
  • DiffTools.TryFindByExtension(string, out ResolvedTool?)
  • ResolvedTool (Name, Tool, ExePath, SupportsText, BinaryExtensions, GetArguments)

Example

if (DiffTools.TryFindByName(DiffTool.VisualStudioCode, out var tool))
{
    var arguments = tool.GetArguments("received.json", "verified.json");
    Console.WriteLine($"{tool.ExePath} {arguments}");
}

Environment variables

  • DiffEngine_<ToolName>: override executable detection for one tool (file path or directory)
  • DiffEngine_TargetOnLeft=true: invert generated argument order
Product 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 is compatible.  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 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 (1)

Showing the top 1 NuGet packages that depend on Meziantou.Framework.DiffEngine:

Package Downloads
Meziantou.Framework.SnapshotTesting

Enables verification of objects using file-based snapshots

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0 0 5/18/2026