snaps

package
v0.5.13 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 4, 2025 License: MIT Imports: 32 Imported by: 6

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Clean added in v0.1.3 

func Clean(m *testing.M, opts ...CleanOpts)

Clean runs checks for identifying obsolete snapshots and prints a Test Summary.

Must be called in a TestMain 

func TestMain(m *testing.M) {
 v := m.Run()

 // After all tests have run `go-snaps` can check for unused snapshots
 snaps.Clean(m)

 os.Exit(v)
}

Clean also supports options for sorting the snapshots 

func TestMain(m *testing.M) {
 v := m.Run()

 // After all tests have run `go-snaps` will sort snapshots
 snaps.Clean(m, snaps.CleanOpts{Sort: true})

 os.Exit(v)
}

func Dir added in v0.4.5 

func Dir(dir string) func(*Config)

Specify folder name where snapshots are stored 

default: __snapshots__

Accepts absolute paths

func Ext added in v0.5.6 

func Ext(ext string) func(*Config)

Specify file name extension

default: .snap

Note: even if you specify a different extension the file still contain .snap e.g. if you specify .txt the file will be .snap.txt

func Filename added in v0.4.5 

func Filename(name string) func(*Config)

Specify snapshot file name 

default: test's filename

this doesn't change the file extension see `snap.Ext`

func JSON added in v0.5.11 

func JSON(json JSONConfig) func(*Config)

Specify json format configuration

default: see defaultPrettyJSONOptions for default json config

func MatchJSON added in v0.4.1 

func MatchJSON(t testingT, input any, matchers ...match.JSONMatcher)

MatchJSON verifies the input matches the most recent snap file. Input can be a valid json string or []byte or whatever value can be passed successfully on `json.Marshal`. 

snaps.MatchJSON(t, `{"user":"mock-user","age":10,"email":"mock@email.com"}`)
snaps.MatchJSON(t, []byte(`{"user":"mock-user","age":10,"email":"mock@email.com"}`))
snaps.MatchJSON(t, User{10, "mock-email"})

MatchJSON also supports passing matchers as a third argument. Those matchers can act either as validators or placeholders for data that might change on each invocation e.g. dates. 

snaps.MatchJSON(t, User{Created: time.Now(), Email: "mock-email"}, match.Any("created"))

func MatchSnapshot 

func MatchSnapshot(t testingT, values ...any)

MatchSnapshot verifies the values match the most recent snap file You can pass multiple values 

MatchSnapshot(t, 10, "hello world")

or call MatchSnapshot multiples times inside a test 

MatchSnapshot(t, 10)
MatchSnapshot(t, "hello world")

The difference is the latter will create multiple entries.

func MatchStandaloneJSON added in v0.5.8 

func MatchStandaloneJSON(t testingT, input any, matchers ...match.JSONMatcher)

MatchStandaloneJSON verifies the input matches the most recent snap file. Input can be a valid json string or []byte or whatever value can be passed successfully on `json.Marshal`. 

snaps.MatchStandaloneJSON(t, `{"user":"mock-user","age":10,"email":"mock@email.com"}`)
snaps.MatchStandaloneJSON(t, []byte(`{"user":"mock-user","age":10,"email":"mock@email.com"}`))
snaps.MatchStandaloneJSON(t, User{10, "mock-email"})

MatchStandaloneJSON also supports passing matchers as a third argument. Those matchers can act either as validators or placeholders for data that might change on each invocation e.g. dates. 

snaps.MatchStandaloneJSON(t, User{Created: time.Now(), Email: "mock-email"}, match.Any("created"))

MatchStandaloneJSON creates one snapshot file per call.

You can call MatchStandaloneJSON multiple times inside a test. It will create multiple snapshot files at `__snapshots__` folder by default.

func MatchStandaloneSnapshot added in v0.5.6 

func MatchStandaloneSnapshot(t testingT, input any)

MatchStandaloneSnapshot verifies the input matches the most recent snap file 

MatchStandaloneSnapshot(t, "Hello World")

MatchStandaloneSnapshot creates one snapshot file per call.

You can call MatchStandaloneSnapshot multiple times inside a test. It will create multiple snapshot files at `__snapshots__` folder by default.

func MatchStandaloneYAML added in v0.5.13 

func MatchStandaloneYAML(t testingT, input any, matchers ...match.YAMLMatcher)

MatchStandaloneYAML verifies the input matches the most recent snap file. Input can be a valid yaml string or []byte or whatever value can be passed successfully on `yaml.Marshal`. 

snaps.MatchStandaloneYAML(t, "user: \"mock-user\"\nage: 10\nemail: mock@email.com")
snaps.MatchStandaloneYAML(t, []byte("user: \"mock-user\"\nage: 10\nemail: mock@email.com"))
snaps.MatchStandaloneYAML(t, User{10, "mock-email"})

MatchStandaloneYAML also supports passing matchers as a third argument. Those matchers can act either as validators or placeholders for data that might change on each invocation e.g. dates. 

snaps.MatchStandaloneYAML(t, User{Created: time.Now(), Email: "mock-email"}, match.Any("$.created"))

MatchStandaloneYAML creates one snapshot file per call.

You can call MatchStandaloneYAML multiple times inside a test. It will create multiple snapshot files at `__snapshots__` folder by default.

func MatchYAML added in v0.5.8 

func MatchYAML(t testingT, input any, matchers ...match.YAMLMatcher)

MatchYAML verifies the input matches the most recent snap file. Input can be a valid yaml string or []byte or whatever value can be passed successfully on `yaml.Marshal`. 

snaps.MatchYAML(t, "user: \"mock-user\"\nage: 10\nemail: mock@email.com")
snaps.MatchYAML(t, []byte("user: \"mock-user\"\nage: 10\nemail: mock@email.com"))
snaps.MatchYAML(t, User{10, "mock-email"})

MatchYAML also supports passing matchers as a third argument. Those matchers can act either as validators or placeholders for data that might change on each invocation e.g. dates. 

snaps.MatchYAML(t, User{Created: time.Now(), Email: "mock-email"}, match.Any("$.created"))

func Skip added in v0.1.3 

func Skip(t testingT, args ...any)

Wrapper of testing.Skip

Keeps track which snapshots are getting skipped and not marked as obsolete.

func SkipNow added in v0.1.3 

func SkipNow(t testingT)

Wrapper of testing.SkipNow

Keeps track which snapshots are getting skipped and not marked as obsolete.

func Skipf added in v0.1.3 

func Skipf(t testingT, format string, args ...any)

Wrapper of testing.Skipf

Keeps track which snapshots are getting skipped and not marked as obsolete.

func Update added in v0.4.11 

func Update(u bool) func(*Config)

Update determines whether to update snapshots or not

It respects if running on CI.

Types

type CleanOpts added in v0.4.12 

type CleanOpts struct {
	// If set to true, `go-snaps` will sort the snapshots
	Sort bool
}

type Config 

type Config struct {
	// contains filtered or unexported fields
}

func WithConfig added in v0.4.5 

func WithConfig(args ...func(*Config)) *Config

Create snaps with configuration 

e.g snaps.WithConfig(snaps.Filename("my_test")).MatchSnapshot(t, "hello world")

func (*Config) MatchJSON added in v0.5.7 

func (c *Config) MatchJSON(t testingT, input any, matchers ...match.JSONMatcher)

MatchJSON verifies the input matches the most recent snap file. Input can be a valid json string or []byte or whatever value can be passed successfully on `json.Marshal`. 

snaps.MatchJSON(t, `{"user":"mock-user","age":10,"email":"mock@email.com"}`)
snaps.MatchJSON(t, []byte(`{"user":"mock-user","age":10,"email":"mock@email.com"}`))
snaps.MatchJSON(t, User{10, "mock-email"})

MatchJSON also supports passing matchers as a third argument. Those matchers can act either as validators or placeholders for data that might change on each invocation e.g. dates. 

snaps.MatchJSON(t, User{Created: time.Now(), Email: "mock-email"}, match.Any("created"))

func (*Config) MatchSnapshot 

func (c *Config) MatchSnapshot(t testingT, values ...any)

MatchSnapshot verifies the values match the most recent snap file You can pass multiple values 

MatchSnapshot(t, 10, "hello world")

or call MatchSnapshot multiples times inside a test 

MatchSnapshot(t, 10)
MatchSnapshot(t, "hello world")

The difference is the latter will create multiple entries.

func (*Config) MatchStandaloneJSON added in v0.5.8 

func (c *Config) MatchStandaloneJSON(t testingT, input any, matchers ...match.JSONMatcher)

MatchStandaloneJSON verifies the input matches the most recent snap file. Input can be a valid json string or []byte or whatever value can be passed successfully on `json.Marshal`. 

snaps.MatchStandaloneJSON(t, `{"user":"mock-user","age":10,"email":"mock@email.com"}`)
snaps.MatchStandaloneJSON(t, []byte(`{"user":"mock-user","age":10,"email":"mock@email.com"}`))
snaps.MatchStandaloneJSON(t, User{10, "mock-email"})

MatchStandaloneJSON also supports passing matchers as a third argument. Those matchers can act either as validators or placeholders for data that might change on each invocation e.g. dates. 

snaps.MatchStandaloneJSON(t, User{Created: time.Now(), Email: "mock-email"}, match.Any("created"))

MatchStandaloneJSON creates one snapshot file per call.

You can call MatchStandaloneJSON multiple times inside a test. It will create multiple snapshot files at `__snapshots__` folder by default.

func (*Config) MatchStandaloneSnapshot added in v0.5.7 

func (c *Config) MatchStandaloneSnapshot(t testingT, input any)

MatchStandaloneSnapshot verifies the input matches the most recent snap file 

MatchStandaloneSnapshot(t, "Hello World")

MatchStandaloneSnapshot creates one snapshot file per call.

You can call MatchStandaloneSnapshot multiple times inside a test. It will create multiple snapshot files at `__snapshots__` folder by default.

func (*Config) MatchStandaloneYAML added in v0.5.13 

func (c *Config) MatchStandaloneYAML(t testingT, input any, matchers ...match.YAMLMatcher)

MatchStandaloneYAML verifies the input matches the most recent snap file. Input can be a valid yaml string or []byte or whatever value can be passed successfully on `yaml.Marshal`. 

snaps.MatchStandaloneYAML(t, "user: \"mock-user\"\nage: 10\nemail: mock@email.com")
snaps.MatchStandaloneYAML(t, []byte("user: \"mock-user\"\nage: 10\nemail: mock@email.com"))
snaps.MatchStandaloneYAML(t, User{10, "mock-email"})

MatchStandaloneYAML also supports passing matchers as a third argument. Those matchers can act either as validators or placeholders for data that might change on each invocation e.g. dates. 

snaps.MatchStandaloneYAML(t, User{Created: time.Now(), Email: "mock-email"}, match.Any("$.created"))

MatchStandaloneYAML creates one snapshot file per call.

You can call MatchStandaloneYAML multiple times inside a test. It will create multiple snapshot files at `__snapshots__` folder by default.

func (*Config) MatchYAML added in v0.5.8 

func (c *Config) MatchYAML(t testingT, input any, matchers ...match.YAMLMatcher)

MatchYAML verifies the input matches the most recent snap file. Input can be a valid yaml string or []byte or whatever value can be passed successfully on `yaml.Marshal`. 

snaps.MatchYAML(t, "user: \"mock-user\"\nage: 10\nemail: mock@email.com")
snaps.MatchYAML(t, []byte("user: \"mock-user\"\nage: 10\nemail: mock@email.com"))
snaps.MatchYAML(t, User{10, "mock-email"})

MatchYAML also supports passing matchers as a third argument. Those matchers can act either as validators or placeholders for data that might change on each invocation e.g. dates. 

snaps.MatchYAML(t, User{Created: time.Now(), Email: "mock-email"}, match.Any("$.created"))

type JSONConfig added in v0.5.11 

type JSONConfig struct {
	// Width is a max column width for single line arrays
	// Default: see defaultPrettyJSONOptions.Width for detail
	Width int
	// Indent is the nested indentation
	// Default: see defaultPrettyJSONOptions.Indent for detail
	Indent string
	// SortKeys will sort the keys alphabetically
	// Default: see defaultPrettyJSONOptions.SortKeys for detail
	SortKeys bool
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.