readme.source.md

DiffEngine

include: intro

See Milestones for release notes.

Currently used by:

• ApprovalTests
• Shouldly
• Verify

Sponsors

include: zzz

JetBrains

toc include: doc-index

NuGet

• 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

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

snippet: BuildServerDetectorProps

Override in tests

BuildServerDetector.Detected can be set at test time. The value is stored in an AsyncLocal, so it is scoped to the current async context and does not leak to other threads or tests running in parallel.

snippet: BuildServerDetectorDetectedOverride

AiCliDetector

AiCliDetector.Detected returns true if the current code is running in an AI-powered CLI environment.

Supports:

• GitHub Copilot CLI
• Aider
• Claude Code

There are also individual properties to check for each specific AI CLI

snippet: AiCliDetectorProps

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.