Use .txt file for public API snapshot instead of .snap (from insta)
#595
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
e51037e to
f97ae4d
Compare
CosmicHorrorDev
approved these changes
Aug 20, 2025
|
Looks good from my pov. I like that it's still a snapshot test 🎉 |
|
Thanks for review! I'll merge after updating |
…ta`)
So that showing the diff in GitHub does not become more or less
unreadable because of faulty syntax highlighting.
The `public-api` crate now has (optional) support for built-in snapshot
testing that we use instead of `insta`. But note that the excellent
diffing engine of `insta` (from the crate `similar`) is still used.
We get two new indirect `dev-dependencies`:
* `similar-asserts` - from the same author as `similar` and `insta`, so
we can trust it.
* `snapshot-testing` - new but tiny and easily auditable. (And the
author happens to be me.)
If the `public_api` test fails, instructions on how to update are printed:
thread 'public_api' panicked at tests/public_api.rs:20:16:
assertion failed: `(left == right)`:
help: run with env var `UPDATE_SNAPSHOTS=yes` to update snapshots
...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
So that showing the diff in GitHub does not become more or less unreadable because of faulty syntax highlighting. The
.snapfile extension can't be changed withinsta.The
public-apicrate now has (optional) support for built-in snapshot testing that we use instead ofinsta. But note that the excellent diffing engine ofinsta(from the cratesimilar) is still used.We get two new indirect
dev-dependencies:similar-asserts- from the same author assimilarandinsta, so we can trust it.snapshot-testing- new but tiny and easily audited. (And the author happens to be me.)If the
public_apitest fails, instructions on how to update are printed: