Awesome
Jest Specific Snapshot
Jest matcher for multiple snapshot files per test
<b>You can read about the implementation here</b>
Installation
npm i -D jest-specific-snapshot
Example
const path = require('path');
// extend jest to have 'toMatchSpecificSnapshot' matcher
require('jest-specific-snapshot');
test('test', () => {
// provides snapshot file with absolute file
const pathToSnap = path.resolve(process.cwd(), './example/specific/dir/my.shot');
expect(100).toMatchSpecificSnapshot(pathToSnap);
//same snapshot but with relative file
expect(14).toMatchSpecificSnapshot('./specific/dir/my.shot');
// another snapshot file in the same test
expect(19).toMatchSpecificSnapshot('./specific/another_dir/another.shot');
});
With Custom Serializer
// extend jest to have 'toMatchSpecificSnapshot' matcher
const addSerializer = require('jest-specific-snapshot').addSerializer;
addSerializer(/* Add custom serializer here */);
test('test', () => {
expect(/* thing that matches the custom serializer */).toMatchSpecificSnapshot(
'./specific/custom_serializer/test.shot'
);
});
Extend toMatchSpecificSnapshot
const toMatchSpecificSnapshot = require('jest-specific-snapshot').toMatchSpecificSnapshot;
expect.extend({
toMatchDecoratedSpecificSnapshot(received, snapshotFile) {
// You can modify received data or create dynamic snapshot path
const data = doSomeThing(received);
return toMatchSpecificSnapshot.call(this, data, snapshotFile);
},
});
Limitations
- Snapshot files should have an extension other than
.snap
, since it conflicts with jest. - In order to handle the
--updateSnapshot
(-u
) parameter provided from CLI, there is an abuse of theSnapshotState._updateSnapshot
private field. TBD - try to use theglobalConfig
to get this state. .toMatchSpecificSnapshot
does ignore a custom serializers strategy. In order to support custom serializers, you should use theaddSerializer
method explicitly.