Tags from go-cmp

v0.7.0

2025-02-21T20:41:08Z

Detect proto.Message types when failing to export a field (#370)

While we do not provide 1st class handling of protobuf messages,
we can at least detect whether the type is a proto.Message
and refer the user to the correct package to use to handle
protobuf messages with cmp.Equal.

v0.6.0

2023-10-10T16:38:52Z

Add cmpopts.EquateComparable (#340)

This helper function makes it easier to specify that comparable types
are safe to directly compare with the == operator in Go.

The API does not use generics as it follows existing options like
cmp.AllowUnexported, cmpopts.IgnoreUnexported, or cmpopts.IgnoreTypes.

While generics provides type safety, the user experience is not as nice.
Our current API allows multiple types to be specified:
cmpopts.EquateComparable(netip.Addr{}, netip.Prefix{})
While generics would not allow variadic arguments:
cmpopts.EquateComparable[netip.Addr]()
cmpopts.EquateComparable[netip.Prefix]()

Bump mininimum supported Go to 1.18 for net/netip type.
Start testing on Go 1.21.

Fixes #339

v0.5.9

2022-09-08T08:04:11Z

Adjust heuristic for line-based versus byte-based diffing (#299)

If the string has many characters that require escape sequences to print,
then we need to take that into consideration and avoid byte-by-byte diffing.

Co-authored-by: Damien Neil <[email protected]>

v0.5.8

2022-04-26T20:56:36Z

v0.5.7

2022-01-19T19:32:01Z

Add //go:build lines (#285)

Starting with Go 1.17, //go:build lines are preferred over // +build
lines, see https://golang.org/doc/go1.17#build-lines and
https://golang.org/design/draft-gobuild for details.

This change was generated by running Go 1.17 go fmt ./... which
automatically adds //go:build lines based on the existing // +build
lines.

Also update the corresponding GitHub action to use Go 1.17 gofmt.

v0.5.6

2021-05-25T02:54:00Z

Print as text if mostly text (#258)

The previous heuristic of treating strings as binary data
if it contains any invalid UTF-8 was too strict.
Loosen the heuristic to check if most of the characters
are printable text.

Fixes #257

v0.5.5

2021-03-04T16:36:09Z

Fix reporter verbosity bug (#253)

FormatDiff should only set the verbosity to 3 if the current verbosity
is lower than 3. Otherwise, it may remove an intended higher verbosity
setting causing the reporter output to not differentiate between
two large values that are different at the end.

While we are at it, increase the maxVerbosityPreset to 6.

v0.5.4

2020-11-24T18:49:09Z

Impose verbosity limit when formatting map keys (#248)

Map keys should have a sensible verbosity limit imposed,
otherwise the reporter can end up printing a massive data structure
that cannot reasonably fit in memory.

v0.5.3

2020-11-12T20:29:58Z

Fix Diff documentation (#237)

The description inaccurately describes the operation of Diff,
which is y - x, where a '+' prefix denotes elements added from y
and a '-' prefix denotes elements removed from x.

For example:
// Consider this call to Diff and its result.
x y
cmp.Diff({b:2, c:3}, {a:1, b:2}) => {+a:1, b:2, -c:3}

// Consider the same in mathematical notation.
y - x
{a:1, b:2} - {b:2, c:3} = {+a:1, b:2, -c:3}

v0.5.2

2020-08-25T06:48:38Z

Suggest use of cmpopts.EquateErrors (#234)

If cmp panics because it is trying to access an unexported field,
specially suggest the use of cmpopts.EquateErrors if the parent type
implements the error interface.

Fixes #233