❤
npm
Sign UpSign In

react-snappy

0.2.6 • Public • Published

react-snappy

utility for testing react components against html snapshots

install

npm i react-snappy -D

check

Compares render output to the snapshot, if not the same prints out a coloured diff and throws an error.

import snappy from 'react-snappy';
 
snappy.check(<YourComponent/>);

save

Saves the html snapshot in the folder ./snapshots relative to running process current working driectory. You can override this using setFolder. Use when you want to add a new component check. Then rewrite to check. Alternatively you can set envromental variable SNAPPY_SAVE_ALL to force every check into a save globally. Use with caution.

snappy.save(<YourComponent/>);

setFolder

just sets the folder, where snappy will save/look for snapshots. Default value is snapshots and it is always relative to the process's current working directory. This is convenient in ava, where each test file has it's own process.

snappy.setFolder('./mySpecialSnapshotFolder')

jsdom

reinitialize jsdom, html can be any valid html

snappy.jsdom(html)

setColors

set colors for diffs

const chalk = require('chalk')
 
snappy.setColors({
  added: chalk.red,
  removed: chalk.green
})  // this is the default

jsdom and babel

Enzyme's mount is used for rendering under the hood, so you need to have document and window on global scope-react snappy creates this for you like this:

const doc = jsdom.jsdom('<html><head></head><body></body></html>')
const win = doc.defaultView
global.document = doc
global.window = win

If you ever need something else in your jsdom, feel free to use the method jsdom or just manually rewrite values on global.

If you use ava, best practice is in your package.json:

"ava": {
  "require": [
    "babel-register"
  ],
  "babel": "inherit"
}

so that you have the same babel settings as in your app(.babelrc).

Readme

Keywords

Package Sidebar

Install

npm i react-snappy

Repository

github.com/capaj/react-snappy

Homepage

github.com/capaj/react-snappy#readme

Weekly Downloads

0

Version

0.2.6

License

MIT

Last publish

Collaborators

  • capaj
Try on RunKit
Report malware