mocha 5.0.4 → 5.2.0

package/lib/mocha.js

@@ -6,19 +6,11 @@
  * MIT Licensed
  */
 
-/**
- * Module dependencies.
- */
-
 var escapeRe = require('escape-string-regexp');
 var path = require('path');
 var reporters = require('./reporters');
 var utils = require('./utils');
 
-/**
- * Expose `Mocha`.
- */
-
 exports = module.exports = Mocha;
 
 /**
@@ -34,11 +26,25 @@ if (!process.browser) {
  * Expose internals.
  */
 
+/**
+ * @public
+ * @class utils
+ * @memberof Mocha
+ */
 exports.utils = utils;
 exports.interfaces = require('./interfaces');
+/**
+ *
+ * @memberof Mocha
+ * @public
+ */
 exports.reporters = reporters;
 exports.Runnable = require('./runnable');
 exports.Context = require('./context');
+/**
+ *
+ * @memberof Mocha
+ */
 exports.Runner = require('./runner');
 exports.Suite = require('./suite');
 exports.Hook = require('./hook');
@@ -47,12 +53,12 @@ exports.Test = require('./test');
 /**
  * Return image `name` path.
  *
- * @api private
+ * @private
  * @param {string} name
  * @return {string}
  */
-function image (name) {
-  return path.join(__dirname, '../images', name + '.png');
+function image(name) {
+  return path.join(__dirname, '..', 'assets', 'growl', name + '.png');
 }
 
 /**
@@ -71,10 +77,10 @@ function image (name) {
  *   - `fullTrace` display the full stack-trace on failing
  *   - `grep` string or regexp to filter tests with
  *
+ * @class Mocha
  * @param {Object} options
- * @api public
  */
-function Mocha (options) {
+function Mocha(options) {
   options = options || {};
   this.files = [];
   this.options = options;
@@ -106,10 +112,11 @@ function Mocha (options) {
 /**
  * Enable or disable bailing on the first failure.
  *
+ * @public
  * @api public
  * @param {boolean} [bail]
  */
-Mocha.prototype.bail = function (bail) {
+Mocha.prototype.bail = function(bail) {
   if (!arguments.length) {
     bail = true;
   }
@@ -120,10 +127,11 @@ Mocha.prototype.bail = function (bail) {
 /**
  * Add test `file`.
  *
+ * @public
  * @api public
  * @param {string} file
  */
-Mocha.prototype.addFile = function (file) {
+Mocha.prototype.addFile = function(file) {
   this.files.push(file);
   return this;
 };
@@ -131,13 +139,14 @@ Mocha.prototype.addFile = function (file) {
 /**
  * Set reporter to `reporter`, defaults to "spec".
  *
+ * @public
  * @param {String|Function} reporter name or constructor
  * @param {Object} reporterOptions optional options
  * @api public
  * @param {string|Function} reporter name or constructor
  * @param {Object} reporterOptions optional options
  */
-Mocha.prototype.reporter = function (reporter, reporterOptions) {
+Mocha.prototype.reporter = function(reporter, reporterOptions) {
   if (typeof reporter === 'function') {
     this._reporter = reporter;
   } else {
@@ -157,18 +166,28 @@ Mocha.prototype.reporter = function (reporter, reporterOptions) {
           try {
             _reporter = require(path.resolve(process.cwd(), reporter));
           } catch (_err) {
-            err.message.indexOf('Cannot find module') !== -1 ? console.warn('"' + reporter + '" reporter not found')
-              : console.warn('"' + reporter + '" reporter blew up with error:\n' + err.stack);
+            err.message.indexOf('Cannot find module') !== -1
+              ? console.warn('"' + reporter + '" reporter not found')
+              : console.warn(
+                  '"' +
+                    reporter +
+                    '" reporter blew up with error:\n' +
+                    err.stack
+                );
           }
         } else {
-          console.warn('"' + reporter + '" reporter blew up with error:\n' + err.stack);
+          console.warn(
+            '"' + reporter + '" reporter blew up with error:\n' + err.stack
+          );
         }
       }
     }
     if (!_reporter && reporter === 'teamcity') {
-      console.warn('The Teamcity reporter was moved to a package named ' +
-        'mocha-teamcity-reporter ' +
-        '(https://npmjs.org/package/mocha-teamcity-reporter).');
+      console.warn(
+        'The Teamcity reporter was moved to a package named ' +
+          'mocha-teamcity-reporter ' +
+          '(https://npmjs.org/package/mocha-teamcity-reporter).'
+      );
     }
     if (!_reporter) {
       throw new Error('invalid reporter "' + reporter + '"');
@@ -181,11 +200,11 @@ Mocha.prototype.reporter = function (reporter, reporterOptions) {
 
 /**
  * Set test UI `name`, defaults to "bdd".
- *
+ * @public
  * @api public
  * @param {string} bdd
  */
-Mocha.prototype.ui = function (name) {
+Mocha.prototype.ui = function(name) {
   name = name || 'bdd';
   this._ui = exports.interfaces[name];
   if (!this._ui) {
@@ -197,7 +216,7 @@ Mocha.prototype.ui = function (name) {
   }
   this._ui = this._ui(this.suite);
 
-  this.suite.on('pre-require', function (context) {
+  this.suite.on('pre-require', function(context) {
     exports.afterEach = context.afterEach || context.teardown;
     exports.after = context.after || context.suiteTeardown;
     exports.beforeEach = context.beforeEach || context.setup;
@@ -222,10 +241,10 @@ Mocha.prototype.ui = function (name) {
  *
  * @api private
  */
-Mocha.prototype.loadFiles = function (fn) {
+Mocha.prototype.loadFiles = function(fn) {
   var self = this;
   var suite = this.suite;
-  this.files.forEach(function (file) {
+  this.files.forEach(function(file) {
     file = path.resolve(file);
     suite.emit('pre-require', global, file, self);
     suite.emit('require', require(file), file, self);
@@ -239,14 +258,14 @@ Mocha.prototype.loadFiles = function (fn) {
  *
  * @api private
  */
-Mocha.prototype._growl = function (runner, reporter) {
+Mocha.prototype._growl = function(runner, reporter) {
   var notify = require('growl');
 
-  runner.on('end', function () {
+  runner.on('end', function() {
     var stats = reporter.stats;
     if (stats.failures) {
       var msg = stats.failures + ' of ' + runner.total + ' tests failed';
-      notify(msg, { name: 'mocha', title: 'Failed', image: image('error') });
+      notify(msg, {name: 'mocha', title: 'Failed', image: image('error')});
     } else {
       notify(stats.passes + ' tests passed in ' + stats.duration + 'ms', {
         name: 'mocha',
@@ -260,24 +279,26 @@ Mocha.prototype._growl = function (runner, reporter) {
 /**
  * Escape string and add it to grep as a regexp.
  *
+ * @public
  * @api public
  * @param str
  * @returns {Mocha}
  */
-Mocha.prototype.fgrep = function (str) {
+Mocha.prototype.fgrep = function(str) {
   return this.grep(new RegExp(escapeRe(str)));
 };
 
 /**
  * Add regexp to grep, if `re` is a string it is escaped.
  *
+ * @public
  * @param {RegExp|String} re
  * @return {Mocha}
  * @api public
  * @param {RegExp|string} re
  * @return {Mocha}
  */
-Mocha.prototype.grep = function (re) {
+Mocha.prototype.grep = function(re) {
   if (utils.isString(re)) {
     // extract args if it's regex-like, i.e: [string, pattern, flag]
     var arg = re.match(/^\/(.*)\/(g|i|)$|.*/);
@@ -290,10 +311,11 @@ Mocha.prototype.grep = function (re) {
 /**
  * Invert `.grep()` matches.
  *
+ * @public
  * @return {Mocha}
  * @api public
  */
-Mocha.prototype.invert = function () {
+Mocha.prototype.invert = function() {
   this.options.invert = true;
   return this;
 };
@@ -301,13 +323,14 @@ Mocha.prototype.invert = function () {
 /**
  * Ignore global leaks.
  *
+ * @public
  * @param {Boolean} ignore
  * @return {Mocha}
  * @api public
  * @param {boolean} ignore
  * @return {Mocha}
  */
-Mocha.prototype.ignoreLeaks = function (ignore) {
+Mocha.prototype.ignoreLeaks = function(ignore) {
   this.options.ignoreLeaks = Boolean(ignore);
   return this;
 };
@@ -317,8 +340,9 @@ Mocha.prototype.ignoreLeaks = function (ignore) {
  *
  * @return {Mocha}
  * @api public
+ * @public
  */
-Mocha.prototype.checkLeaks = function () {
+Mocha.prototype.checkLeaks = function() {
   this.options.ignoreLeaks = false;
   return this;
 };
@@ -328,8 +352,9 @@ Mocha.prototype.checkLeaks = function () {
  *
  * @return {Mocha}
  * @api public
+ * @public
  */
-Mocha.prototype.fullTrace = function () {
+Mocha.prototype.fullTrace = function() {
   this.options.fullStackTrace = true;
   return this;
 };
@@ -339,8 +364,9 @@ Mocha.prototype.fullTrace = function () {
  *
  * @return {Mocha}
  * @api public
+ * @public
  */
-Mocha.prototype.growl = function () {
+Mocha.prototype.growl = function() {
   this.options.growl = true;
   return this;
 };
@@ -351,10 +377,11 @@ Mocha.prototype.growl = function () {
  * @param {Array|String} globals
  * @return {Mocha}
  * @api public
+ * @public
  * @param {Array|string} globals
  * @return {Mocha}
  */
-Mocha.prototype.globals = function (globals) {
+Mocha.prototype.globals = function(globals) {
   this.options.globals = (this.options.globals || []).concat(globals);
   return this;
 };
@@ -365,10 +392,11 @@ Mocha.prototype.globals = function (globals) {
  * @param {Boolean} colors
  * @return {Mocha}
  * @api public
+ * @public
  * @param {boolean} colors
  * @return {Mocha}
  */
-Mocha.prototype.useColors = function (colors) {
+Mocha.prototype.useColors = function(colors) {
   if (colors !== undefined) {
     this.options.useColors = colors;
   }
@@ -381,10 +409,11 @@ Mocha.prototype.useColors = function (colors) {
  * @param {Boolean} inlineDiffs
  * @return {Mocha}
  * @api public
+ * @public
  * @param {boolean} inlineDiffs
  * @return {Mocha}
  */
-Mocha.prototype.useInlineDiffs = function (inlineDiffs) {
+Mocha.prototype.useInlineDiffs = function(inlineDiffs) {
   this.options.useInlineDiffs = inlineDiffs !== undefined && inlineDiffs;
   return this;
 };
@@ -395,10 +424,11 @@ Mocha.prototype.useInlineDiffs = function (inlineDiffs) {
  * @param {Boolean} hideDiff
  * @return {Mocha}
  * @api public
+ * @public
  * @param {boolean} hideDiff
  * @return {Mocha}
  */
-Mocha.prototype.hideDiff = function (hideDiff) {
+Mocha.prototype.hideDiff = function(hideDiff) {
   this.options.hideDiff = hideDiff !== undefined && hideDiff;
   return this;
 };
@@ -409,10 +439,11 @@ Mocha.prototype.hideDiff = function (hideDiff) {
  * @param {Number} timeout
  * @return {Mocha}
  * @api public
+ * @public
  * @param {number} timeout
  * @return {Mocha}
  */
-Mocha.prototype.timeout = function (timeout) {
+Mocha.prototype.timeout = function(timeout) {
   this.suite.timeout(timeout);
   return this;
 };
@@ -423,8 +454,9 @@ Mocha.prototype.timeout = function (timeout) {
  * @param {Number} retry times
  * @return {Mocha}
  * @api public
+ * @public
  */
-Mocha.prototype.retries = function (n) {
+Mocha.prototype.retries = function(n) {
   this.suite.retries(n);
   return this;
 };
@@ -435,10 +467,11 @@ Mocha.prototype.retries = function (n) {
  * @param {Number} slow
  * @return {Mocha}
  * @api public
+ * @public
  * @param {number} slow
  * @return {Mocha}
  */
-Mocha.prototype.slow = function (slow) {
+Mocha.prototype.slow = function(slow) {
   this.suite.slow(slow);
   return this;
 };
@@ -449,11 +482,14 @@ Mocha.prototype.slow = function (slow) {
  * @param {Boolean} enabled
  * @return {Mocha}
  * @api public
+ * @public
  * @param {boolean} enabled
  * @return {Mocha}
  */
-Mocha.prototype.enableTimeouts = function (enabled) {
-  this.suite.enableTimeouts(arguments.length && enabled !== undefined ? enabled : true);
+Mocha.prototype.enableTimeouts = function(enabled) {
+  this.suite.enableTimeouts(
+    arguments.length && enabled !== undefined ? enabled : true
+  );
   return this;
 };
 
@@ -462,8 +498,9 @@ Mocha.prototype.enableTimeouts = function (enabled) {
  *
  * @return {Mocha}
  * @api public
+ * @public
  */
-Mocha.prototype.asyncOnly = function () {
+Mocha.prototype.asyncOnly = function() {
   this.options.asyncOnly = true;
   return this;
 };
@@ -472,8 +509,9 @@ Mocha.prototype.asyncOnly = function () {
  * Disable syntax highlighting (in browser).
  *
  * @api public
+ * @public
  */
-Mocha.prototype.noHighlighting = function () {
+Mocha.prototype.noHighlighting = function() {
   this.options.noHighlighting = true;
   return this;
 };
@@ -483,8 +521,9 @@ Mocha.prototype.noHighlighting = function () {
  *
  * @return {Mocha}
  * @api public
+ * @public
  */
-Mocha.prototype.allowUncaught = function () {
+Mocha.prototype.allowUncaught = function() {
   this.options.allowUncaught = true;
   return this;
 };
@@ -493,7 +532,7 @@ Mocha.prototype.allowUncaught = function () {
  * Delay root suite execution.
  * @returns {Mocha}
  */
-Mocha.prototype.delay = function delay () {
+Mocha.prototype.delay = function delay() {
   this.options.delay = true;
   return this;
 };
@@ -502,7 +541,7 @@ Mocha.prototype.delay = function delay () {
  * Tests marked only fail the suite
  * @returns {Mocha}
  */
-Mocha.prototype.forbidOnly = function () {
+Mocha.prototype.forbidOnly = function() {
   this.options.forbidOnly = true;
   return this;
 };
@@ -511,7 +550,7 @@ Mocha.prototype.forbidOnly = function () {
  * Pending tests and tests marked skip fail the suite
  * @returns {Mocha}
  */
-Mocha.prototype.forbidPending = function () {
+Mocha.prototype.forbidPending = function() {
   this.options.forbidPending = true;
   return this;
 };
@@ -528,10 +567,11 @@ Mocha.prototype.forbidPending = function () {
  * cache first in whichever manner best suits your needs.
  *
  * @api public
+ * @public
  * @param {Function} fn
  * @return {Runner}
  */
-Mocha.prototype.run = function (fn) {
+Mocha.prototype.run = function(fn) {
   if (this.files.length) {
     this.loadFiles();
   }
@@ -561,7 +601,7 @@ Mocha.prototype.run = function (fn) {
   exports.reporters.Base.inlineDiffs = options.useInlineDiffs;
   exports.reporters.Base.hideDiff = options.hideDiff;
 
-  function done (failures) {
+  function done(failures) {
     if (reporter.done) {
       reporter.done(failures, fn);
     } else {

package/lib/ms.js

@@ -1,5 +1,7 @@
 'use strict';
-
+/**
+ * @module milliseconds
+ */
 /**
  * Helpers.
  */
@@ -13,11 +15,13 @@ var y = d * 365.25;
 /**
  * Parse or format the given `val`.
  *
+ * @memberof Mocha
+ * @public
  * @api public
  * @param {string|number} val
  * @return {string|number}
  */
-module.exports = function (val) {
+module.exports = function(val) {
   if (typeof val === 'string') {
     return parse(val);
   }
@@ -31,8 +35,10 @@ module.exports = function (val) {
  * @param {string} str
  * @return {number}
  */
-function parse (str) {
-  var match = (/^((?:\d+)?\.?\d+) *(ms|seconds?|s|minutes?|m|hours?|h|days?|d|years?|y)?$/i).exec(str);
+function parse(str) {
+  var match = /^((?:\d+)?\.?\d+) *(ms|seconds?|s|minutes?|m|hours?|h|days?|d|years?|y)?$/i.exec(
+    str
+  );
   if (!match) {
     return;
   }
@@ -62,7 +68,7 @@ function parse (str) {
     case 'ms':
       return n;
     default:
-      // No default case
+    // No default case
   }
 }
 
@@ -73,7 +79,7 @@ function parse (str) {
  * @param {number} ms
  * @return {string}
  */
-function format (ms) {
+function format(ms) {
   if (ms >= d) {
     return Math.round(ms / d) + 'd';
   }

package/lib/pending.js

@@ -1,9 +1,5 @@
 'use strict';
 
-/**
- * Expose `Pending`.
- */
-
 module.exports = Pending;
 
 /**
@@ -11,6 +7,6 @@ module.exports = Pending;
  *
  * @param {string} message
  */
-function Pending (message) {
+function Pending(message) {
   this.message = message;
 }