https://github.com/linebender/kompari
Image Diff for snapshot testing
https://github.com/linebender/kompari
Last synced: 10 months ago
JSON representation
Image Diff for snapshot testing
- Host: GitHub
- URL: https://github.com/linebender/kompari
- Owner: spirali
- License: mit
- Created: 2024-11-26T21:11:37.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-27T19:30:10.000Z (over 1 year ago)
- Last Synced: 2024-11-27T20:20:03.726Z (over 1 year ago)
- Language: Rust
- Size: 149 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kompari
*Kompari* is a tool for reporting image differences. It is intended for use in snapshot testing.
It can be used as a stand-alone CLI tool or as a Rust crate.
## CLI
### Local build
```commandline
$ cargo build --release
```
### Usage
Create static HTML report:
```commandline
$ cargo run --release report
```
Start HTTP server for interactive test blessing:
```commandline
$ cargo run --release review
```
## Minimum supported Rust Version (MSRV)
This version of Kompari has been verified to compile with **Rust 1.78** and later.
Future versions of Kompari might increase the Rust version requirement.
It will not be treated as a breaking change and as such can even happen with small patch releases.
Click here if compiling fails.
As time has passed, some of Kompari's dependencies could have released versions with a higher Rust requirement.
If you encounter a compilation issue due to a dependency and don't want to upgrade your Rust toolchain, then you could downgrade the dependency.
```sh
# Use the problematic dependency's name and version
cargo update -p package_name --precise 0.1.1
```
## License
Licensed under either of
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or )
- MIT license ([LICENSE-MIT](LICENSE-MIT) or )
at your option.