cargo-insta: review tool for insta, a snapshot testing library for Rust
cargo-insta: review tool for insta, a snapshot testing library for Rust
cargo-insta provides a cargo command for insta
snapshot reviews.
$ cargo install cargo-insta
$ cargo insta --help
cargo-insta provides a few different commands to interact with insta snapshots.
reviewThis is the main command you are likely to use. It starts the interactive
review process. It takes similar arguments to the other commands and typically
does not require any. It will auto discover snapshots in the current workspace.
If you want to change the location you can use --workspace-root which
explicitly sets the path to the workspace or --manifest-path to set the
path to a specific Cargo.toml.
Once the review process is starting you can accept changes with a, reject
changes with j and skip with s.
testThis is a special command that works exactly like cargo test but it will
force all snapshots assertions to pass. That way you can collect all snapshot
changes in one go and review them. You can also combine this with --accept
to just accept all changes, --accept-unseen to accept all previously unseen
snapshots or --review to start a review process afterwards. Additionally
this commands supports --delete-unreferenced-snapshots to automatically
delete all unreferenced snapshots after the test run.
rejectLike review but automatically rejects all snapshots.
acceptLike accept but automatically accepts all snapshots.
pending-snapshotsA utility command to emit information about pending snapshots. This is useful
when you want to script cargo-insta. For instance this is now the visual
studio code extension interfaces with insta.
