Skip to content

Better surface diff tool configuration #469

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 22, 2021
Merged

Better surface diff tool configuration #469

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b888745
Update README.md
stephencelis May 10, 2021
804f8ad
Update AssertSnapshot.swift
stephencelis May 10, 2021
8b873f3
Update AssertSnapshot.swift
stephencelis May 10, 2021
577f357
Merge branch 'main' into diff-tool-message
stephencelis Jul 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,10 @@ end
- **Supports any platform that supports Swift.** Write snapshot tests for iOS, Linux, macOS, and tvOS.
- **SceneKit, SpriteKit, and WebKit support.** Most snapshot testing libraries don't support these view subclasses.
- **`Codable` support**. Snapshot encodable data structures into their [JSON](Documentation/Available-Snapshot-Strategies.md#json) and [property list](Documentation/Available-Snapshot-Strategies.md#plist) representations.
- **Custom diff tool integration**.
- **Custom diff tool integration**. Configure failure messages to print diff commands for [Kaleidoscope](https://kaleidoscope.app) (or your diff tool of choice).
``` swift
SnapshotTesting.diffTool = "ksdiff"
```

## Plug-ins

Expand Down
11 changes: 10 additions & 1 deletion Sources/SnapshotTesting/AssertSnapshot.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,16 @@ public func verifySnapshot<Value, Format>(

let diffMessage = diffTool
.map { "\($0) \"\(snapshotFileUrl.path)\" \"\(failedSnapshotFileUrl.path)\"" }
?? "@\(minus)\n\"\(snapshotFileUrl.path)\"\n@\(plus)\n\"\(failedSnapshotFileUrl.path)\""
?? """
@\(minus)
"\(snapshotFileUrl.path)"
@\(plus)
"\(failedSnapshotFileUrl.path)"

To configure output for a custom diff tool, like Kaleidoscope:

SnapshotTesting.diffTool = "ksdiff"
"""
return """
Snapshot does not match reference.

Expand Down