@percy/nightwatch 2.0.0-beta.2 → 2.1.0

package/README.md

@@ -7,16 +7,8 @@
 
 ## Installation
 
-Using yarn:
-
 ```sh-session
-$ yarn add --dev @percy/cli @percy/nightwatch@next
-```
-
-Using npm:
-
-```sh-session
-$ npm install --save-dev @percy/cli @percy/nightwatch@next
+$ npm install --save-dev @percy/cli @percy/nightwatch
 ```
 
 ### Nightwatch configuration
@@ -46,7 +38,7 @@ module.exports = {
     browser
       .url('http://example.com')
       .assert.containsText('h1', 'Example Domain')
-      .percySnapshot();
+      .percySnapshot('Example snapshot');
     browser
       .url('http://google.com')
       .assert.elementPresent('img[alt="Google"]')
@@ -107,31 +99,37 @@ OK. 2 assertions passed.
 `percySnapshot([name][, options])`
 
 - `name` - The snapshot name; must be unique to each snapshot
-- `options` - Additional snapshot options (overrides any project options)
-  - `options.widths` - An array of widths to take screenshots at
-  - `options.minHeight` - The minimum viewport height to take screenshots at
-  - `options.percyCSS` - Percy specific CSS only applied in Percy's rendering environment
-  - `options.requestHeaders` - Headers that should be used during asset discovery
-  - `options.enableJavaScript` - Enable JavaScript in Percy's rendering environment
+- `options` - [See per-snapshot configuration options](https://docs.percy.io/docs/cli-configuration#per-snapshot-configuration)
 
 ## Upgrading
 
-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.
+### Automatically with `@percy/migrate`
 
-Using yarn:
+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:
 
-```sh-session
-$ yarn add --dev @percy/cli
+``` shell
+$ npx @percy/migrate
+? Are you currently using @percy/nightwatch? Yes
+? Install @percy/cli (required to run percy)? Yes
+? Migrate Percy config file? Yes
+? Upgrade SDK to @percy/nightwatch@2.0.0? Yes
 ```
 
-Using npm:
+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
 ```
 
-### Migrating Config
+#### 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:

package/commands/percySnapshot.js

@@ -1,5 +1,3 @@
-const utils = require('@percy/sdk-utils');
-
 // Collect client and environment information
 const sdkPkg = require('../package.json');
 const nightwatchPkg = require('nightwatch/package.json');
@@ -9,6 +7,8 @@ const ENV_INFO = `${nightwatchPkg.name}/${nightwatchPkg.version}`;
 // Take a DOM snapshot and post it to the snapshot endpoint
 module.exports = class PercySnapshotCommand {
   async command(name, options) {
+    let utils = await import('@percy/sdk-utils');
+
     if (!(await utils.isPercyEnabled())) return;
     name = name || this.api.currentTest.name;
     let log = utils.logger('nightwatch');
@@ -19,15 +19,18 @@ module.exports = class PercySnapshotCommand {
 
       // Serialize and capture the DOM
       /* istanbul ignore next: no instrumenting injected code */
-      let { value: { domSnapshot, url } } = (
-        await this.api.execute(function(options) {
+      let { domSnapshot, url } = await new Promise((resolve) => {
+        this.api.execute(function(options) {
           return {
             /* eslint-disable-next-line no-undef */
             domSnapshot: PercyDOM.serialize(options),
             url: document.URL
           };
-        }, [options])
-      );
+        }, [options], function(result) {
+          // Check if we're in Nightwatch 1.x (which returns with `.value`)
+          result.value ? resolve(result.value) : resolve(result);
+        });
+      });
 
       // Post the DOM to the snapshot endpoint with snapshot options and other info
       await utils.postSnapshot({

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@percy/nightwatch",
   "description": "Nightwatch client library for visual testing with Percy",
-  "version": "2.0.0-beta.2",
+  "version": "2.1.0",
   "license": "MIT",
   "author": "Perceptual Inc.",
   "repository": "https://github.com/percy/percy-nightwatch",
@@ -16,32 +16,35 @@
     "commands/percySnapshot.js",
     "types/percySnapshot.d.ts"
   ],
+  "engines": {
+    "node": ">=14"
+  },
   "scripts": {
     "lint": "eslint --ignore-path .gitignore .",
-    "test": "nightwatch",
+    "test": "MOZ_HEADLESS=1 nightwatch",
     "test:coverage": "nyc yarn test",
     "test:types": "tsd"
   },
   "dependencies": {
-    "@percy/sdk-utils": "~1.0.0-beta.30"
+    "@percy/sdk-utils": "^1.0.0"
   },
   "peerDependencies": {
-    "nightwatch": "~1"
+    "nightwatch": ">=1"
   },
   "devDependencies": {
-    "@percy/core": "~1.0.0-beta.30",
-    "@types/nightwatch": "^1.3.1",
+    "@percy/core": "^1.0.0",
+    "@types/nightwatch": "^2.0.0",
     "eslint": "^7.11.0",
     "eslint-config-standard": "^16.0.1",
     "eslint-plugin-import": "^2.22.1",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^4.2.1",
+    "eslint-plugin-promise": "^5.1.0",
     "eslint-plugin-standard": "^5.0.0",
-    "expect": "^26.5.3",
-    "geckodriver": "^1.20.0",
-    "mocha": "^8.1.3",
-    "nightwatch": "^1.5.1",
+    "expect": "^27.0.2",
+    "geckodriver": "^3.0.1",
+    "mocha": "^10.0.0",
+    "nightwatch": "^2.1.3",
     "nyc": "^15.1.0",
-    "tsd": "^0.14.0"
+    "tsd": "^0.20.0"
   }
 }