mocha 5.0.4 → 5.2.0

package/lib/reporters/html.js

@@ -1,7 +1,9 @@
 'use strict';
 
 /* eslint-env browser */
-
+/**
+ * @module HTML
+ */
 /**
  * Module dependencies.
  */
@@ -34,7 +36,8 @@ exports = module.exports = HTML;
  * Stats template.
  */
 
-var statsTemplate = '<ul id="mocha-stats">' +
+var statsTemplate =
+  '<ul id="mocha-stats">' +
   '<li class="progress"><canvas width="40" height="40"></canvas></li>' +
   '<li class="passes"><a href="javascript:void(0);">passes:</a> <em>0</em></li>' +
   '<li class="failures"><a href="javascript:void(0);">failures:</a> <em>0</em></li>' +
@@ -46,10 +49,14 @@ var playIcon = '&#x2023;';
 /**
  * Initialize a new `HTML` reporter.
  *
+ * @public
+ * @class
+ * @memberof Mocha.reporters
+ * @extends Mocha.reporters.Base
  * @api public
  * @param {Runner} runner
  */
-function HTML (runner) {
+function HTML(runner) {
   Base.call(this, runner);
 
   var self = this;
@@ -84,10 +91,10 @@ function HTML (runner) {
   }
 
   // pass toggle
-  on(passesLink, 'click', function (evt) {
+  on(passesLink, 'click', function(evt) {
     evt.preventDefault();
     unhide();
-    var name = (/pass/).test(report.className) ? '' : ' pass';
+    var name = /pass/.test(report.className) ? '' : ' pass';
     report.className = report.className.replace(/fail|pass/g, '') + name;
     if (report.className.trim()) {
       hideSuitesWithout('test pass');
@@ -95,10 +102,10 @@ function HTML (runner) {
   });
 
   // failure toggle
-  on(failuresLink, 'click', function (evt) {
+  on(failuresLink, 'click', function(evt) {
     evt.preventDefault();
     unhide();
-    var name = (/fail/).test(report.className) ? '' : ' fail';
+    var name = /fail/.test(report.className) ? '' : ' fail';
     report.className = report.className.replace(/fail|pass/g, '') + name;
     if (report.className.trim()) {
       hideSuitesWithout('test fail');
@@ -112,14 +119,18 @@ function HTML (runner) {
     progress.size(40);
   }
 
-  runner.on('suite', function (suite) {
+  runner.on('suite', function(suite) {
     if (suite.root) {
       return;
     }
 
     // suite
     var url = self.suiteURL(suite);
-    var el = fragment('<li class="suite"><h1><a href="%s">%s</a></h1></li>', url, escape(suite.title));
+    var el = fragment(
+      '<li class="suite"><h1><a href="%s">%s</a></h1></li>',
+      url,
+      escape(suite.title)
+    );
 
     // container
     stack[0].appendChild(el);
@@ -127,7 +138,7 @@ function HTML (runner) {
     el.appendChild(stack[0]);
   });
 
-  runner.on('suite end', function (suite) {
+  runner.on('suite end', function(suite) {
     if (suite.root) {
       updateStats();
       return;
@@ -135,19 +146,27 @@ function HTML (runner) {
     stack.shift();
   });
 
-  runner.on('pass', function (test) {
+  runner.on('pass', function(test) {
     var url = self.testURL(test);
-    var markup = '<li class="test pass %e"><h2>%e<span class="duration">%ems</span> ' +
-      '<a href="%s" class="replay">' + playIcon + '</a></h2></li>';
+    var markup =
+      '<li class="test pass %e"><h2>%e<span class="duration">%ems</span> ' +
+      '<a href="%s" class="replay">' +
+      playIcon +
+      '</a></h2></li>';
     var el = fragment(markup, test.speed, test.title, test.duration, url);
     self.addCodeToggle(el, test.body);
     appendToStack(el);
     updateStats();
   });
 
-  runner.on('fail', function (test) {
-    var el = fragment('<li class="test fail"><h2>%e <a href="%e" class="replay">' + playIcon + '</a></h2></li>',
-      test.title, self.testURL(test));
+  runner.on('fail', function(test) {
+    var el = fragment(
+      '<li class="test fail"><h2>%e <a href="%e" class="replay">' +
+        playIcon +
+        '</a></h2></li>',
+      test.title,
+      self.testURL(test)
+    );
     var stackString; // Note: Includes leading newline
     var message = test.err.toString();
 
@@ -162,7 +181,9 @@ function HTML (runner) {
       if (indexOfMessage === -1) {
         stackString = test.err.stack;
       } else {
-        stackString = test.err.stack.substr(test.err.message.length + indexOfMessage);
+        stackString = test.err.stack.substr(
+          test.err.message.length + indexOfMessage
+        );
       }
     } else if (test.err.sourceURL && test.err.line !== undefined) {
       // Safari doesn't give you a stack. Let's at least provide a source line.
@@ -172,12 +193,21 @@ function HTML (runner) {
     stackString = stackString || '';
 
     if (test.err.htmlMessage && stackString) {
-      el.appendChild(fragment('<div class="html-error">%s\n<pre class="error">%e</pre></div>',
-        test.err.htmlMessage, stackString));
+      el.appendChild(
+        fragment(
+          '<div class="html-error">%s\n<pre class="error">%e</pre></div>',
+          test.err.htmlMessage,
+          stackString
+        )
+      );
     } else if (test.err.htmlMessage) {
-      el.appendChild(fragment('<div class="html-error">%s</div>', test.err.htmlMessage));
+      el.appendChild(
+        fragment('<div class="html-error">%s</div>', test.err.htmlMessage)
+      );
     } else {
-      el.appendChild(fragment('<pre class="error">%e%e</pre>', message, stackString));
+      el.appendChild(
+        fragment('<pre class="error">%e%e</pre>', message, stackString)
+      );
     }
 
     self.addCodeToggle(el, test.body);
@@ -185,22 +215,25 @@ function HTML (runner) {
     updateStats();
   });
 
-  runner.on('pending', function (test) {
-    var el = fragment('<li class="test pass pending"><h2>%e</h2></li>', test.title);
+  runner.on('pending', function(test) {
+    var el = fragment(
+      '<li class="test pass pending"><h2>%e</h2></li>',
+      test.title
+    );
     appendToStack(el);
     updateStats();
   });
 
-  function appendToStack (el) {
+  function appendToStack(el) {
     // Don't call .appendChild if #mocha-report was already .shift()'ed off the stack.
     if (stack[0]) {
       stack[0].appendChild(el);
     }
   }
 
-  function updateStats () {
+  function updateStats() {
     // TODO: add to stats
-    var percent = stats.tests / runner.total * 100 | 0;
+    var percent = (stats.tests / runner.total * 100) | 0;
     if (progress) {
       progress.update(percent).draw(ctx);
     }
@@ -219,7 +252,7 @@ function HTML (runner) {
  * @param {string} s
  * @return {string} A new URL.
  */
-function makeUrl (s) {
+function makeUrl(s) {
   var search = window.location.search;
 
   // Remove previous grep query parameter if present
@@ -227,7 +260,12 @@ function makeUrl (s) {
     search = search.replace(/[?&]grep=[^&\s]*/g, '').replace(/^&/, '?');
   }
 
-  return window.location.pathname + (search ? search + '&' : '?') + 'grep=' + encodeURIComponent(escapeRe(s));
+  return (
+    window.location.pathname +
+    (search ? search + '&' : '?') +
+    'grep=' +
+    encodeURIComponent(escapeRe(s))
+  );
 }
 
 /**
@@ -235,7 +273,7 @@ function makeUrl (s) {
  *
  * @param {Object} [suite]
  */
-HTML.prototype.suiteURL = function (suite) {
+HTML.prototype.suiteURL = function(suite) {
   return makeUrl(suite.fullTitle());
 };
 
@@ -244,7 +282,7 @@ HTML.prototype.suiteURL = function (suite) {
  *
  * @param {Object} [test]
  */
-HTML.prototype.testURL = function (test) {
+HTML.prototype.testURL = function(test) {
   return makeUrl(test.fullTitle());
 };
 
@@ -254,10 +292,10 @@ HTML.prototype.testURL = function (test) {
  * @param {HTMLLIElement} el
  * @param {string} contents
  */
-HTML.prototype.addCodeToggle = function (el, contents) {
+HTML.prototype.addCodeToggle = function(el, contents) {
   var h2 = el.getElementsByTagName('h2')[0];
 
-  on(h2, 'click', function () {
+  on(h2, 'click', function() {
     pre.style.display = pre.style.display === 'none' ? 'block' : 'none';
   });
 
@@ -271,7 +309,7 @@ HTML.prototype.addCodeToggle = function (el, contents) {
  *
  * @param {string} msg
  */
-function error (msg) {
+function error(msg) {
   document.body.appendChild(fragment('<div id="mocha-error">%s</div>', msg));
 }
 
@@ -280,15 +318,17 @@ function error (msg) {
  *
  * @param {string} html
  */
-function fragment (html) {
+function fragment(html) {
   var args = arguments;
   var div = document.createElement('div');
   var i = 1;
 
-  div.innerHTML = html.replace(/%([se])/g, function (_, type) {
+  div.innerHTML = html.replace(/%([se])/g, function(_, type) {
     switch (type) {
-      case 's': return String(args[i++]);
-      case 'e': return escape(args[i++]);
+      case 's':
+        return String(args[i++]);
+      case 'e':
+        return escape(args[i++]);
       // no default
     }
   });
@@ -302,7 +342,7 @@ function fragment (html) {
  *
  * @param {text} classname
  */
-function hideSuitesWithout (classname) {
+function hideSuitesWithout(classname) {
   var suites = document.getElementsByClassName('suite');
   for (var i = 0; i < suites.length; i++) {
     var els = suites[i].getElementsByClassName(classname);
@@ -315,7 +355,7 @@ function hideSuitesWithout (classname) {
 /**
  * Unhide .hidden suites.
  */
-function unhide () {
+function unhide() {
   var els = document.getElementsByClassName('suite hidden');
   for (var i = 0; i < els.length; ++i) {
     els[i].className = els[i].className.replace('suite hidden', 'suite');
@@ -328,7 +368,7 @@ function unhide () {
  * @param {HTMLElement} el
  * @param {string} contents
  */
-function text (el, contents) {
+function text(el, contents) {
   if (el.textContent) {
     el.textContent = contents;
   } else {
@@ -339,7 +379,7 @@ function text (el, contents) {
 /**
  * Listen on `event` with callback `fn`.
  */
-function on (el, event, fn) {
+function on(el, event, fn) {
   if (el.addEventListener) {
     el.addEventListener(event, fn, false);
   } else {

package/lib/reporters/json-stream.js

@@ -1,5 +1,7 @@
 'use strict';
-
+/**
+ * @module JSONStream
+ */
 /**
  * Module dependencies.
  */
@@ -13,33 +15,38 @@ var Base = require('./base');
 exports = module.exports = List;
 
 /**
- * Initialize a new `List` test reporter.
+ * Initialize a new `JSONStream` test reporter.
  *
+ * @public
+ * @name JSONStream
+ * @class JSONStream
+ * @memberof Mocha.reporters
+ * @extends Mocha.reporters.Base
  * @api public
  * @param {Runner} runner
  */
-function List (runner) {
+function List(runner) {
   Base.call(this, runner);
 
   var self = this;
   var total = runner.total;
 
-  runner.on('start', function () {
-    console.log(JSON.stringify(['start', { total: total }]));
+  runner.on('start', function() {
+    console.log(JSON.stringify(['start', {total: total}]));
   });
 
-  runner.on('pass', function (test) {
+  runner.on('pass', function(test) {
     console.log(JSON.stringify(['pass', clean(test)]));
   });
 
-  runner.on('fail', function (test, err) {
+  runner.on('fail', function(test, err) {
     test = clean(test);
     test.err = err.message;
     test.stack = err.stack || null;
     console.log(JSON.stringify(['fail', test]));
   });
 
-  runner.once('end', function () {
+  runner.once('end', function() {
     process.stdout.write(JSON.stringify(['end', self.stats]));
   });
 }
@@ -52,7 +59,7 @@ function List (runner) {
  * @param {Object} test
  * @return {Object}
  */
-function clean (test) {
+function clean(test) {
   return {
     title: test.title,
     fullTitle: test.fullTitle(),

package/lib/reporters/json.js

@@ -1,5 +1,7 @@
 'use strict';
-
+/**
+ * @module JSON
+ */
 /**
  * Module dependencies.
  */
@@ -15,10 +17,14 @@ exports = module.exports = JSONReporter;
 /**
  * Initialize a new `JSON` reporter.
  *
+ * @public
+ * @class JSON
+ * @memberof Mocha.reporters
+ * @extends Mocha.reporters.Base
  * @api public
  * @param {Runner} runner
  */
-function JSONReporter (runner) {
+function JSONReporter(runner) {
   Base.call(this, runner);
 
   var self = this;
@@ -27,23 +33,23 @@ function JSONReporter (runner) {
   var failures = [];
   var passes = [];
 
-  runner.on('test end', function (test) {
+  runner.on('test end', function(test) {
     tests.push(test);
   });
 
-  runner.on('pass', function (test) {
+  runner.on('pass', function(test) {
     passes.push(test);
   });
 
-  runner.on('fail', function (test) {
+  runner.on('fail', function(test) {
     failures.push(test);
   });
 
-  runner.on('pending', function (test) {
+  runner.on('pending', function(test) {
     pending.push(test);
   });
 
-  runner.once('end', function () {
+  runner.once('end', function() {
     var obj = {
       stats: self.stats,
       tests: tests.map(clean),
@@ -66,26 +72,55 @@ function JSONReporter (runner) {
  * @param {Object} test
  * @return {Object}
  */
-function clean (test) {
+function clean(test) {
+  var err = test.err || {};
+  if (err instanceof Error) {
+    err = errorJSON(err);
+  }
+
   return {
     title: test.title,
     fullTitle: test.fullTitle(),
     duration: test.duration,
     currentRetry: test.currentRetry(),
-    err: errorJSON(test.err || {})
+    err: cleanCycles(err)
   };
 }
 
 /**
- * Transform `error` into a JSON object.
+ * Replaces any circular references inside `obj` with '[object Object]'
+ *
+ * @api private
+ * @param {Object} obj
+ * @return {Object}
+ */
+function cleanCycles(obj) {
+  var cache = [];
+  return JSON.parse(
+    JSON.stringify(obj, function(key, value) {
+      if (typeof value === 'object' && value !== null) {
+        if (cache.indexOf(value) !== -1) {
+          // Instead of going in a circle, we'll print [object Object]
+          return '' + value;
+        }
+        cache.push(value);
+      }
+
+      return value;
+    })
+  );
+}
+
+/**
+ * Transform an Error object into a JSON object.
  *
  * @api private
  * @param {Error} err
  * @return {Object}
  */
-function errorJSON (err) {
+function errorJSON(err) {
   var res = {};
-  Object.getOwnPropertyNames(err).forEach(function (key) {
+  Object.getOwnPropertyNames(err).forEach(function(key) {
     res[key] = err[key];
   }, err);
   return res;

package/lib/reporters/json.js.orig

@@ -0,0 +1,128 @@
+'use strict';
+
+/**
+ * Module dependencies.
+ */
+
+var Base = require('./base');
+
+/**
+ * Expose `JSON`.
+ */
+
+exports = module.exports = JSONReporter;
+
+/**
+ * Initialize a new `JSON` reporter.
+ *
+ * @api public
+ * @param {Runner} runner
+ * @param {options} mocha invocation options. Invoking
+ *   `mocha -R --reporter-options output-file=asdf` yields options like:
+ *   { ... reporterOptions: { "output-file": "asdf" } ... }
+ */
+function JSONReporter (runner, options) {
+<<<<<<< HEAD
+=======
+  options = options || {};
+  var reptOptions = options.reporterOptions || {};
+>>>>>>> + json ouput controls: output-file, output-object
+  Base.call(this, runner);
+
+  var self = this;
+  var tests = [];
+  var pending = [];
+  var failures = [];
+  var passes = [];
+
+  runner.on('test end', function (test) {
+    tests.push(test);
+  });
+
+  runner.on('pass', function (test) {
+    passes.push(test);
+  });
+
+  runner.on('fail', function (test) {
+    failures.push(test);
+  });
+
+  runner.on('pending', function (test) {
+    pending.push(test);
+  });
+
+  runner.once('end', function () {
+    var obj = {
+      stats: self.stats,
+      tests: tests.map(clean),
+      pending: pending.map(clean),
+      failures: failures.map(clean),
+      passes: passes.map(clean)
+    };
+
+    runner.testResults = obj;
+<<<<<<< HEAD
+    if ('output-object' in options.reporterOptions) {
+      // Pass to reporter with: reporter("json", {"output-object": myObject})
+      Object.assign(options.reporterOptions['output-object'], obj);
+    } else {
+      var text = JSON.stringify(obj, null, 2);
+      if ('output-file' in options.reporterOptions) {
+        // Direct output with `mocha -R --reporter-options output-file=rpt.json`
+        try {
+          require('fs').writeFileSync(options.reporterOptions['output-file'], text);
+        } catch (e) {
+          console.warn('error writing to ' + options.reporterOptions.output + ':',  e);
+=======
+    if ('output-object' in reptOptions) {
+      // Pass to reporter with: reporter("json", {"output-object": myObject})
+      Object.assign(reptOptions['output-object'], obj);
+    } else {
+      var text = JSON.stringify(obj, null, 2);
+      if ('output-file' in reptOptions) {
+        // Direct output with `mocha -R --reporter-options output-file=rpt.json`
+        try {
+          require('fs').writeFileSync(reptOptions['output-file'], text);
+        } catch (e) {
+          console.warn('error writing to ' + reptOptions.output + ':', e);
+>>>>>>> + json ouput controls: output-file, output-object
+        }
+      } else {
+        process.stdout.write(text);
+      }
+    }
+  });
+}
+
+/**
+ * Return a plain-object representation of `test`
+ * free of cyclic properties etc.
+ *
+ * @api private
+ * @param {Object} test
+ * @return {Object}
+ */
+function clean (test) {
+  return {
+    title: test.title,
+    fullTitle: test.fullTitle(),
+    duration: test.duration,
+    currentRetry: test.currentRetry(),
+    err: errorJSON(test.err || {})
+  };
+}
+
+/**
+ * Transform `error` into a JSON object.
+ *
+ * @api private
+ * @param {Error} err
+ * @return {Object}
+ */
+function errorJSON (err) {
+  var res = {};
+  Object.getOwnPropertyNames(err).forEach(function (key) {
+    res[key] = err[key];
+  }, err);
+  return res;
+}

package/lib/reporters/landing.js

@@ -1,5 +1,7 @@
 'use strict';
-
+/**
+ * @module Landing
+ */
 /**
  * Module dependencies.
  */
@@ -36,33 +38,37 @@ Base.colors.runway = 90;
 /**
  * Initialize a new `Landing` reporter.
  *
+ * @public
+ * @class
+ * @memberof Mocha.reporters
+ * @extends Mocha.reporters.Base
  * @api public
  * @param {Runner} runner
  */
-function Landing (runner) {
+function Landing(runner) {
   Base.call(this, runner);
 
   var self = this;
-  var width = Base.window.width * 0.75 | 0;
+  var width = (Base.window.width * 0.75) | 0;
   var total = runner.total;
   var stream = process.stdout;
   var plane = color('plane', '✈');
   var crashed = -1;
   var n = 0;
 
-  function runway () {
+  function runway() {
     var buf = Array(width).join('-');
     return '  ' + color('runway', buf);
   }
 
-  runner.on('start', function () {
+  runner.on('start', function() {
     stream.write('\n\n\n  ');
     cursor.hide();
   });
 
-  runner.on('test end', function (test) {
+  runner.on('test end', function(test) {
     // check if the plane crashed
-    var col = crashed === -1 ? width * ++n / total | 0 : crashed;
+    var col = crashed === -1 ? (width * ++n / total) | 0 : crashed;
 
     // show the crash
     if (test.state === 'failed') {
@@ -81,7 +87,7 @@ function Landing (runner) {
     stream.write('\u001b[0m');
   });
 
-  runner.once('end', function () {
+  runner.once('end', function() {
     cursor.show();
     console.log();
     self.epilogue();