mocha 5.0.4 → 5.2.0

package/lib/reporters/base.js

@@ -1,5 +1,7 @@
 'use strict';
-
+/**
+ * @module Base
+ */
 /**
  * Module dependencies.
  */
@@ -39,7 +41,9 @@ var isatty = tty.isatty(1) && tty.isatty(2);
  * Enable coloring by default, except in the browser interface.
  */
 
-exports.useColors = !process.browser && (supportsColor || (process.env.MOCHA_COLORS !== undefined));
+exports.useColors =
+  !process.browser &&
+  (supportsColor.stdout || process.env.MOCHA_COLORS !== undefined);
 
 /**
  * Inline diffs instead of +/-
@@ -103,12 +107,12 @@ if (process.platform === 'win32') {
  * @return {string}
  * @api private
  */
-var color = exports.color = function (type, str) {
+var color = (exports.color = function(type, str) {
   if (!exports.useColors) {
     return String(str);
   }
   return '\u001b[' + exports.colors[type] + 'm' + str + '\u001b[0m';
-};
+});
 
 /**
  * Expose term window size, with some defaults for when stderr is not a tty.
@@ -129,23 +133,23 @@ if (isatty) {
  */
 
 exports.cursor = {
-  hide: function () {
+  hide: function() {
     isatty && process.stdout.write('\u001b[?25l');
   },
 
-  show: function () {
+  show: function() {
     isatty && process.stdout.write('\u001b[?25h');
   },
 
-  deleteLine: function () {
+  deleteLine: function() {
     isatty && process.stdout.write('\u001b[2K');
   },
 
-  beginningOfLine: function () {
+  beginningOfLine: function() {
     isatty && process.stdout.write('\u001b[0G');
   },
 
-  CR: function () {
+  CR: function() {
     if (isatty) {
       exports.cursor.deleteLine();
       exports.cursor.beginningOfLine();
@@ -155,11 +159,16 @@ exports.cursor = {
   }
 };
 
-function showDiff (err) {
-  return err && err.showDiff !== false && sameType(err.actual, err.expected) && err.expected !== undefined;
+function showDiff(err) {
+  return (
+    err &&
+    err.showDiff !== false &&
+    sameType(err.actual, err.expected) &&
+    err.expected !== undefined
+  );
 }
 
-function stringifyDiffObjs (err) {
+function stringifyDiffObjs(err) {
   if (!utils.isString(err.actual) || !utils.isString(err.expected)) {
     err.actual = utils.stringify(err.actual);
     err.expected = utils.stringify(err.expected);
@@ -176,24 +185,28 @@ function stringifyDiffObjs (err) {
  * @param {string} expected
  * @return {string} Diff
  */
-var generateDiff = exports.generateDiff = function (actual, expected) {
+var generateDiff = (exports.generateDiff = function(actual, expected) {
   return exports.inlineDiffs
     ? inlineDiff(actual, expected)
     : unifiedDiff(actual, expected);
-};
+});
 
 /**
  * Output the given `failures` as a list.
  *
+ * @public
+ * @memberof Mocha.reporters.Base
+ * @variation 1
  * @param {Array} failures
  * @api public
  */
 
-exports.list = function (failures) {
+exports.list = function(failures) {
   console.log();
-  failures.forEach(function (test, i) {
+  failures.forEach(function(test, i) {
     // format
-    var fmt = color('error title', '  %s) %s:\n') +
+    var fmt =
+      color('error title', '  %s) %s:\n') +
       color('error message', '     %s') +
       color('error stack', '\n%s\n');
 
@@ -227,7 +240,8 @@ exports.list = function (failures) {
     // explicitly show diff
     if (!exports.hideDiff && showDiff(err)) {
       stringifyDiffObjs(err);
-      fmt = color('error title', '  %s) %s:\n%s') + color('error stack', '\n%s\n');
+      fmt =
+        color('error title', '  %s) %s:\n%s') + color('error stack', '\n%s\n');
       var match = message.match(/^([^:]+): expected/);
       msg = '\n      ' + color('error message', match ? match[1] : msg);
 
@@ -239,7 +253,7 @@ exports.list = function (failures) {
 
     // indented test title
     var testTitle = '';
-    test.titlePath().forEach(function (str, index) {
+    test.titlePath().forEach(function(str, index) {
       if (index !== 0) {
         testTitle += '\n     ';
       }
@@ -249,7 +263,7 @@ exports.list = function (failures) {
       testTitle += str;
     });
 
-    console.log(fmt, (i + 1), testTitle, msg, stack);
+    console.log(fmt, i + 1, testTitle, msg, stack);
   });
 };
 
@@ -261,13 +275,22 @@ exports.list = function (failures) {
  * stats such as test duration, number
  * of tests passed / failed etc.
  *
+ * @memberof Mocha.reporters
+ * @public
+ * @class
  * @param {Runner} runner
  * @api public
  */
 
-function Base (runner) {
-  var stats = this.stats = { suites: 0, tests: 0, passes: 0, pending: 0, failures: 0 };
-  var failures = this.failures = [];
+function Base(runner) {
+  var stats = (this.stats = {
+    suites: 0,
+    tests: 0,
+    passes: 0,
+    pending: 0,
+    failures: 0
+  });
+  var failures = (this.failures = []);
 
   if (!runner) {
     return;
@@ -276,21 +299,21 @@ function Base (runner) {
 
   runner.stats = stats;
 
-  runner.on('start', function () {
+  runner.on('start', function() {
     stats.start = new Date();
   });
 
-  runner.on('suite', function (suite) {
+  runner.on('suite', function(suite) {
     stats.suites = stats.suites || 0;
     suite.root || stats.suites++;
   });
 
-  runner.on('test end', function () {
+  runner.on('test end', function() {
     stats.tests = stats.tests || 0;
     stats.tests++;
   });
 
-  runner.on('pass', function (test) {
+  runner.on('pass', function(test) {
     stats.passes = stats.passes || 0;
 
     if (test.duration > test.slow()) {
@@ -304,7 +327,7 @@ function Base (runner) {
     stats.passes++;
   });
 
-  runner.on('fail', function (test, err) {
+  runner.on('fail', function(test, err) {
     stats.failures = stats.failures || 0;
     stats.failures++;
     if (showDiff(err)) {
@@ -314,12 +337,12 @@ function Base (runner) {
     failures.push(test);
   });
 
-  runner.once('end', function () {
+  runner.once('end', function() {
     stats.end = new Date();
     stats.duration = stats.end - stats.start;
   });
 
-  runner.on('pending', function () {
+  runner.on('pending', function() {
     stats.pending++;
   });
 }
@@ -328,27 +351,27 @@ function Base (runner) {
  * Output common epilogue used by many of
  * the bundled reporters.
  *
+ * @memberof Mocha.reporters.Base
+ * @public
  * @api public
  */
-Base.prototype.epilogue = function () {
+Base.prototype.epilogue = function() {
   var stats = this.stats;
   var fmt;
 
   console.log();
 
   // passes
-  fmt = color('bright pass', ' ') +
+  fmt =
+    color('bright pass', ' ') +
     color('green', ' %d passing') +
     color('light', ' (%s)');
 
-  console.log(fmt,
-    stats.passes || 0,
-    ms(stats.duration));
+  console.log(fmt, stats.passes || 0, ms(stats.duration));
 
   // pending
   if (stats.pending) {
-    fmt = color('pending', ' ') +
-      color('pending', ' %d pending');
+    fmt = color('pending', ' ') + color('pending', ' %d pending');
 
     console.log(fmt, stats.pending);
   }
@@ -374,7 +397,7 @@ Base.prototype.epilogue = function () {
  * @param {string} len
  * @return {string}
  */
-function pad (str, len) {
+function pad(str, len) {
   str = String(str);
   return Array(len - str.length + 1).join(' ') + str;
 }
@@ -387,20 +410,23 @@ function pad (str, len) {
  * @param {String} expected
  * @return {string} Diff
  */
-function inlineDiff (actual, expected) {
+function inlineDiff(actual, expected) {
   var msg = errorDiff(actual, expected);
 
   // linenos
   var lines = msg.split('\n');
   if (lines.length > 4) {
     var width = String(lines.length).length;
-    msg = lines.map(function (str, i) {
-      return pad(++i, width) + ' |' + ' ' + str;
-    }).join('\n');
+    msg = lines
+      .map(function(str, i) {
+        return pad(++i, width) + ' |' + ' ' + str;
+      })
+      .join('\n');
   }
 
   // legend
-  msg = '\n' +
+  msg =
+    '\n' +
     color('diff removed', 'actual') +
     ' ' +
     color('diff added', 'expected') +
@@ -421,9 +447,9 @@ function inlineDiff (actual, expected) {
  * @param {String} expected
  * @return {string} The diff.
  */
-function unifiedDiff (actual, expected) {
+function unifiedDiff(actual, expected) {
   var indent = '      ';
-  function cleanUp (line) {
+  function cleanUp(line) {
     if (line[0] === '+') {
       return indent + colorLines('diff added', line);
     }
@@ -438,16 +464,22 @@ function unifiedDiff (actual, expected) {
     }
     return indent + line;
   }
-  function notBlank (line) {
+  function notBlank(line) {
     return typeof line !== 'undefined' && line !== null;
   }
   var msg = diff.createPatch('string', actual, expected);
   var lines = msg.split('\n').splice(5);
-  return '\n      ' +
-    colorLines('diff added', '+ expected') + ' ' +
+  return (
+    '\n      ' +
+    colorLines('diff added', '+ expected') +
+    ' ' +
     colorLines('diff removed', '- actual') +
     '\n\n' +
-    lines.map(cleanUp).filter(notBlank).join('\n');
+    lines
+      .map(cleanUp)
+      .filter(notBlank)
+      .join('\n')
+  );
 }
 
 /**
@@ -458,16 +490,19 @@ function unifiedDiff (actual, expected) {
  * @param {String} expected
  * @return {string} the diff
  */
-function errorDiff (actual, expected) {
-  return diff.diffWordsWithSpace(actual, expected).map(function (str) {
-    if (str.added) {
-      return colorLines('diff added', str.value);
-    }
-    if (str.removed) {
-      return colorLines('diff removed', str.value);
-    }
-    return str.value;
-  }).join('');
+function errorDiff(actual, expected) {
+  return diff
+    .diffWordsWithSpace(actual, expected)
+    .map(function(str) {
+      if (str.added) {
+        return colorLines('diff added', str.value);
+      }
+      if (str.removed) {
+        return colorLines('diff removed', str.value);
+      }
+      return str.value;
+    })
+    .join('');
 }
 
 /**
@@ -478,10 +513,13 @@ function errorDiff (actual, expected) {
  * @param {string} str
  * @return {string}
  */
-function colorLines (name, str) {
-  return str.split('\n').map(function (str) {
-    return color(name, str);
-  }).join('\n');
+function colorLines(name, str) {
+  return str
+    .split('\n')
+    .map(function(str) {
+      return color(name, str);
+    })
+    .join('\n');
 }
 
 /**
@@ -497,6 +535,6 @@ var objToString = Object.prototype.toString;
  * @param {Object} b
  * @return {boolean}
  */
-function sameType (a, b) {
+function sameType(a, b) {
   return objToString.call(a) === objToString.call(b);
 }

package/lib/reporters/doc.js

@@ -1,5 +1,7 @@
 'use strict';
-
+/**
+ * @module Doc
+ */
 /**
  * Module dependencies.
  */
@@ -16,19 +18,23 @@ exports = module.exports = Doc;
 /**
  * Initialize a new `Doc` reporter.
  *
+ * @class
+ * @memberof Mocha.reporters
+ * @extends {Base}
+ * @public
  * @param {Runner} runner
  * @api public
  */
-function Doc (runner) {
+function Doc(runner) {
   Base.call(this, runner);
 
   var indents = 2;
 
-  function indent () {
+  function indent() {
     return Array(indents).join('  ');
   }
 
-  runner.on('suite', function (suite) {
+  runner.on('suite', function(suite) {
     if (suite.root) {
       return;
     }
@@ -39,7 +45,7 @@ function Doc (runner) {
     console.log('%s<dl>', indent());
   });
 
-  runner.on('suite end', function (suite) {
+  runner.on('suite end', function(suite) {
     if (suite.root) {
       return;
     }
@@ -49,16 +55,24 @@ function Doc (runner) {
     --indents;
   });
 
-  runner.on('pass', function (test) {
+  runner.on('pass', function(test) {
     console.log('%s  <dt>%s</dt>', indent(), utils.escape(test.title));
     var code = utils.escape(utils.clean(test.body));
     console.log('%s  <dd><pre><code>%s</code></pre></dd>', indent(), code);
   });
 
-  runner.on('fail', function (test, err) {
-    console.log('%s  <dt class="error">%s</dt>', indent(), utils.escape(test.title));
+  runner.on('fail', function(test, err) {
+    console.log(
+      '%s  <dt class="error">%s</dt>',
+      indent(),
+      utils.escape(test.title)
+    );
     var code = utils.escape(utils.clean(test.body));
-    console.log('%s  <dd class="error"><pre><code>%s</code></pre></dd>', indent(), code);
+    console.log(
+      '%s  <dd class="error"><pre><code>%s</code></pre></dd>',
+      indent(),
+      code
+    );
     console.log('%s  <dd class="error">%s</dd>', indent(), utils.escape(err));
   });
 }

package/lib/reporters/dot.js

@@ -1,5 +1,7 @@
 'use strict';
-
+/**
+ * @module Dot
+ */
 /**
  * Module dependencies.
  */
@@ -17,28 +19,32 @@ exports = module.exports = Dot;
 /**
  * Initialize a new `Dot` matrix test reporter.
  *
+ * @class
+ * @memberof Mocha.reporters
+ * @extends Mocha.reporters.Base
+ * @public
  * @api public
  * @param {Runner} runner
  */
-function Dot (runner) {
+function Dot(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 n = -1;
 
-  runner.on('start', function () {
+  runner.on('start', function() {
     process.stdout.write('\n');
   });
 
-  runner.on('pending', function () {
+  runner.on('pending', function() {
     if (++n % width === 0) {
       process.stdout.write('\n  ');
     }
     process.stdout.write(color('pending', Base.symbols.comma));
   });
 
-  runner.on('pass', function (test) {
+  runner.on('pass', function(test) {
     if (++n % width === 0) {
       process.stdout.write('\n  ');
     }
@@ -49,14 +55,14 @@ function Dot (runner) {
     }
   });
 
-  runner.on('fail', function () {
+  runner.on('fail', function() {
     if (++n % width === 0) {
       process.stdout.write('\n  ');
     }
     process.stdout.write(color('fail', Base.symbols.bang));
   });
 
-  runner.once('end', function () {
+  runner.once('end', function() {
     console.log();
     self.epilogue();
   });