@nates/snapshot

snapshot test for javascript

Install

npm install @nates/snapshot

Usage

A simple setup is required for auto snapshot key, see mocha example

set SNAPSHOT_UPDATE env var to true to update existed snapshot file.

import snapshot from '@nates/snapshot';

const value = { a: 1 };

// basic
await snapshot.match(value); // throw error if value not match previous run

// store snapshot file as json
await snapshot.matchJSON(value);

// use different snapshot file
await snapshot.matchJSON(value, { key: snapshot.getKey('second') });

// clean dynamic data
await snapshot.match(new Date(), {
  clean: (v) => v.replace(/(?<="\$Date": ").+(?=")/g, snapshot.maskString),
});

Implementation for other language

• Go