mocha 2.2.5 → 2.3.3

package/lib/mocha.js

@@ -8,9 +8,10 @@
  * Module dependencies.
  */
 
-var path = require('path')
-  , escapeRe = require('escape-string-regexp')
-  , utils = require('./utils');
+var escapeRe = require('escape-string-regexp');
+var path = require('path');
+var reporters = require('./reporters');
+var utils = require('./utils');
 
 /**
  * Expose `Mocha`.
@@ -22,10 +23,9 @@ exports = module.exports = Mocha;
  * To require local UIs and reporters when running in node.
  */
 
-if (typeof process !== 'undefined' && typeof process.cwd === 'function') {
-  var join = path.join
-    , cwd = process.cwd();
-  module.paths.push(cwd, join(cwd, 'node_modules'));
+if (!process.browser) {
+  var cwd = process.cwd();
+  module.paths.push(cwd, path.join(cwd, 'node_modules'));
 }
 
 /**
@@ -34,7 +34,7 @@ if (typeof process !== 'undefined' && typeof process.cwd === 'function') {
 
 exports.utils = utils;
 exports.interfaces = require('./interfaces');
-exports.reporters = require('./reporters');
+exports.reporters = reporters;
 exports.Runnable = require('./runnable');
 exports.Context = require('./context');
 exports.Runner = require('./runner');
@@ -45,17 +45,16 @@ exports.Test = require('./test');
 /**
  * Return image `name` path.
  *
- * @param {String} name
- * @return {String}
  * @api private
+ * @param {string} name
+ * @return {string}
  */
-
 function image(name) {
-  return __dirname + '/../images/' + name + '.png';
+  return path.join(__dirname, '../images', name + '.png');
 }
 
 /**
- * Setup mocha with `options`.
+ * Set up mocha with `options`.
  *
  * Options:
  *
@@ -72,23 +71,32 @@ function image(name) {
  * @param {Object} options
  * @api public
  */
-
 function Mocha(options) {
   options = options || {};
   this.files = [];
   this.options = options;
-  if (options.grep) this.grep(new RegExp(options.grep));
-  if (options.fgrep) this.grep(options.fgrep);
-  this.suite = new exports.Suite('', new exports.Context);
+  if (options.grep) {
+    this.grep(new RegExp(options.grep));
+  }
+  if (options.fgrep) {
+    this.grep(options.fgrep);
+  }
+  this.suite = new exports.Suite('', new exports.Context());
   this.ui(options.ui);
   this.bail(options.bail);
   this.reporter(options.reporter, options.reporterOptions);
-  if (null != options.timeout) this.timeout(options.timeout);
+  if (typeof options.timeout !== 'undefined' && options.timeout !== null) {
+    this.timeout(options.timeout);
+  }
   this.useColors(options.useColors);
-  if (options.enableTimeouts !== null) this.enableTimeouts(options.enableTimeouts);
-  if (options.slow) this.slow(options.slow);
+  if (options.enableTimeouts !== null) {
+    this.enableTimeouts(options.enableTimeouts);
+  }
+  if (options.slow) {
+    this.slow(options.slow);
+  }
 
-  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;
@@ -108,12 +116,13 @@ function Mocha(options) {
 /**
  * Enable or disable bailing on the first failure.
  *
- * @param {Boolean} [bail]
  * @api public
+ * @param {boolean} [bail]
  */
-
-Mocha.prototype.bail = function(bail){
-  if (0 == arguments.length) bail = true;
+Mocha.prototype.bail = function(bail) {
+  if (!arguments.length) {
+    bail = true;
+  }
   this.suite.bail(bail);
   return this;
 };
@@ -121,11 +130,10 @@ Mocha.prototype.bail = function(bail){
 /**
  * Add test `file`.
  *
- * @param {String} file
  * @api public
+ * @param {string} file
  */
-
-Mocha.prototype.addFile = function(file){
+Mocha.prototype.addFile = function(file) {
   this.files.push(file);
   return this;
 };
@@ -136,24 +144,37 @@ Mocha.prototype.addFile = function(file){
  * @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){
-  if ('function' == typeof reporter) {
+Mocha.prototype.reporter = function(reporter, reporterOptions) {
+  if (typeof reporter === 'function') {
     this._reporter = reporter;
   } else {
     reporter = reporter || 'spec';
     var _reporter;
-    try { _reporter = require('./reporters/' + reporter); } catch (err) {}
-    if (!_reporter) try { _reporter = require(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);
+    // Try to load a built-in reporter.
+    if (reporters[reporter]) {
+      _reporter = reporters[reporter];
+    }
+    // Try to load reporters from process.cwd() and node_modules
+    if (!_reporter) {
+      try {
+        _reporter = require(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);
+      }
+    }
+    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).');
+    }
+    if (!_reporter) {
+      throw new Error('invalid reporter "' + reporter + '"');
     }
-    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).');
-    if (!_reporter) throw new Error('invalid reporter "' + reporter + '"');
     this._reporter = _reporter;
   }
   this.options.reporterOptions = reporterOptions;
@@ -163,15 +184,19 @@ Mocha.prototype.reporter = function(reporter, reporterOptions){
 /**
  * Set test UI `name`, defaults to "bdd".
  *
- * @param {String} bdd
  * @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) try { this._ui = require(name); } catch (err) {}
-  if (!this._ui) throw new Error('invalid interface "' + name + '"');
+  if (!this._ui) {
+    try {
+      this._ui = require(name);
+    } catch (err) {
+      throw new Error('invalid interface "' + name + '"');
+    }
+  }
   this._ui = this._ui(this.suite);
   return this;
 };
@@ -181,12 +206,11 @@ Mocha.prototype.ui = function(name){
  *
  * @api private
  */
-
-Mocha.prototype.loadFiles = function(fn){
+Mocha.prototype.loadFiles = function(fn) {
   var self = this;
   var suite = this.suite;
   var pending = this.files.length;
-  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);
@@ -200,20 +224,19 @@ Mocha.prototype.loadFiles = function(fn){
  *
  * @api private
  */
-
 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') });
     } else {
       notify(stats.passes + ' tests passed in ' + stats.duration + 'ms', {
-          name: 'mocha'
-        , title: 'Passed'
-        , image: image('ok')
+        name: 'mocha',
+        title: 'Passed',
+        image: image('ok')
       });
     }
   });
@@ -225,12 +248,11 @@ Mocha.prototype._growl = function(runner, reporter) {
  * @param {RegExp|String} re
  * @return {Mocha}
  * @api public
+ * @param {RegExp|string} re
+ * @return {Mocha}
  */
-
-Mocha.prototype.grep = function(re){
-  this.options.grep = 'string' == typeof re
-    ? new RegExp(escapeRe(re))
-    : re;
+Mocha.prototype.grep = function(re) {
+  this.options.grep = typeof re === 'string' ? new RegExp(escapeRe(re)) : re;
   return this;
 };
 
@@ -240,8 +262,7 @@ Mocha.prototype.grep = function(re){
  * @return {Mocha}
  * @api public
  */
-
-Mocha.prototype.invert = function(){
+Mocha.prototype.invert = function() {
   this.options.invert = true;
   return this;
 };
@@ -252,10 +273,11 @@ Mocha.prototype.invert = function(){
  * @param {Boolean} ignore
  * @return {Mocha}
  * @api public
+ * @param {boolean} ignore
+ * @return {Mocha}
  */
-
-Mocha.prototype.ignoreLeaks = function(ignore){
-  this.options.ignoreLeaks = !!ignore;
+Mocha.prototype.ignoreLeaks = function(ignore) {
+  this.options.ignoreLeaks = Boolean(ignore);
   return this;
 };
 
@@ -265,8 +287,7 @@ Mocha.prototype.ignoreLeaks = function(ignore){
  * @return {Mocha}
  * @api public
  */
-
-Mocha.prototype.checkLeaks = function(){
+Mocha.prototype.checkLeaks = function() {
   this.options.ignoreLeaks = false;
   return this;
 };
@@ -277,7 +298,6 @@ Mocha.prototype.checkLeaks = function(){
  * @return {Mocha}
  * @api public
  */
-
 Mocha.prototype.fullTrace = function() {
   this.options.fullStackTrace = true;
   return this;
@@ -289,8 +309,7 @@ Mocha.prototype.fullTrace = function() {
  * @return {Mocha}
  * @api public
  */
-
-Mocha.prototype.growl = function(){
+Mocha.prototype.growl = function() {
   this.options.growl = true;
   return this;
 };
@@ -301,9 +320,10 @@ Mocha.prototype.growl = function(){
  * @param {Array|String} globals
  * @return {Mocha}
  * @api 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;
 };
@@ -314,9 +334,10 @@ Mocha.prototype.globals = function(globals){
  * @param {Boolean} colors
  * @return {Mocha}
  * @api public
+ * @param {boolean} colors
+ * @return {Mocha}
  */
-
-Mocha.prototype.useColors = function(colors){
+Mocha.prototype.useColors = function(colors) {
   if (colors !== undefined) {
     this.options.useColors = colors;
   }
@@ -329,12 +350,11 @@ Mocha.prototype.useColors = function(colors){
  * @param {Boolean} inlineDiffs
  * @return {Mocha}
  * @api public
+ * @param {boolean} inlineDiffs
+ * @return {Mocha}
  */
-
 Mocha.prototype.useInlineDiffs = function(inlineDiffs) {
-  this.options.useInlineDiffs = arguments.length && inlineDiffs != undefined
-  ? inlineDiffs
-  : false;
+  this.options.useInlineDiffs = inlineDiffs !== undefined && inlineDiffs;
   return this;
 };
 
@@ -344,9 +364,10 @@ Mocha.prototype.useInlineDiffs = function(inlineDiffs) {
  * @param {Number} timeout
  * @return {Mocha}
  * @api public
+ * @param {number} timeout
+ * @return {Mocha}
  */
-
-Mocha.prototype.timeout = function(timeout){
+Mocha.prototype.timeout = function(timeout) {
   this.suite.timeout(timeout);
   return this;
 };
@@ -357,9 +378,10 @@ Mocha.prototype.timeout = function(timeout){
  * @param {Number} slow
  * @return {Mocha}
  * @api public
+ * @param {number} slow
+ * @return {Mocha}
  */
-
-Mocha.prototype.slow = function(slow){
+Mocha.prototype.slow = function(slow) {
   this.suite.slow(slow);
   return this;
 };
@@ -370,13 +392,12 @@ Mocha.prototype.slow = function(slow){
  * @param {Boolean} enabled
  * @return {Mocha}
  * @api public
+ * @param {boolean} enabled
+ * @return {Mocha}
  */
-
 Mocha.prototype.enableTimeouts = function(enabled) {
-  this.suite.enableTimeouts(arguments.length && enabled !== undefined
-    ? enabled
-    : true);
-  return this
+  this.suite.enableTimeouts(arguments.length && enabled !== undefined ? enabled : true);
+  return this;
 };
 
 /**
@@ -385,15 +406,14 @@ Mocha.prototype.enableTimeouts = function(enabled) {
  * @return {Mocha}
  * @api public
  */
-
-Mocha.prototype.asyncOnly = function(){
+Mocha.prototype.asyncOnly = function() {
   this.options.asyncOnly = true;
   return this;
 };
 
 /**
  * Disable syntax highlighting (in browser).
- * @returns {Mocha}
+ *
  * @api public
  */
 Mocha.prototype.noHighlighting = function() {
@@ -401,10 +421,20 @@ Mocha.prototype.noHighlighting = function() {
   return this;
 };
 
+/**
+ * Enable uncaught errors to propagate (in browser).
+ *
+ * @return {Mocha}
+ * @api public
+ */
+Mocha.prototype.allowUncaught = function() {
+  this.options.allowUncaught = true;
+  return this;
+};
+
 /**
  * Delay root suite execution.
  * @returns {Mocha}
- * @api public
  */
 Mocha.prototype.delay = function delay() {
   this.options.delay = true;
@@ -414,32 +444,43 @@ Mocha.prototype.delay = function delay() {
 /**
  * Run tests and invoke `fn()` when complete.
  *
+ * @api public
  * @param {Function} fn
  * @return {Runner}
- * @api public
  */
-Mocha.prototype.run = function(fn){
-  if (this.files.length) this.loadFiles();
+Mocha.prototype.run = function(fn) {
+  if (this.files.length) {
+    this.loadFiles();
+  }
   var suite = this.suite;
   var options = this.options;
   options.files = this.files;
   var runner = new exports.Runner(suite, options.delay);
   var reporter = new this._reporter(runner, options);
-  runner.ignoreLeaks = false !== options.ignoreLeaks;
+  runner.ignoreLeaks = options.ignoreLeaks !== false;
   runner.fullStackTrace = options.fullStackTrace;
   runner.asyncOnly = options.asyncOnly;
-  if (options.grep) runner.grep(options.grep, options.invert);
-  if (options.globals) runner.globals(options.globals);
-  if (options.growl) this._growl(runner, reporter);
+  runner.allowUncaught = options.allowUncaught;
+  if (options.grep) {
+    runner.grep(options.grep, options.invert);
+  }
+  if (options.globals) {
+    runner.globals(options.globals);
+  }
+  if (options.growl) {
+    this._growl(runner, reporter);
+  }
   if (options.useColors !== undefined) {
     exports.reporters.Base.useColors = options.useColors;
   }
   exports.reporters.Base.inlineDiffs = options.useInlineDiffs;
 
   function done(failures) {
-      if (reporter.done) {
-          reporter.done(failures, fn);
-      } else fn && fn(failures);
+    if (reporter.done) {
+      reporter.done(failures, fn);
+    } else {
+      fn && fn(failures);
+    }
   }
 
   return runner.run(done);

package/lib/ms.js

@@ -15,29 +15,32 @@ var y = d * 365.25;
  *
  *  - `long` verbose formatting [false]
  *
- * @param {String|Number} val
- * @param {Object} options
- * @return {String|Number}
  * @api public
+ * @param {string|number} val
+ * @param {Object} options
+ * @return {string|number}
  */
-
-module.exports = function(val, options){
+module.exports = function(val, options) {
   options = options || {};
-  if ('string' == typeof val) return parse(val);
+  if (typeof val === 'string') {
+    return parse(val);
+  }
+  // https://github.com/mochajs/mocha/pull/1035
   return options['long'] ? longFormat(val) : shortFormat(val);
 };
 
 /**
  * Parse the given `str` and return milliseconds.
  *
- * @param {String} str
- * @return {Number}
  * @api private
+ * @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);
-  if (!match) return;
+  var match = (/^((?:\d+)?\.?\d+) *(ms|seconds?|s|minutes?|m|hours?|h|days?|d|years?|y)?$/i).exec(str);
+  if (!match) {
+    return;
+  }
   var n = parseFloat(match[1]);
   var type = (match[2] || 'ms').toLowerCase();
   switch (type) {
@@ -63,33 +66,41 @@ function parse(str) {
       return n * s;
     case 'ms':
       return n;
+    default:
+      // No default case
   }
 }
 
 /**
  * Short format for `ms`.
  *
- * @param {Number} ms
- * @return {String}
  * @api private
+ * @param {number} ms
+ * @return {string}
  */
-
 function shortFormat(ms) {
-  if (ms >= d) return Math.round(ms / d) + 'd';
-  if (ms >= h) return Math.round(ms / h) + 'h';
-  if (ms >= m) return Math.round(ms / m) + 'm';
-  if (ms >= s) return Math.round(ms / s) + 's';
+  if (ms >= d) {
+    return Math.round(ms / d) + 'd';
+  }
+  if (ms >= h) {
+    return Math.round(ms / h) + 'h';
+  }
+  if (ms >= m) {
+    return Math.round(ms / m) + 'm';
+  }
+  if (ms >= s) {
+    return Math.round(ms / s) + 's';
+  }
   return ms + 'ms';
 }
 
 /**
  * Long format for `ms`.
  *
- * @param {Number} ms
- * @return {String}
  * @api private
+ * @param {number} ms
+ * @return {string}
  */
-
 function longFormat(ms) {
   return plural(ms, d, 'day')
     || plural(ms, h, 'hour')
@@ -100,10 +111,18 @@ function longFormat(ms) {
 
 /**
  * Pluralization helper.
+ *
+ * @api private
+ * @param {number} ms
+ * @param {number} n
+ * @param {string} name
  */
-
 function plural(ms, n, name) {
-  if (ms < n) return;
-  if (ms < n * 1.5) return Math.floor(ms / n) + ' ' + name;
+  if (ms < n) {
+    return;
+  }
+  if (ms < n * 1.5) {
+    return Math.floor(ms / n) + ' ' + name;
+  }
   return Math.ceil(ms / n) + ' ' + name + 's';
 }

package/lib/pending.js

@@ -8,9 +8,8 @@ module.exports = Pending;
 /**
  * Initialize a new `Pending` error with the given message.
  *
- * @param {String} message
+ * @param {string} message
  */
-
 function Pending(message) {
-    this.message = message;
+  this.message = message;
 }