DiffEngine

DiffEngine manages launching and cleanup of diff tools. It is designed to be used by any Snapshot/Approval testing library.

See Milestones for release notes.

Currently used by:

• ApprovalTests
• Shouldly
• Verify

Sponsors

Entity Framework Extensions

Entity Framework Extensions is a major sponsor and is proud to contribute to the development this project.

JetBrains

Contents

• NuGet
• Supported Tools
• Launching a tool
• Closing a tool
• File type detection
• BuildServerDetector
• Disable for a machine/process
• Disable in code
• Icons
• Tools
• Tool Order
• Custom Tool
• DiffEngineTray
• Code versus machine level settings

NuGet

• https://nuget.org/packages/DiffEngine/

Supported Tools

• BeyondCompare Windows/OSX/Linux (Cost: Paid)
• P4Merge Windows/OSX/Linux (Cost: Free)
• Kaleidoscope OSX (Cost: Paid)
• DeltaWalker Windows/OSX (Cost: Paid)
• WinMerge Windows (Cost: Free with option to donate)
• TortoiseGitMerge Windows (Cost: Free)
• TortoiseGitIDiff Windows (Cost: Free)
• TortoiseMerge Windows (Cost: Free)
• TortoiseIDiff Windows (Cost: Free)
• KDiff3 Windows/OSX (Cost: Free)
• TkDiff OSX (Cost: Free)
• Guiffy Windows/OSX (Cost: Paid)
• ExamDiff Windows (Cost: Paid)
• Diffinity Windows (Cost: Free with option to donate)
• Rider Windows/OSX/Linux (Cost: Paid with free option for OSS)
• Vim Windows/OSX (Cost: Free with option to donate)
• Neovim Windows/OSX/Linux (Cost: Free with option to sponsor)
• AraxisMerge Windows/OSX (Cost: Paid)
• Meld Windows/OSX/Linux (Cost: Free)
• SublimeMerge Windows/OSX/Linux (Cost: Paid)
• VisualStudioCode Windows/OSX/Linux (Cost: Free)
• Cursor Windows/OSX/Linux (Cost: Free and Paid)
• VisualStudio Windows (Cost: Paid and free options)
• MsWordDiff Windows (Cost: Free)

Launching a tool

A tool can be launched using the following:

await DiffRunner.LaunchAsync(tempFile, targetFile);

^{snippet source | anchor}

Note that this method will respect the above difference behavior in terms of Auto refresh and MDI behaviors.

Closing a tool

A tool can be closed using the following:

DiffRunner.Kill(file1, file2);

^{snippet source | anchor}

Note that this method will respect the above difference behavior in terms of MDI behavior.

File type detection

DiffEngine use EmptyFiles to determine if a given file or extension is a binary or text. Custom extensions can be added, or existing ones changed.

BuildServerDetector

BuildServerDetector.Detected returns true if the current code is running on a build/CI server.

Supports:

• AppVeyor
• Travis
• Jenkins
• GitHub Actions
• AzureDevops
• TeamCity
• MyGet
• GitLab
• GoCD

There are also individual properties to check for each specific build system

var isWsl = BuildServerDetector.IsWsl;
var isTravis = BuildServerDetector.IsTravis;
var isJenkins = BuildServerDetector.IsJenkins;
var isGithubAction = BuildServerDetector.IsGithubAction;
var isAzureDevops = BuildServerDetector.IsAzureDevops;
var isTeamCity = BuildServerDetector.IsTeamCity;
var isGitLab = BuildServerDetector.IsGitLab;
var isMyGet = BuildServerDetector.IsMyGet;
var isGoDc = BuildServerDetector.IsGoDc;
var isDocker = BuildServerDetector.IsDocker;
var isAppVeyor = BuildServerDetector.IsAppVeyor;

^{snippet source | anchor}

Disable for a machine/process

Set an environment variable DiffEngine_Disabled with the value true.

Disable in code

DiffRunner.Disabled = true;

Icons

Game designed by Andrejs Kirma from The Noun Project.

Tray icons from LineIcons.