https://github.com/percy/percy-nightmare
Visual testing with Nightmare and Percy
https://github.com/percy/percy-nightmare
nightmare percy percy-sdk selenium visual-regression-testing visual-testing visual-tests
Last synced: 4 months ago
JSON representation
Visual testing with Nightmare and Percy
- Host: GitHub
- URL: https://github.com/percy/percy-nightmare
- Owner: percy
- License: mit
- Created: 2018-10-24T00:11:32.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2025-08-25T16:58:20.000Z (5 months ago)
- Last Synced: 2025-08-28T14:48:51.995Z (5 months ago)
- Topics: nightmare, percy, percy-sdk, selenium, visual-regression-testing, visual-testing, visual-tests
- Language: JavaScript
- Homepage: https://percy.io
- Size: 1.4 MB
- Stars: 1
- Watchers: 9
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# @percy/nightmare
[](https://www.npmjs.com/package/@percy/nightmare)
[Percy](https://percy.io) visual testing for [Nightmare](https://www.nightmarejs.org).
## Installation
```sh-session
$ npm install --save-dev @percy/cli @percy/nightmare
```
## Usage
This is an example using the `percySnapshot` function.
```javascript
const Nightmare = require('nightmare');
const percySnapshot = require('@percy/nightmare);
Nightmare()
.goto('http://example.com')
//... other actions ...
.use(percySnapshot('Example Snapshot'))
//... more actions ...
.end()
.then(() => {
// ...
})
```
Running the code above directly will result in the following logs:
```sh-session
$ node script.js
[percy] Percy is not running, disabling snapshots
```
When running with [`percy
exec`](https://github.com/percy/cli/tree/master/packages/cli-exec#percy-exec), and your project's
`PERCY_TOKEN`, a new Percy build will be created and snapshots will be uploaded to your project.
```sh-session
$ export PERCY_TOKEN=[your-project-token]
$ percy exec -- node script.js
[percy] Percy has started!
[percy] Created build #1: https://percy.io/[your-project]
[percy] Running "node script.js"
[percy] Snapshot taken "Example Snapshot"
[percy] Stopping percy...
[percy] Finalized build #1: https://percy.io/[your-project]
[percy] Done!
```
## Configuration
`percySnapshot(name[, options])`
- `name` (**required**) - The snapshot name; must be unique to each snapshot
- `options` - [See per-snapshot configuration options](https://www.browserstack.com/docs/percy/take-percy-snapshots/overview#per-snapshot-configuration)
## Upgrading
### Automatically with `@percy/migrate`
We built a tool to help automate migrating to the new CLI toolchain! Migrating
can be done by running the following commands and following the prompts:
``` shell
$ npx @percy/migrate
? Are you currently using @percy/nightmare? Yes
? Install @percy/cli (required to run percy)? Yes
? Migrate Percy config file? Yes
? Upgrade SDK to @percy/nightmare@2.0.0? Yes
```
This will automatically run the changes described below for you.
### Manually
#### Installing `@percy/cli`
If you're coming from a pre-2.0 version of this package, make sure to install `@percy/cli` after
upgrading to retain any existing scripts that reference the Percy CLI command.
```sh-session
$ npm install --save-dev @percy/cli
```
#### Import change
If you're coming from a pre-2.0 version of this package, the `percySnapshot` function is now the default
export.
```javascript
// before
const { percySnapshot } = require('@percy/nightmare');
// after
const percySnapshot = require('@percy/nightmare');
```
#### Migrating Config
If you have a previous Percy configuration file, migrate it to the newest version with the
[`config:migrate`](https://github.com/percy/cli/tree/master/packages/cli-config#percy-configmigrate-filepath-output) command:
```sh-session
$ percy config:migrate
```