DiffEngine/readme.source.md

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

toc include: doc-index

NuGet package

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

Supported Tools

include: diffToolList

Launching a tool

A tool can be launched using the following:

snippet: DiffRunnerLaunch

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:

snippet: DiffRunnerKill

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

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.