expect-mocha-image-snapshot

A wrapper around jest-image-snapshot that makes it compatible to Mocha. Snapshot testing is very Jest-centered. There are not too many solutions for other testing frameworks to test against snapshots. Even less for image snapshots. There is expect-mocha-snapshot that enables snapshot testing with Mocha and expect. This package uses a similar approach to make jest-image-snapshot Mocha compatible, allowing Mocha users to do image snapshot testing. ## Install

bash
# npm
$ npm install expect-mocha-image-snapshot

# Yarn
$ yarn add expect-mocha-image-snapshot

## Usage

js
import expect from 'expect'
import { toMatchImageSnapshot } from 'expect-mocha-image-snapshot'

expect.extend({ toMatchImageSnapshot })

it('works', async function () {
  ...
  const screenshot = await puppeteer.screenshot()
  expect(screenshot).toMatchImageSnapshot(this) // this is important here
});

Note that it is important to pass this to the matcher because it contains the test metadata. Now you can run mocha as usual:

bash
$ mocha

To update existing snapshots, pass the environment variable SNAPSHOT_UPDATE into the process:

bash
$ SNAPSHOT_UPDATE=true mocha

Additional options can be passed as a second argument (see jest-image-snapshot docs):

js
expect(screenshot).toMatchImageSnapshot(this, { dumpDiffToConsole: true })

It is also possible to configure default options (see jest-image-snapshot docs):

js
import { configureToMatchImageSnapshot } from 'expect-mocha-image-snapshot'

expect.extend({
  toMatchImageSnapshot: configureToMatchImageSnapshot({
    customSnapshotsDir: '__foo_image_snapshots__',
  }),
})

## Contribute Are you missing something or want to contribute? Feel free to file an issue or a pull request! ⚙️ ## Support Hey, I am Sebastian Landwehr, a freelance web developer, and I love developing web apps and open source packages. If you want to support me so that I can keep packages up to date and build more helpful tools, you can donate here:

If you want to send me a one time donation. The coffee is pretty good 😊.
Also for one time donations if you like PayPal.
Here you can support me regularly, which is great so I can steadily work on projects.

Thanks a lot for your support! ❤️

Détail du package

expect-mocha-image-snapshot

readme

expect-mocha-image-snapshot

See also

License