html-snapshots 0.18.3 → 1.0.0

package/examples/custom/package.json

@@ -7,6 +7,6 @@
     "start": "node ./snapshot.js"
   },
   "dependencies": {
-    "html-snapshots": "^0.18.2"
+    "html-snapshots": "^1.0.0"
   }
 }

package/examples/custom/snapshot.js

@@ -5,26 +5,24 @@
  * Use sitemap.xml to snapshot an entire site.
  * Use a customFilter to update the output before the snapshots are written.
  */
-var path = require("path");
-var util = require("util");
-var htmlSnapshots = require("html-snapshots");
+const path = require("path");
+const util = require("util");
+const htmlSnapshots = require("html-snapshots");
 
 htmlSnapshots.run({
   input: "sitemap",
-  source: "http://enigmatic-refuge-9006.herokuapp.com/sitemap.xml",
+  source: "https://sitemaps.org/sitemap.xml",
   outputDir: path.join(__dirname, "./tmp"),
   outputDirClean: true,
-  selector: ".page-content",
+  selector: "#mainContent",
   snapshotScript: {
     script: "customFilter",
     module: path.join(__dirname, "myFilter.js")
   },
-  timeout: 15000
+  timeout: 10000
 })
-.then(function (completed) {
+.then(completed => {
   console.log("completed snapshots:");
   console.log(util.inspect(completed));
 })
-.catch(function (err) {
-  console.error(err);
-});
+.catch(console.error);

package/examples/debug-phantomjs/package-lock.json

@@ -297,9 +297,9 @@
       }
     },
     "html-snapshots": {
-      "version": "0.18.2",
-      "resolved": "https://registry.npmjs.org/html-snapshots/-/html-snapshots-0.18.2.tgz",
-      "integrity": "sha512-92ddr6KWKWZZAcY6sV1dg+LIXYWN4UVFBe4Yumx+hs3U66ecUY3fMtQM72CJhBTA5xrQjzLO6EDhwn8o59zwEg==",
+      "version": "0.18.3",
+      "resolved": "https://registry.npmjs.org/html-snapshots/-/html-snapshots-0.18.3.tgz",
+      "integrity": "sha512-mNEyRLstWDTtP0VZxSu/+86snmWtgeH5ebIeiJXfiaMCjmj8ca+ASE0SSGy0aM63oVhHpXov4nipqCHCjctGQQ==",
       "requires": {
         "async": "3.2.4",
         "async-lock": "1.3.2",
@@ -571,9 +571,9 @@
       "integrity": "sha512-UdA8mJ4weIkUBO224tIarHzuHs4HuYiJvsuGT7j/SPQiUJVjYvNDBIPa0hAorduOfjGohB/qHWRa/lrrWX/mXw=="
     },
     "psl": {
-      "version": "1.8.0",
-      "resolved": "https://registry.npmjs.org/psl/-/psl-1.8.0.tgz",
-      "integrity": "sha512-RIdOzyoavK+hA18OGGWDqUTsCLhtA7IcZ/6NCs4fFJaHBDab+pDDmDIByWFRQJq2Cd7r1OoQxBGKOaztq+hjIQ=="
+      "version": "1.9.0",
+      "resolved": "https://registry.npmjs.org/psl/-/psl-1.9.0.tgz",
+      "integrity": "sha512-E/ZsdU4HLs/68gYzgGTkMicWTLPdAftJLfJFlLUAAKZGkStNU72sZjT66SnMDVOfOWY/YAoiD7Jxa9iHvngcag=="
     },
     "punycode": {
       "version": "2.1.1",

package/examples/debug-phantomjs/package.json

@@ -7,6 +7,6 @@
     "start": "node ./snapshot.js"
   },
   "dependencies": {
-    "html-snapshots": "^0.18.2"
+    "html-snapshots": "^1.0.0"
   }
 }

package/examples/debug-phantomjs/snapshot.js

@@ -8,20 +8,18 @@
  * Demonstrates phantomjsOptions usage on a per-page basis.
  *
  */
-var path = require("path");
-var util = require("util");
-var assert = require("assert");
-var htmlSnapshots = require("html-snapshots");
+const path = require("path");
+const util = require("util");
+const assert = require("assert");
+const htmlSnapshots = require("html-snapshots");
 
 // Assert if NOT an error
 function mustBeError(err) {
   assert.throws(
-    function() {
+    () => {
       assert.ifError(err);
     },
-    function(err) {
-      return !!err;
-    }
+    err => !!err
   );
 }
 
@@ -29,21 +27,22 @@ function mustBeError(err) {
 //  but this also demonstrates the use of phantomjsOptions in the per-page case.
 htmlSnapshots.run({
   input: "sitemap",
-  source: "http://enigmatic-refuge-9006.herokuapp.com/sitemap.xml",
+  source: "https://www.sitemaps.org/sitemap.xml",
   outputDir: path.join(__dirname, "./tmp"),
   outputDirClean: true,
-  selector: ".page-content",
-  timeout: 15000,
+  selector: "#mainContent",
+  timeout: 10000,
+  browser: "phantomjs",
   phantomjsOptions: {
     // The key must exactly match the loc as defined in the sitemap.xml
-    "http://enigmatic-refuge-9006.herokuapp.com:80/hello-world": "--remote-debugger-port=9000"
+    "https://www.sitemaps.org/protocol.html": "--remote-debugger-port=9000"
   }
-}, function (err, completed) {
+}, (err, completed) => {
 
   console.log("completed snapshots:");
   console.log(util.inspect(completed));
 
-  // We expect the hello-world page will timeout because we've held it in the debugger
+  // We expect the protocol.html page will timeout because we've held it in the debugger
   //   It will succeed if you use --remote-debugger-autorun=true
   //   However, the PhantomJS process instances won't exit so that you can (re)debug
   mustBeError(err);

package/examples/debug-puppeteer/README.md

@@ -0,0 +1,18 @@
+# Example
+
+> Run a single page in the puppeteer debugger to see what is going on for a problem snapshot.
+
+> All examples assume you already have NodeJS installed on your local machine
+
+## How To Run
+1. Clone this repo
+2. Open a command prompt
+3. Change to the examples/custom directory
+4. Run `npm install`
+5. Run `npm start`
+
+## What It Does
+This example loads google.com into puppeteer, starts it in headed mode in slow motion with devtools.
+
+## Notes on Interpreting Results
+This example starts headed chrome so you can inspect the page manually using devtools.