snapbox

chore: Release snapbox version 1.2.2

Performance

• Default to the old tempfile behavior for faster builds

chore: Release snapbox version 1.2.1

Features

• Add cmd::Command::cargo_bin

chore: Release snapbox version 1.2.0

Compatibility

• Update MSRV to 1.85

Compatibility

• Change cmd::cargo_bin bad paths to panics

Features

• Add cmd::cargo_bins
• Add cmd::cargo_bin_opt

Fixes

• Un-deprecate cargo_bin

Internal

• Update dependencies

Fixes

• Update fn cargo_bin() to use the upcoming runtime CARGO_BIN_EXE_*
• Add #[must_use] to Command::assert to ensure assertions are ade

Fixes

• Allow additional nesting of extensions when inferring data formats from a path

Compatibility

• Bump MSRV to 1.66

Features

• In-source directory fixtures

Features

• Expose Redactions::clear_unused

Fixes

• Pull in escargot fix

Fixes

• Take redactions into account when finding the end of an elided structured, unordered array

Fixes

• Take redactions into account when finding the end of an elided structured array

Features

• Provide Assert::redactions

Compatibility

• Deprecated IntoData::json in favor of IntoData::is_json
• Deprecated IntoData::json_lines in favor of IntoData::is_jsonlines
• Deprecated IntoData::term_svg in favor of IntoData::is_termsvg

Features

• Added IntoData::against, with shortcuts for json and jsonlines, for different actual and expected formats

Fixes

• str![]: fail, rather than panic, on divergent overlapping overwrites

Features

• Expose Assert::normalize

Fixes

• Allow overwriting if Data::is fails

Features

• Add data format helpers to IntoData

Fixes

• Allow _ in redaction placeholder

Fixes

• Don't stop redacting on first mismatch

Fixes

• Don't stop .term.svg redactions just because the document widths are different

Fixes

• data.unordered() should be additive and not clear other filters

Fixes

• Make diff headers consistent line str's showing relative paths like file-backed expected

Compatibility

• Deprecated Assert::substitutions in favor of Assert::redact_with

Fixes

• Apply redactions to .term.svg files

Compatibility

Breaking

• Removed deprecated functionality
• Removed str![[]] indent support
• Added trailing newline to str![[]]
• Made DataFormat future-proof
• ... / [..] processing has been tweaked
• Redactions no longer normalize the value (except the new Path redactions)
• Change FilterRedactions into NormalizedToExpected

Other

• Deprecate eq_ fn's in favor of eq

Features

• jsonlines support
• Regex redactions
• Path redactions
• Json "all keys" wildcard support
• Unordered lines / json array support

Fixes

• Handle more cases with ...
• Be smarter about which redactions are processed first
• Redact json values on mismatch
• Filter and redact json keys

Compatibility

• Deprecated filter::NormalizePaths in favor of filter::FilterPaths
• Deprecated filter::NormalizeNewlines in favor of filter::FilterNewlines

Documentation

• Fix deprecation message

Compatibility

• Deprecated Harness in favor of the tryfn crate

Compatibility

• Deprecated Assert::eq(expected, actual) in favor of Assert::eq_(actual, expected.raw())
• Deprecated Assert::matches(expected, actual) in favor of Assert::eq_(actual, expected)
• Deprecated OutputAssert::stdout_eq(expected, actual) in favor of OutputAssert::stdout_eq_(actual, expected.raw())
• Deprecated OutputAssert::stdout_matches(expected, actual) in favor of OutputAssert::stdout_eq_(actual, expected)
• Deprecated OutputAssert::stderr_eq(expected, actual) in favor of OutputAssert::stderr_eq_(actual, expected.raw())
• Deprecated OutputAssert::stderr_matches(expected, actual) in favor of OutputAssert::stderr_eq_(actual, expected)
• Deprecated data::Data::normalize in favor of filter::Filter::filter
• Deprecated data::Normalize::normalize in favor of filter::Filter::filter
• Deprecated data::NormalizeNewlines in favor of filter::NormalizeNewlines
• Deprecated data::NormalizePaths in favor of filter::NormalizePaths
• Deprecated data::NormalizeMatches in favor of filter::FilterRedactions
• Deprecated data::Substitutions in favor of filter::Redactions
• Deprecated path feature / mod in favor of dir feature / mod
• Deprecated path::PathFixture in favor of dir::DirRoot
• Deprecated Error in favor of assert::Error
• Deprecated Result in favor of assert::Result
• Deprecated Action in favor of assert::Action
• Deprecated DEFAULT_ACTION_ENV in favor of assert::DEFAULT_ACTION_ENV
• Deprecated utils::normalize_lines in favor of filter::normalize_lines
• Deprecated utils::normalize_paths in favor of filter::normalize_paths
• Deprecated utils::normalize_text

Features

• Add Assert::eq_(actual, expected)
• Add OutputAssert::stdout_eq_(actual, expected)
• Add OutputAssert::stderr_eq_(actual, expected)
• Add assert_data_eq!(actual, expected)
• Add prelude for easier access to IntoData, IntoJson, and ToDebug
• Add IntoData for easier data conversions
• Add IntoJson for easier data conversions
• Add Data::raw to disable filters on expected values
• Add Harness::with_assert for greater customization
• Add Assert::try_eq for non-panicking asserts
• Add Assert::selected_action to see whats chosen

Fixes

• Don't strip on str![].indent(false) to work with lines with indentation

Fixes

• Make auto-path snapshots more deterministic

Fixes

• Respect Assert::normalize_paths(false) when running subset_matches

Fixes

• (term-svg) Reduce noise in SVG snapshots

Fixes

• (term-svg) Correctly coerce "actual" to this type on when the snapshot doesn't yet exist
• (term-svg) Ignore irrelevant details when checking for failuress
• (term-svg) Don't show irrelevant details in the diff

Features

• Add term-svg feature for snapshotting of terminal styling by ending files with .term.svg

Fixes

• Fixed regression where you couldn't overwrite a snapshot that doesn't exist yet

Breaking Change

• _path assertions have been replaced by regular assertions accepting and updating Data::read_from / file![]
• Renamed Data::try_coerce to Data::coerce_to
• Normalization types and DataFormat were moved to the data mod

Features

• str![] macro for inline snapshots
  • coerce_to for specifying the structure of the snapshot
• file!["<path-relative-to-rs>"] macro for test-relative snapshots
  • _ placeholder can be used for auto-generated file names
  • : Json (see DataFormat) type ascriptions for specifying the structure of the snapshot
• ToDebug extension trait for easier snapshot testing of debug output
• Help catch swapped parameters to assertions by panicking if the "actual" has a source to update but not the "expected"
• Allow inserting multiple values for the same variable, to handle multiple forms of the same value (like UNC paths vs regular paths)
• path::current_rs!() macro for an absolute path of std::fs::file!
• path::current_dir!() macro to get the absolute path to std::fs::file!
• path::cargo_rustc_current_dir() macro as a polyfill for the unstable CARGO_RUSTC_CURRENT_DIR

Internal

• Update dependency

Fixes

• Actually match standard diff colors

Fixes

• Match standard diff colors

Internal

• Update anstream

Compatibility

• MSRV bumped to 1.70.0

Performance

• Improved build-times by dropping the is-terminal dependency

Features

• Wildcard support for structured data

Internal

• Dependency update

Internal

• Dependency update

Compatibility

• Update MSRV to 1.64.0
• Deprecated color-auto feature, its now automatic

Internal

• Update dependencies

Internal

• Reduce dependencies

Features

• Added examples feature to expose example-compilation functions in the cmd module

Internal

• Dependency updates