html-snapshots 1.7.0 → 1.8.0

package/lib/html-snapshots.js

@@ -13,9 +13,8 @@
 const spawn = require("child_process").spawn;
 const path = require("path");
 const EventEmitter = require("events").EventEmitter;
-const rimraf = require("rimraf").sync;
+const fs = require("fs");
 const asyncLib = require("async");
-
 const common = require("./common");
 const inputFactory = require("./input-generators");
 const Notifier = require("./async").Notifier;
@@ -239,83 +238,85 @@ function prepOptions (options) {
   }
 }
 
-module.exports = {
-  /**
-   * Run all the snapshots using the requested inputGenerator
-   *
-   * @param {Object} options - ALL user supplied html snapshots options.
-   * @param {String} options.outputDir - Directory to write the html files to.
-   * @param {String} [options.input] - Input source type "robots", "sitemap", "array";
-   * Defaults to "robots".
-   * @param {Boolean} [options.outputDirClean] - True if output dir should be rm -rf;
-   * Defaults to false.
-   * @param {Number} [options.pollInterval] -
-   * @param {Function} [listener] - User supplied optional callback.
-   * @returns {Promise} Resolves on completion.
-   */
-  run: function (options, listener) {
-    options = options || {};
-    prepOptions(options);
-
-    // create the inputGenerator, default to robots
-    const inputGenerator = inputFactory.create(options.input);
-
-    // clean the snapshot output directory
-    if (options.outputDirClean) {
-      rimraf(options.outputDir);
-    }
+/**
+ * Run all the snapshots using the requested inputGenerator
+ *
+ * @param {Object} options - ALL user supplied html snapshots options.
+ * @param {String} options.outputDir - Directory to write the html files to.
+ * @param {String} [options.input] - Input source type "robots", "sitemap", "array";
+ * Defaults to "robots".
+ * @param {Boolean} [options.outputDirClean] - True if output dir should be rm -rf;
+ * Defaults to false.
+ * @param {Number} [options.pollInterval] -
+ * @param {Function} [listener] - User supplied optional callback.
+ * @returns {Promise} Resolves on completion.
+ */
+function run (options, listener) {
+  options = options || {};
+  prepOptions(options);
 
-    // start async completion notification.
-    const notifier = new Notifier();
-    const emitter = new EventEmitter();
-    const started = notifier.start(
-      options.pollInterval,
-      inputGenerator,
-      (err, completed) => emitter.emit("complete", err, completed)
-    );
+  // clean the snapshot output directory
+  if (options.outputDirClean) {
+    fs.rmSync(options.outputDir, { recursive: true, force: true });
+  }
 
-    if (started) {
-      // create the completion Promise.
-      const completion = new Promise((resolve, reject) => {
-        function completionResolver (err, completed) {
-          try {
-            common.isFunction(listener) && listener(err, completed);
-          } catch (e) {
-            console.error("User supplied listener exception", e);
-          }
-          if (err) {
-            err.notCompleted = notifier.filesNotDone;
-            err.completed = completed;
-            reject(err);
-          } else {
-            resolve(completed);
-          }
+  // create the inputGenerator, default to robots
+  const inputGenerator = inputFactory.create(options.input);
+
+  // start async completion notification.
+  const notifier = new Notifier();
+  const emitter = new EventEmitter();
+  const started = notifier.start(
+    options.pollInterval,
+    inputGenerator,
+    (err, completed) => emitter.emit("complete", err, completed)
+  );
+
+  if (started) {
+    // create the completion Promise.
+    const completion = new Promise((resolve, reject) => {
+      function completionResolver (err, completed) {
+        try {
+          common.isFunction(listener) && listener(err, completed);
+        } catch (e) {
+          console.error("User supplied listener exception", e);
+        }
+        if (err) {
+          err.notCompleted = notifier.filesNotDone;
+          err.completed = completed;
+          reject(err);
+        } else {
+          resolve(completed);
         }
-        emitter.addListener("complete", completionResolver);
-      });
+      }
+      emitter.addListener("complete", completionResolver);
+    });
 
-      // create a worker queue with a parallel process limit.
-      const q = asyncLib.queue(
-        (task, callback) => { task(common.once(callback)); },
-        options.processLimit
-      );
+    // create a worker queue with a parallel process limit.
+    const q = asyncLib.queue(
+      (task, callback) => { task(common.once(callback)); },
+      options.processLimit
+    );
 
-      // have the queue call notifier.empty when last item
-      //  from the queue is given to a worker.
-      q.empty(notifier.qEmpty.bind(notifier));
+    // have the queue call notifier.empty when last item
+    //  from the queue is given to a worker.
+    q.empty(notifier.qEmpty.bind(notifier));
 
-      // expose abort callback to input generators via options.
-      options._abort = notifier.abort.bind(notifier, q);
+    // expose abort callback to input generators via options.
+    options._abort = notifier.abort.bind(notifier, q);
 
-      const worker =
-        options.browser === 'puppeteer' ? puppeteerWorker : phantomjsWorker;
+    const worker =
+      options.browser === 'puppeteer' ? puppeteerWorker : phantomjsWorker;
 
-      // generate input for the snapshots.
-      return inputGenerator.run(options, input => {
-        q.push(worker.bind(worker, input, options, notifier));
-      }).then(() => completion)
-    }
-    
-    return Promise.reject("failed to start async notifier");
+    // generate input for the snapshots.
+    return inputGenerator.run(options, input => {
+      q.push(worker.bind(worker, input, options, notifier));
+    }).then(() => completion)
   }
+  
+  return Promise.reject("failed to start async notifier");
+}
+
+module.exports = {
+  run
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "html-snapshots",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "author": {
     "name": "Alex Grant",
     "email": "alex@localnerve.com",
@@ -58,12 +58,11 @@
     "combine-errors": "3.0.3",
     "got": "12.5.3",
     "phantomjs-prebuilt": "2.1.16",
-    "puppeteer": "^19.5.0",
-    "rimraf": "3.0.2",
+    "puppeteer": "^19.6.0",
     "xml2js": "0.4.23"
   },
   "devDependencies": {
-    "eslint": "8.31.0",
+    "eslint": "8.32.0",
     "express": "4.18.2",
     "mocha": "10.2.0",
     "c8": "7.12.0",