# jest-puppe-shots-preset

> A Jest plugin for creating screenshots of React components with a help of Puppeteer

Latest version **0.7.0** (published 2018-03-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install jest-puppe-shots-preset
pnpm add jest-puppe-shots-preset
yarn add jest-puppe-shots-preset
bun add jest-puppe-shots-preset
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.7.0 |
| Published | 2018-03-09 |
| First published | 2018-03-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 7.6 |
| Dependencies | 1 |
| Unpacked size | 4.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 84 |
| Author | Maciej Adamczak |
| Maintainers | macku |
| Keywords | jest, screenshot, snapshot, testing, unittest, react, enzyme, javascript, visual-regression, visual-testing, matcher, jest-matcher, unit-testing, puppeteer, chrome |

## Links

- npm: https://www.npmjs.com/package/jest-puppe-shots-preset
- Repository: https://github.com/macku/jest-puppe-shots
- Homepage: https://github.com/macku/jest-puppe-shots#readme
- Issues: https://github.com/macku/jest-puppe-shots/issues
- npm.io page: https://npm.io/package/jest-puppe-shots-preset

## Dependencies (1)

- [jest-puppe-shots-env](https://npm.io/package/jest-puppe-shots-env.md) ^0.7.0

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [vest](https://npm.io/package/vest.md) — 50.1K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads

## Recent versions

- 0.7.0 (latest) — 2018-03-09
- 0.5.1 (beta) — 2018-03-05
- 0.6.0 — 2018-03-05
- 0.5.0 — 2018-03-05

## README

jest-puppe-shots-preset
========================

[![NPM version](https://badge.fury.io/js/jest-puppe-shots-preset.svg)](https://www.npmjs.com/package/jest-puppe-shots-preset)
[![node](https://img.shields.io/node/v/jest-puppe-shots-preset.svg)](https://www.npmjs.com/package/jest-puppe-shots-preset)
[![Build Status](https://travis-ci.org/macku/jest-puppe-shots.svg?branch=master)](https://travis-ci.org/macku/jest-puppe-shots)
[![dependencies Status](https://david-dm.org/macku/jest-puppe-shots/status.svg?path=packages/jest-puppe-shots-preset)](https://david-dm.org/macku/jest-puppe-shots?path=packages/jest-puppe-shots-preset)
[![devDependencies Status](https://david-dm.org/macku/jest-puppe-shots/dev-status.svg?path=packages/jest-puppe-shots-preset)](https://david-dm.org/macku/jest-puppe-shots?path=packages/jest-puppe-shots-preset&type=dev)
[![peerDependencies Status](https://david-dm.org/macku/jest-puppe-shots/peer-status.svg?path=packages/jest-puppe-shots-preset)](https://david-dm.org/macku/jest-puppe-shots?path=packages/jest-puppe-shots-preset&type=peer)

A [Jest](https://facebook.github.io/jest/) plugin for creating screenshots of [React](https://reactjs.org/) components with a little help of [Puppeteer](https://github.com/GoogleChrome/puppeteer)

How it works?
=============
This is the [Jest preset](https://facebook.github.io/jest/docs/en/configuration.html#preset-string) for the [`jest-puppe-shots`](https://www.npmjs.com/package/jest-puppe-shots) package.

Check the [README](https://https://github.com/macku/jest-puppe-shots/blob/master/README.md) to get more information how to use the plugin.

Installation
============

You can install the plugin using [**NPM**](https://www.npmjs.com):

```bash
npm install jest-puppe-shots-preset --save-dev
```

or by [**Yarn**](https://yarnpkg.com/):

```bash
yarn add jest-puppe-shots-preset --dev
```

Jest Configuration
==================
Before starting using the `jest-puppe-shots-preset` you will need to change your Jest configuration file.

Open the `jest.config.json` file in your project and add additional entry:

```json
{
  "preset": "jest-puppe-shots-preset"
}
```

If you are are using the `jest.config.js` file, then instead adjust your configuration like this:

```js
module.exports = {
  // You config goes here

  preset: 'jest-puppe-shots-preset'
}
```

---
_Source: https://npm.io/package/jest-puppe-shots-preset · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._