Introduction to Reporters

February 8, 2026 ยท View on GitHub

Contents

What is a reporter

When an approval test fails, the mechanism to give you more information about that failing is via a "reporter". Most of the time this means opening a diff tool to show you the .approved. (expected) vs .received. (actual).

The default reporter will search your machine for any installed diff tool.

Supported Diff Tools

See diff_reporters.csv for a list of supported diff tools.

Customizing the reporters.json

You can add a diff tool and path to ApprovalTests by editing the reporters.json file.

resources

  1. configuring a reporter
  2. creating a custom reporter
  3. Options