v1.41.1

Compare Source

• Re-release of 1.41.1 to generate release artifacts correctly.

v1.41.0

Compare Source

• Experimental support for binary snapshots. #​610 (Florian Plattner)

• --force-update-snapshots now causes cargo-insta to write every snapshot, regardless of whether
  snapshots fully match, and now implies --accept. This
  allows for --force-update-snapshots to update inline snapshots'
  delimiters and indentation.

  For the previous behavior of --force-update-snapshots, which limited writes to
  snapshots which didn't fully match, use --require-full-match.
  The main difference between --require-full-match and the existing behavior of --force-update-snapshots
  is a non-zero exit code on any snapshots which don't fully match.

  Like the previous behavior of --force-update-snapshots, --require-full-match
  doesn't track inline snapshots' delimiters or
  indentation, so can't update if those don't match. #​644

• Inline snapshots only use # characters as delimiters when required. #​603

• Warnings for undiscovered snapshots are more robust, and include files with
  custom snapshot extensions. #​637

• Insta runs correctly on packages which reference rust files in a parent path. #​626

• Warnings are printed when any snapshot uses a legacy format. #​599

• cargo insta --version now prints a version. #​665

• insta now internally uses INSTA_UPDATE=force rather than
  INSTA_FORCE_UPDATE=1. (This doesn't affect users of cargo-insta, which
  handles this internally.) #​482

• cargo-insta's integration tests continue to grow over the past couple of versions,
  and now offer coverage of most of cargo-insta's interface.

v1.40.0

Compare Source

• cargo-insta no longer panics when running cargo insta test --accept --workspace
  on a workspace with a default crate. #​532

• MSRV for insta has been raised to 1.60, and for cargo-insta to 1.64.

• Added support for compact debug snapshots (assert_compact_debug_snapshot). #​514

• Deprecate --no-force-pass in cargo-insta. The --check option covers the
  same functionality and has a clearer name. #​513

• Inline snapshots now use the required number of #s to escape the snapshot
  value, rather than always using ###. This allows snapshotting values which
  themselves contain ###. If there are no existing # characters in the
  snapshot value, a single # will be used. #​540

• Inline snapshots can now be updated with --force-update-snapshots. #​569

• cargo insta test accepts multiple --exclude flags. #​520

• test runner in insta's yaml config works. #​544

• Print a warning when encountering old snapshot formats. #​503

• Group the options in cargo insta --help, upgrade to clap from structopt. #​518

• No longer suggest running cargo insta message when running cargo insta test --check. #​515

• Print a clearer error message when accepting a snapshot that was removed. #​516

• Mark require-full-match as experimental, given some corner-cases are currently difficult to manage. #​497

• Add a new integration test approach for cargo-insta and a set of integration tests. #​537

• Enable Filters to be created from IntoIterator types, rather than just Vecs. #​570

• Implemented total sort order for an internal Key type correctly. This prevents potential
  crashes introduced by the new sort algorithm in Rust 1.81. #​586

v1.39.0

Compare Source

• Fixed a bug in require_full_match. #​485

• Fixed a bug that caused snapshot and module names to sometimes be inaccurate. #​483

• Insta will no longer error when attempting to remove snapshots that were already removed. #​484

• Added support for trailing commas in inline snapshots. #​472

• Don't pass --color in all cases to libtest any more to work around limitations
  with custom test harnesses. #​491

v1.38.0

Compare Source

• Filters is now constructible from IntoIterator. #​400

• Change std macro calls to be fully qualified. This fixes issues where
  the prelude was not used or the macros were overridden. #​469

v1.37.0

Compare Source

• All macros for file snapshots should now handle trailing commas (but not yet inline snapshots)

• Vendored old yaml-rust dependency to avoid rustsec warnings. #​465

v1.36.1

Compare Source

• Fix an ownership issue introduced in 1.36 with snapshot assertions. #​453

v1.36.0

Compare Source

• Deprecate INSTA_FORCE_UPDATE_SNAPSHOTS env-var for INSTA_FORCE_UPDATE.
  The latter was documented, the former was implemented. #​449

• Add require_full_match option. #​448

• Deprecate assert_display_snapshot!. #​385

v1.35.1

Compare Source

• Fixed a bug with diffs showing bogus newlines.

v1.35.0

Compare Source

• Fixed a crash when a file named .config was in the root.
• Added new alternative match .. { ... } syntax to redactions for better
  rustfmt support. (#​428)
• The --package parameter can be supplied multiple times now. (#​427)
• Leading newlines in snapshots are now ignored to resolve issues with
  inline snapshots that were never able to match. (#​444)
• cargo insta test now accepts the --test parameter multiple times. (#​437)

v1.34.0

Compare Source

• Snapshots are now sorted in the UI on review. (#​413)
• Re-organized repository to move cargo-insta into a workspace. (#​410)
• Fixed handling of --manifest-path with regards to virtual workspaces. (#​409)

v1.33.0

Compare Source

• Added --all-targets parameter support to cargo insta test. (#​408)

v1.32.0

Compare Source

• Added --profile parameter support to cargo insta test.

v1.31.0

Compare Source

• Fixed a bug that caused cargo insta test not to report test failures.
• Suppress needless_raw_string_hashes clippy lint on inline snapshots. (#​390)

v1.30.0

Compare Source

• Resolved a bug on Windows that caused input_file not to be written into the
  snapshots. (#​386)
• Snapshots are accepted when running with --accept even if a test outside
  insta fails. (#​358)
• Mark settings drop guard as #[must_use].
• Write inline snapshots with atomic rename to avoid some rare races. (#​373)
• Pass --color=... to libtest to propagate color choices in more situations. (#​375)

v1.29.0

Compare Source

• Fixed a rendering bug with snapshot display (lines were not
  rendered to the terminal width).
• Added --exclude option to cargo insta test. (#​360)
• Inherit color option from a CARGO_TERM_COLOR environment variable (#​361)

v1.28.0

Compare Source

• Added allow_duplicates! to enable multiple assertions for a
  single snapshot. (#​346)
• Ensure that expressions formatted with rustfmt use unix newlines.
• Added a way to disable diffing in review. (#​348)
• Added three argument version of glob! to set a different base
  path. (#​347)
• Added rounded_redaction to truncate floating point values. (#​350)

v1.26.0

Compare Source

• Make canonicalization in glob! optional to better support WASI.

v1.24.1

Compare Source

• Fix non working --include-hidden flag (#​331)
• Fix incorrect mapping of review.include_ignored (#​330)

v1.24.0

Compare Source

• Added an insta tool config (.config/insta.yaml) to change the
  behavior of insta and cargo-insta. (#​322)
• Renamed --no-ignore to --include-ignored.
• Added --include-hidden to instruct insta to also walk into
  hidden paths.
• Added new --unreferenced option to cargo-insta test which allows
  fine tuning of what should happen with unreferenced files. It's now
  possible to ignore (default), warn, reject or delete unreferenced
  snapshots. (#​328)
• Resolved an error message about doc tests when using nextest with
  test targeting. (#​317)

v1.23.0

Compare Source

• Add a hint if snapshots might be skipped. (#​314)
• Avoid extra newline in YAML snapshots. (#​311)

v1.22.0

Compare Source

• Added support for rendering some invisibles in diffs. This now also
  should make sure that ANSI sequences in strings are no longer screwing
  up the terminal output. (#​308)
• Prevent inline snapshots to be used in loops. (#​307)
• Support the --target option to cargo insta test. (#​309)
• Globbing now adds directories as disambiguators into the snapshot
  suffixes. This allows patterns such as foo/*/*.txt without
  creating conflicts. (#​310)

v1.21.2

Compare Source

• Added missing parameters to cargo insta test. (#​305)
• Fixed a sorting issue in hash maps for compound keys. (#​304)

v1.21.1

• Fix incorrect handling of extra args to cargo insta test.

v1.21.0

• Fixed an issue that broke support for older rust versions. (#​292)
• Added cargo insta show command to render a snapshot.
• Added support for compact JSON snapshots. (#​288)

v1.20.0

Compare Source

• cargo insta now supports nextest as test runner. (#​285)
• The glob! macro now defers failures by default. (#​284)

v1.19.1

Compare Source

• Added support for numeric keys in JSON which regressed in 0.18.0. (#​281)

v1.19.0

Compare Source

• Removed backtrace feature.
• Removed serialization feature.
• assert_json_snapshot! and assert_yaml_snapshot! now require
  the json and yaml feature respectively.
• Doctests now emit a warning that inline snapshot updating is
  not supported (#​272)
• Added support for INSTA_GLOB_FILTER to skip over tests expanded
  from a glob. (#​274)

v1.18.2

Compare Source

• Avoid the use of #[allow(unused)] in the macro. (#​271)

v1.18.1

Compare Source

• Fixed a regression in the JSON serialization format with newtypes and
  tuple variants. (#​270)

v1.18.0

• Settings::bind now can return a result.
• Expose the drop guard type of bind_to_scope.
• The serde dependency is now optional. While still enabled by default
  users need to opt into yaml and json features explicitly to regain
  support for it. To avoid the default serde dependency the default
  features just need to be disabled. (#​255)
• Deprecated unused serialization features.
• Deprecated unused backtrace feature.
• Removed deprecated Settings::bind_to_thread.

Breaking Changes / Upgrading: If you are upgrading to serde 1.18.0 you will
receive deprecating warnings if you are using the assert_yaml_snapshot! and
assert_json_snapshot! macros. These macros will continue to function in the
future but they will require explicit opting into the yaml and json features.
To silence the warning add them to your insta dependency. Additionally the
backtrace feature was deprecated. It is no longer needed so just remove it.

v1.17.2

• Remove an accidentally debug print output.

v1.17.1

• Added support for nextest. (#​242)
• Resolved an issue where inline snapshot tests in doctests refused to
  work. (#​252)

v1.17.0

• Fixed an issue in cargo-insta where sometimes accepting inline snapshots
  would crash with an out of bounds panic.
• Added new filters feature. (#​245)
• Disallow unnamed snapshots in doctests. (#​246)
• with_settings! macro now inherits the former settings rather than resetting. (#​249)
• Added support for Settings::bind_to_scope and deprecated
  Settings::bind_to_thread. (#​250)
• Added support for minimal-versions builds.

v1.16.0

Compare Source

• Added --no-quiet/-Q flag to cargo insta test to suppress the
  quiet flag. This works around limitations with custom test harnesses
  such as cucumber.
• Update RON to 0.7.1.
• Improved ergonomics around with_settings!. It's now a perfect match to
  the settings object's setter methods.
• Added description and info to snapshots. (#​239)
• Added omit_expression setting. (#​239)
• Added improved support for running insta from doctests. (#​243)

v1.15.0

Compare Source

• Bump minimum version of Rust to 1.56.1. This was done because the used
  serde-yaml dependency no longer supports older versions of Rust.

v1.14.1

Compare Source

• Update uuid crate to 1.0.0. (#​228)
• Use inline block format also for strings of form "foo\n". (#​225)

v1.14.0

Compare Source

• Fixed a bug that caused insta to panic if inline snapshot assertions
  moved since the time of the snapshot creation. (#​220)
• cargo insta test now returns non zero status code when snapshots
  are left for review. (#​222)
• Assertion failures now mention cargo insta test. (#​223)

v1.13.0

• Fixed a bug where an extra newline was emitted following the snapshot header.
• assertion_line is no longer retained in snapshots. (#​218)

v1.12.0

• Add support for sorting redactions (sorted_redaction and Settings::sort_selector). (#​212)
• Changed snapshot name detection to no longer use thread names but function names. (#​213)

Upgrade Notes:

Insta used to detect the current test name by using the current thread name. This
appeared to work well but unfortunately ran into various limitations. In particular
in some cases the thread name was truncated, missing or did not point to the current
test name. To better support different platforms and situations insta now uses the
function name instead.

This however changes behavior. In particular if you are using a helper function to
assert, a different snapshot name will now be used. You can work around this issue
by using a helper macro instead or to explicitly pass a snapshot name in such
situations.

v1.11.0

Compare Source

• Trim down some unnecessary dependencies and switch to once_cell. (#​208)

v1.10.0

Compare Source

• Update internal dependencies for console and ron.

v1.9.0

Compare Source

• cargo-insta now correctly handles the package (-p) argument
  on test when deleting unreferenced snapshots. (#​201)

v1.8.0

Compare Source

• Added the ability to redact into a key. (#​192)
• Insta now memorizes assertion line numbers in snapshots. While these
  will quickly be old, they are often useful when reviewing snapshots
  immediately after creation with cargo-insta. (#​191)

v1.7.2

Compare Source

• Fixed an issue where selectors could not start with underscore. (#​189)
• Allow passing arguments to cargo test. (#​183)
• Avoid the use of Box::leak. (#​185)
• When INSTA_WORKSPACE_ROOT is set, the value is used as the manifest
  directory rather than whatever CARGO_MANIFEST_DIR was set to at compile
  time. (#​180)

v1.7.1

Compare Source

• Removed an accidental debug print. (#​175)

v1.7.0

Compare Source

• Added support for u128/i128. (#​169)
• Normalize newlines to unix before before asserting. (#​172)
• Switch diffing to patience. (#​173)

v1.6.3

Compare Source

• Fix a bug with empty lines in inline snapshots. (#​166)

v1.6.2

Compare Source

• Lower Rust support to 1.41.0 (#​165)

v1.6.1

Compare Source

• Bump similar dependency to reintroduce support for Rust 1.43.0 (#​162)
• Fixed custom extension support in cargo-insta (#​163)

v1.6.0

Compare Source

• Change CSV serialization format to format multiple structs as
  multiple rows. (#​156)
• Improvements to diff rendering.
• Detect some snapshot name clashes. (#​159)

v1.5.3

• Replace difference with
  similar.

v1.5.2

• API documentation updates.

v1.5.1

Compare Source

• Fixed glob not working correctly.
• Fail by default if glob is not returning any matches. Fixes #​151.

v1.5.0

Compare Source

• Add pending-snapshots parameter to cargo-insta.
• cargo-insta now honors ignore files. This can be overridden
  with --no-ignore.
• cargo-insta now supports the vscode extension.

v1.4.0

Compare Source

• Add --delete-unreferenced-snapshots parameter to cargo-insta.
• Switch to the globset crate for the glob feature.
• When INSTA_UPDATE is set to always or unseen it won't
  fail on execution.
• Changed informational outputs also show on pass.

v1.3.0

Compare Source

• Expose more useful methods from Content.
• Fixes for latest rustc version.

v1.2.0

Compare Source

• Fix invalid offset calculation for inline snapshot (#​137)
• Added support for newtype variant redactions. (#​139)

v1.1.0

Compare Source

• Added the INSTA_SNAPSHOT_REFERENCES_FILE environment variable to support
  deletions of unreferenced snapshot files. (#​136)
• Added support for TOML serializations.
• Avoid diff calculation on large input files. (#​135)
• Added prepend_module_to_snapshot flag to disable prepending of module
  names to snapshot files. (#​133)
• Made console dependency optional. The colors feature can be disabled now
  which disables colored output.

v1.0.0

Compare Source

• Globs now follow links (#​132)
• Added CSV Support (#​134)
• Changed globs to also include directories not just files.
• Support snapshots outside source folder. (#​70)
• Update RON to 0.6.