intro-to-reporters.md

Introduction to Reporters

Contents

• What is a reporter
• Supported Diff Tools
• Customizing the reporters.json
• resources

What is a reporter

When approvaltests 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

• AraxisMergeMac
• AraxisMergeWin
• BeyondCompare3
• BeyondCompare4
• BeyondCompare4Mac
• BeyondCompare4x64
• DiffMerge
• PyCharm
• kdiff3
• meld

Customizing the reporters.json

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

resources

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