Extract runWatch into separate module (#3930)

Also remove default values from `runWatch` they are already set by `runMocha`.
mochajs · May 25, 2019 · 29b7615 · 29b7615
1 parent a758154
commit 29b7615
Show file tree

Hide file tree

Showing 2 changed files with 111 additions and 99 deletions.
diff --git a/lib/cli/run-helpers.js b/lib/cli/run-helpers.js
@@ -12,12 +12,13 @@ const path = require('path');
 const ansi = require('ansi-colors');
 const debug = require('debug')('mocha:cli:run:helpers');
 const minimatch = require('minimatch');
-const Context = require('../context');
-const Mocha = require('../mocha');
 const utils = require('../utils');
+const watchRun = require('./watch-run');
 
 const cwd = (exports.cwd = process.cwd());
 
+exports.watchRun = watchRun;
+
 /**
  * Exits Mocha when tests + code under test has finished execution (default)
  * @param {number} code - Exit code; typically # of failures
@@ -65,32 +66,6 @@ const exitMocha = code => {
   done();
 };
 
-/**
- * Hide the cursor.
- * @ignore
- * @private
- */
-const hideCursor = () => {
-  process.stdout.write('\u001b[?25l');
-};
-
-/**
- * Show the cursor.
- * @ignore
- * @private
- */
-const showCursor = () => {
-  process.stdout.write('\u001b[?25h');
-};
-
-/**
- * Stop cursor business
- * @private
- */
-const stop = () => {
-  process.stdout.write('\u001b[2K');
-};
-
 /**
  * Coerce a comma-delimited string (or array thereof) into a flattened array of
  * strings
@@ -207,76 +182,6 @@ exports.singleRun = (mocha, {files = [], exit = false} = {}) => {
   return mocha.run(exit ? exitMocha : exitMochaLater);
 };
 
-/**
- * Run Mocha in "watch" mode
- * @param {Mocha} mocha - Mocha instance
- * @param {Object} [opts] - Options
- * @param {string[]} [opts.extension] - List of extensions to watch
- * @param {string|RegExp} [opts.grep] - Grep for test titles
- * @param {string} [opts.ui=bdd] - User interface
- * @param {string[]} [files] - Array of test files
- * @private
- */
-exports.watchRun = (
-  mocha,
-  {extension = [], grep = '', ui = 'bdd', files = []} = {}
-) => {
-  let runner;
-
-  console.log();
-  hideCursor();
-  process.on('SIGINT', () => {
-    showCursor();
-    console.log('\n');
-    process.exit(130);
-  });
-
-  const watchFiles = utils.files(cwd, extension);
-  let runAgain = false;
-
-  const loadAndRun = () => {
-    try {
-      mocha.files = files;
-      runAgain = false;
-      runner = mocha.run(() => {
-        runner = null;
-        if (runAgain) {
-          rerun();
-        }
-      });
-    } catch (e) {
-      console.log(e.stack);
-    }
-  };
-
-  const purge = () => {
-    watchFiles.forEach(Mocha.unloadFile);
-  };
-
-  loadAndRun();
-
-  const rerun = () => {
-    purge();
-    stop();
-    if (!grep) {
-      mocha.grep(null);
-    }
-    mocha.suite = mocha.suite.clone();
-    mocha.suite.ctx = new Context();
-    mocha.ui(ui);
-    loadAndRun();
-  };
-
-  utils.watch(watchFiles, () => {
-    runAgain = true;
-    if (runner) {
-      runner.abort();
-    } else {
-      rerun();
-    }
-  });
-};
-
 /**
  * Actually run tests
  * @param {Mocha} mocha - Mocha instance
@@ -295,7 +200,7 @@ exports.runMocha = (
   files = []
 ) => {
   if (watch) {
-    exports.watchRun(mocha, {extension, grep, ui, files});
+    watchRun(mocha, {extension, grep, ui, files});
   } else {
     exports.singleRun(mocha, {files, exit});
   }

diff --git a/lib/cli/watch-run.js b/lib/cli/watch-run.js
@@ -0,0 +1,107 @@
+'use strict';
+
+const utils = require('../utils');
+const Context = require('../context');
+const Mocha = require('../mocha');
+
+/**
+ * Exports the `watchRun` function that runs mocha in "watch" mode.
+ * @see module:lib/cli/run-helpers
+ * @module
+ * @private
+ */
+
+/**
+ * Run Mocha in "watch" mode
+ * @param {Mocha} mocha - Mocha instance
+ * @param {Object} opts - Options
+ * @param {string[]} opts.extension - List of extensions to watch
+ * @param {string|RegExp} opts.grep - Grep for test titles
+ * @param {string} opts.ui - User interface
+ * @param {string[]} opts.files - Array of test files
+ * @private
+ */
+module.exports = (mocha, {extension, grep, ui, files}) => {
+  let runner;
+
+  console.log();
+  hideCursor();
+  process.on('SIGINT', () => {
+    showCursor();
+    console.log('\n');
+    // By UNIX/Posix convention this indicates that the process was
+    // killed by SIGINT which has portable number 2.
+    process.exit(128 + 2);
+  });
+
+  const watchFiles = utils.files(process.cwd(), extension);
+  let runAgain = false;
+
+  const loadAndRun = () => {
+    try {
+      mocha.files = files;
+      runAgain = false;
+      runner = mocha.run(() => {
+        runner = null;
+        if (runAgain) {
+          rerun();
+        }
+      });
+    } catch (e) {
+      console.log(e.stack);
+    }
+  };
+
+  const purge = () => {
+    watchFiles.forEach(Mocha.unloadFile);
+  };
+
+  loadAndRun();
+
+  const rerun = () => {
+    purge();
+    eraseLine();
+    if (!grep) {
+      mocha.grep(null);
+    }
+    mocha.suite = mocha.suite.clone();
+    mocha.suite.ctx = new Context();
+    mocha.ui(ui);
+    loadAndRun();
+  };
+
+  utils.watch(watchFiles, () => {
+    runAgain = true;
+    if (runner) {
+      runner.abort();
+    } else {
+      rerun();
+    }
+  });
+};
+
+/**
+ * Hide the cursor.
+ * @ignore
+ * @private
+ */
+const hideCursor = () => {
+  process.stdout.write('\u001b[?25l');
+};
+
+/**
+ * Show the cursor.
+ * @ignore
+ * @private
+ */
+const showCursor = () => {
+  process.stdout.write('\u001b[?25h');
+};
+
+/**
+ * Erases the line on stdout
+ * @private
+ */
+const eraseLine = () => {
+  process.stdout.write('\u001b[2K');
+};