@vitest/snapshot

Lightweight implementation of Jest's snapshots.

Usage

import { SnapshotClient } from '@vitest/snapshot'
import { NodeSnapshotEnvironment } from '@vitest/snapshot/environment'
import { SnapshotManager } from '@vitest/snapshot/manager'

const client = new SnapshotClient({
  // you need to provide your own equality check implementation if you use it
  // this function is called when `.toMatchSnapshot({ property: 1 })` is called
  isEqual: (received, expected) =>
    equals(received, expected, [iterableEquality, subsetEquality]),
})

// class that implements snapshot saving and reading
// by default uses fs module, but you can provide your own implementation depending on the environment
const environment = new NodeSnapshotEnvironment()

// you need to implement this yourselves,
// this depends on your runner
function getCurrentFilepath() {
  return '/file.spec.js'
}
function getCurrentTestName() {
  return 'test1'
}

// example for inline snapshots, nothing is required to support regular snapshots,
// just call `assert` with `isInline: false`
function wrapper(received) {
  function __INLINE_SNAPSHOT__(inlineSnapshot, message) {
    client.assert({
      received,
      message,
      isInline: true,
      inlineSnapshot,
      filepath: getCurrentFilepath(),
      name: getCurrentTestName(),
    })
  }
  return {
    // the name is hard-coded, it should be inside another function, so Vitest can find the actual test file where it was called (parses call stack trace + 2)
    // you can override this behaviour in SnapshotState's `_inferInlineSnapshotStack` method by providing your own SnapshotState to SnapshotClient constructor
    toMatchInlineSnapshot: (...args) => __INLINE_SNAPSHOT__(...args),
  }
}

const options = {
  updateSnapshot: 'new',
  snapshotEnvironment: environment,
}

await client.startCurrentRun(
  getCurrentFilepath(),
  getCurrentTestName(),
  options
)

// this will save snapshot to a file which is returned by "snapshotEnvironment.resolvePath"
client.assert({
  received: 'some text',
  isInline: false,
})

// uses "pretty-format", so it requires quotes
// also naming is hard-coded when parsing test files
wrapper('text 1').toMatchInlineSnapshot()
wrapper('text 2').toMatchInlineSnapshot('"text 2"')

const result = await client.finishCurrentRun() // this saves files and returns SnapshotResult

// you can use manager to manage several clients
const manager = new SnapshotManager(options)
manager.add(result)

// do something
// and then read the summary

console.log(manager.summary)

GitHub | Documentation

Current Tags

4.1.0-beta.6 ... beta (a month ago)
4.1.4 ... latest (2 days ago)

165 Versions

4.1.4 ... 2 days ago
4.1.3 ... 4 days ago
4.1.2 ... 16 days ago
4.1.1 ... 19 days ago
4.1.0 ... a month ago
4.1.0-beta.6 ... a month ago
4.1.0-beta.5 ... 2 months ago
4.1.0-beta.4 ... 2 months ago
4.1.0-beta.3 ... 2 months ago
4.0.18 ... 3 months ago
4.1.0-beta.2 ... 3 months ago
4.1.0-beta.1 ... 3 months ago
4.0.17 ... 3 months ago
4.0.16 ... 4 months ago
4.0.15 ... 4 months ago
4.0.14 ... 5 months ago
4.0.13 ... 5 months ago
4.0.12 ... 5 months ago
4.0.11 ... 5 months ago
4.0.10 ... 5 months ago
4.0.9 ... 5 months ago
4.0.8 ... 5 months ago
4.0.7 ... 5 months ago
4.0.6 ... 5 months ago
4.0.5 ... 5 months ago
4.0.4 ... 5 months ago
4.0.3 ... 6 months ago
4.0.2 ... 6 months ago
4.0.1 ... 6 months ago
4.0.0 ... 6 months ago
4.0.0-beta.19 ... 6 months ago
4.0.0-beta.18 ... 6 months ago
4.0.0-beta.17 ... 6 months ago
4.0.0-beta.16 ... 6 months ago
4.0.0-beta.15 ... 6 months ago
4.0.0-beta.14 ... 6 months ago
4.0.0-beta.13 ... 7 months ago
4.0.0-beta.12 ... 7 months ago
4.0.0-beta.11 ... 7 months ago
4.0.0-beta.10 ... 7 months ago
4.0.0-beta.9 ... 8 months ago
4.0.0-beta.8 ... 8 months ago
4.0.0-beta.7 ... 8 months ago
4.0.0-beta.6 ... 8 months ago
4.0.0-beta.5 ... 8 months ago
4.0.0-beta.4 ... 9 months ago
4.0.0-beta.3 ... 9 months ago
4.0.0-beta.2 ... 10 months ago
4.0.0-beta.1 ... 10 months ago
3.2.4 ... 10 months ago
3.2.3 ... 10 months ago
3.2.2 ... 10 months ago
3.2.1 ... 10 months ago
3.2.0 ... 10 months ago
3.2.0-beta.3 ... 10 months ago
3.1.4 ... a year ago
3.2.0-beta.2 ... a year ago
3.2.0-beta.1 ... a year ago
3.1.3 ... a year ago
3.1.2 ... a year ago
3.1.1 ... a year ago
3.1.0 ... a year ago
3.1.0-beta.2 ... a year ago
3.1.0-beta.1 ... a year ago
3.0.9 ... a year ago
3.0.8 ... a year ago
3.0.7 ... a year ago
3.0.6 ... a year ago
3.0.5 ... a year ago
2.1.9 ... a year ago
1.6.1 ... a year ago
3.0.4 ... a year ago
3.0.3 ... a year ago
3.0.2 ... a year ago
3.0.1 ... a year ago
3.0.0 ... a year ago
3.0.0-beta.4 ... a year ago
3.0.0-beta.3 ... a year ago
3.0.0-beta.2 ... a year ago
3.0.0-beta.1 ... a year ago
2.1.8 ... a year ago
2.1.7 ... a year ago
2.1.6 ... a year ago
2.2.0-beta.2 ... a year ago
2.2.0-beta.1 ... a year ago
2.1.5 ... a year ago
2.1.4 ... a year ago
2.1.3 ... a year ago
2.1.2 ... 2 years ago
2.1.1 ... 2 years ago
2.1.0 ... 2 years ago
2.1.0-beta.7 ... 2 years ago
2.1.0-beta.6 ... 2 years ago
2.1.0-beta.5 ... 2 years ago
2.1.0-beta.4 ... 2 years ago
2.1.0-beta.3 ... 2 years ago
2.1.0-beta.2 ... 2 years ago
2.1.0-beta.1 ... 2 years ago
2.0.5 ... 2 years ago
2.0.4 ... 2 years ago
2.0.3 ... 2 years ago
2.0.2 ... 2 years ago
2.0.1 ... 2 years ago
2.0.0 ... 2 years ago
2.0.0-beta.13 ... 2 years ago
2.0.0-beta.12 ... 2 years ago
2.0.0-beta.11 ... 2 years ago
2.0.0-beta.10 ... 2 years ago
2.0.0-beta.9 ... 2 years ago
2.0.0-beta.8 ... 2 years ago
2.0.0-beta.7 ... 2 years ago
2.0.0-beta.6 ... 2 years ago
2.0.0-beta.5 ... 2 years ago
2.0.0-beta.4 ... 2 years ago
2.0.0-beta.3 ... 2 years ago
2.0.0-beta.2 ... 2 years ago
2.0.0-beta.1 ... 2 years ago
1.6.0 ... 2 years ago
1.5.3 ... 2 years ago
1.5.2 ... 2 years ago
1.5.1 ... 2 years ago
1.5.0 ... 2 years ago
1.4.0 ... 2 years ago
1.3.1 ... 2 years ago
1.3.0 ... 2 years ago
1.2.2 ... 2 years ago
1.2.1 ... 2 years ago
1.2.0 ... 2 years ago
1.1.3 ... 2 years ago
1.1.2 ... 2 years ago
1.1.1 ... 2 years ago
1.1.0 ... 2 years ago
1.0.4 ... 2 years ago
1.0.3 ... 2 years ago
1.0.2 ... 2 years ago
1.0.1 ... 2 years ago
1.0.0 ... 2 years ago
1.0.0-beta.6 ... 2 years ago
1.0.0-beta.5 ... 2 years ago
1.0.0-beta.4 ... 2 years ago
1.0.0-beta.3 ... 2 years ago
1.0.0-beta.2 ... 2 years ago
1.0.0-beta.1 ... 3 years ago
0.34.7 ... 3 years ago
1.0.0-beta.0 ... 3 years ago
0.34.6 ... 3 years ago
0.34.5 ... 3 years ago
0.34.4 ... 3 years ago
0.34.3 ... 3 years ago
0.34.2 ... 3 years ago
0.34.1 ... 3 years ago
0.34.0 ... 3 years ago
0.33.0 ... 3 years ago
0.32.4 ... 3 years ago
0.32.3 ... 3 years ago
0.32.2 ... 3 years ago
0.32.1 ... 3 years ago
0.32.0 ... 3 years ago
0.31.4 ... 3 years ago
0.31.3 ... 3 years ago
0.31.2 ... 3 years ago
0.31.1 ... 3 years ago
0.31.0 ... 3 years ago
0.30.1 ... 3 years ago
0.30.0 ... 3 years ago