/DiffEngine

Manages launching and cleanup of diff tools

Primary LanguageC#MIT LicenseMIT

DiffEngine

Build status NuGet Status NuGet Status

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

Currently used by:

Support is available via Tidelift.


Part of the .NET Foundation

Contents

NuGet package

Launching a tool

A tool can be launched using the following:

await DiffRunner.Launch(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:

Disable for a machine/process

Set an environment variable DiffEngine.Disabled with the value true.

Security contact information

To report a security vulnerability, use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.

Icons

Engine designed by Ian Rahmadi Kurniawan from The Noun Project.

Tray icons from LineIcons.