mocha 5.0.4 → 5.2.0

package/CHANGELOG.md

@@ -1,3 +1,113 @@
+# 5.2.0 / 2018-05-18
+
+## :tada: Enhancements
+
+- [#3375]: Add support for comments in `mocha.opts` ([@plroebuck])
+
+## :bug: Fixes
+
+- [#3346]: Exit correctly from `before` hooks when using `--bail` ([@outsideris])
+
+## :book: Documentation
+
+- [#3328]: Mocha-flavored [API docs](https://mochajs.org/api/)! ([@Munter])
+
+## :nut_and_bolt: Other
+
+- [#3330]: Use `Buffer.from()` ([@harrysarson])
+- [#3295]: Remove redundant folder ([@DavNej])
+- [#3356]: Refactoring ([@plroebuck])
+
+[#3375]: https://github.com/mochajs/mocha/pull/3375
+[#3346]: https://github.com/mochajs/mocha/pull/3346
+[#3328]: https://github.com/mochajs/mocha/pull/3328
+[#3330]: https://github.com/mochajs/mocha/pull/3330
+[#3295]: https://github.com/mochajs/mocha/pull/3295
+[#3356]: https://github.com/mochajs/mocha/pull/3356
+
+[@plroebuck]: https://github.com/plroebuck
+[@harrysarson]: https://github.com/harrysarson
+[@outsideris]: https://github.com/outsideris
+[@Munter]: https://github.com/Munter
+
+# 5.1.1 / 2018-04-18
+
+## :bug: Fixes
+
+- [#3325]: Revert change which broke `--watch` ([@boneskull])
+
+[#3325]: https://github.com/mochajs/mocha/issues/3325
+
+# 5.1.0 / 2018-04-12
+
+## :tada: Enhancements
+
+- [#3210]: Add `--exclude` option ([@metalex9])
+
+## :bug: Fixes
+
+- [#3318]: Fix failures in circular objects in JSON reporter ([@jeversmann], [@boneskull])
+
+## :book: Documentation
+
+- [#3323]: Publish actual [API documentation](https://mochajs.org/api/)! ([@dfberry], [@Munter])
+- [#3299]: Improve docs around exclusive tests ([@nicgirault])
+
+## :nut_and_bolt: Other
+
+- [#3302], [#3308], [#3310], [#3315], [#3316]: Build matrix improvements ([more info](https://boneskull.com/mocha-and-travis-ci-build-stages/)) ([@outsideris], [@boneskull])
+- [#3272]: Refactor reporter tests ([@jMuzsik])
+
+[#3210]: https://github.com/mochajs/mocha/pull/3210
+[#3318]: https://github.com/mochajs/mocha/pull/3318
+[#3323]: https://github.com/mochajs/mocha/pull/3323
+[#3299]: https://github.com/mochajs/mocha/pull/3299
+[#3302]: https://github.com/mochajs/mocha/pull/3302
+[#3308]: https://github.com/mochajs/mocha/pull/3308
+[#3310]: https://github.com/mochajs/mocha/pull/3310
+[#3315]: https://github.com/mochajs/mocha/pull/3315
+[#3316]: https://github.com/mochajs/mocha/pull/3316
+[#3272]: https://github.com/mochajs/mocha/pull/3272
+[@metalex9]: https://github.com/metalex9
+[@jeversmann]: https://github.com/jeversmann
+[@dfberry]: https://github.com/dfberry
+[@nicgirault]: https://github.com/nicgirault
+[@jMuzsik]: https://github.com/jMuzsik
+
+# 5.0.5 / 2018-03-22
+
+Welcome [@outsideris] to the team!
+
+## :bug: Fixes
+
+- [#3096]: Fix `--bail` failing to bail within hooks ([@outsideris])
+- [#3184]: Don't skip too many suites (using `describe.skip()`) ([@outsideris])
+
+## :book: Documentation
+
+- [#3133]: Improve docs regarding "pending" behavior ([@ematicipo])
+- [#3276], [#3274]: Fix broken stuff in `CHANGELOG.md` ([@tagoro9], [@honzajavorek])
+
+## :nut_and_bolt: Other
+
+- [#3208]: Improve test coverage for AMD users ([@outsideris])
+- [#3267]: Remove vestiges of PhantomJS from CI ([@anishkny])
+- [#2952]: Fix a debug message ([@boneskull])
+
+[#3096]: https://github.com/mochajs/mocha/issues/3096
+[#3184]: https://github.com/mochajs/mocha/issues/3184
+[#3133]: https://github.com/mochajs/mocha/issues/3133
+[#3276]: https://github.com/mochajs/mocha/pull/3276
+[#3274]: https://github.com/mochajs/mocha/pull/3274
+[#3208]: https://github.com/mochajs/mocha/issues/3208
+[#2952]: https://github.com/mochajs/mocha/issues/2952
+[#3267]: https://github.com/mochajs/mocha/pull/3267
+
+[@ematicipo]: https://github.com/ematicipo
+[@tagoro9]: https://github.com/tagoro9
+[@honzajavorek]: https://github.com/honajavorek
+[@anishkny]: https://github.com/anishkny
+
 # 5.0.4 / 2018-03-07
 
 ## :bug: Fixes
@@ -52,7 +162,7 @@ This release fixes a class of tests which report as *false positives*.  **Certai
   **Maintainers of external reporters**: *If* a test of this class is encountered, the `Runner` instance will emit the `end` event *twice*; you *may* need to change your reporter to use `runner.once('end')` intead of `runner.on('end')`.
 - [#3093]: Fix stack trace reformatting problem ([@outsideris])
 
-## :nut_and_bolt Other
+## :nut_and_bolt: Other
 
 - [#3248]: Update `browser-stdout` to v1.3.1 ([@honzajavorek])
 
@@ -87,10 +197,10 @@ Special thanks to [Wallaby.js](https://wallabyjs.com) for their continued suppor
 [#3119]: https://github.com/mochajs/mocha/issues/3119
 [#3132]: https://github.com/mochajs/mocha/issues/3132
 [#3098]: https://github.com/mochajs/mocha/issues/3098
-[#3212]: https://github.com/mochajs/mocha/pulls/3212
-[#3205]: https://github.com/mochajs/mocha/pulls/3205
-[#3224]: https://github.com/mochajs/mocha/pulls/3224
-[#3230]: https://github.com/mochajs/mocha/pulls/3230
+[#3212]: https://github.com/mochajs/mocha/pull/3212
+[#3205]: https://github.com/mochajs/mocha/pull/3205
+[#3224]: https://github.com/mochajs/mocha/pull/3224
+[#3230]: https://github.com/mochajs/mocha/pull/3230
 [@silviom]: https://github.com/silviom
 [@outsideris]: https://github.com/outsideris
 [@ArtemGovorov]: https://github.com/ArtemGovorov
@@ -350,9 +460,9 @@ For more info, please [read this article](https://boneskull.com/mocha-v4-nears-r
 - Various CI-and-test-related fixes and improvements ([@boneskull], [@dasilvacontin], [@PopradiArpad], [@Munter], [@ScottFreeCode])
 - "Officially" support Node.js 8 ([@elergy])
 
-[#2860]: https://github.com/mochajs/mocha/pulls/2860
-[#2696]: https://github.com/mochajs/mocha/pulls/2696
-[#2813]: https://github.com/mochajs/mocha/pulls/2813
+[#2860]: https://github.com/mochajs/mocha/pull/2860
+[#2696]: https://github.com/mochajs/mocha/pull/2696
+[#2813]: https://github.com/mochajs/mocha/pull/2813
 [@charlierudolph]: https://github.com/charlierudolph
 [@PopradiArpad]: https://github.com/PopradiArpad
 [@kungapal]: https://github.com/kungapal
@@ -374,7 +484,7 @@ For more info, please [read this article](https://boneskull.com/mocha-v4-nears-r
 [@makepanic]: https://github.com/makepanic
 [@Munter]: https://github.com/Munter
 
-[#2778]: https://github.com/mochajs/mocha/pulls/2778
+[#2778]: https://github.com/mochajs/mocha/pull/2778
 [#2802]: https://github.com/mochajs/mocha/issues/2802
 [#2820]: https://github.com/mochajs/mocha/pull/2820
 

package/bin/_mocha

@@ -10,6 +10,7 @@
 const program = require('commander');
 const path = require('path');
 const fs = require('fs');
+const minimatch = require('minimatch');
 const resolve = path.resolve;
 const exists = fs.existsSync;
 const Mocha = require('../');
@@ -57,7 +58,7 @@ const exit = code => {
   // https://github.com/joyent/node/issues/6247 is just one bug example
   // https://github.com/visionmedia/mocha/issues/333 has a good discussion
   const done = () => {
-    if (!(draining--)) {
+    if (!draining--) {
       process.exit(clampedCode);
     }
   };
@@ -142,16 +143,23 @@ const requires = [];
  */
 
 const images = {
-  fail: path.join(__dirname, '..', 'images', 'error.png'),
-  pass: path.join(__dirname, '..', 'images', 'ok.png')
+  fail: path.join(__dirname, '..', 'assets', 'growl', 'error.png'),
+  pass: path.join(__dirname, '..', 'assets', 'growl', 'ok.png')
 };
 
 // options
 
 program
-  .version(JSON.parse(fs.readFileSync(path.join(__dirname, '..', 'package.json'), 'utf8')).version)
+  .version(
+    JSON.parse(
+      fs.readFileSync(path.join(__dirname, '..', 'package.json'), 'utf8')
+    ).version
+  )
   .usage('[debug] [options] [files]')
-  .option('-A, --async-only', 'force all tests to take a callback (async) or return a promise')
+  .option(
+    '-A, --async-only',
+    'force all tests to take a callback (async) or return a promise'
+  )
   .option('-c, --colors', 'force enabling of colors')
   .option('-C, --no-colors', 'force disabling of colors')
   .option('-G, --growl', 'enable growl notification support')
@@ -167,24 +175,53 @@ program
   .option('-r, --require <name>', 'require the given module')
   .option('-s, --slow <ms>', '"slow" test threshold in milliseconds [75]')
   .option('-t, --timeout <ms>', 'set test-case timeout in milliseconds [2000]')
-  .option('-u, --ui <name>', `specify user-interface (${interfaceNames.join('|')})`, 'bdd')
+  .option(
+    '-u, --ui <name>',
+    `specify user-interface (${interfaceNames.join('|')})`,
+    'bdd'
+  )
   .option('-w, --watch', 'watch files for changes')
   .option('--check-leaks', 'check for global variable leaks')
   .option('--full-trace', 'display the full stack trace')
-  .option('--compilers <ext>:<module>,...', 'use the given module(s) to compile files', list, [])
+  .option(
+    '--compilers <ext>:<module>,...',
+    'use the given module(s) to compile files',
+    list,
+    []
+  )
   .option('--debug-brk', "enable node's debugger breaking on the first line")
-  .option('--globals <names>', 'allow the given comma-delimited global [names]', list, [])
+  .option(
+    '--globals <names>',
+    'allow the given comma-delimited global [names]',
+    list,
+    []
+  )
   .option('--es_staging', 'enable all staged features')
-  .option('--harmony<_classes,_generators,...>', 'all node --harmony* flags are available')
-  .option('--preserve-symlinks', 'Instructs the module loader to preserve symbolic links when resolving and caching modules')
+  .option(
+    '--harmony<_classes,_generators,...>',
+    'all node --harmony* flags are available'
+  )
+  .option(
+    '--preserve-symlinks',
+    'Instructs the module loader to preserve symbolic links when resolving and caching modules'
+  )
   .option('--icu-data-dir', 'include ICU data')
-  .option('--inline-diffs', 'display actual/expected differences inline within each string')
+  .option(
+    '--inline-diffs',
+    'display actual/expected differences inline within each string'
+  )
   .option('--no-diff', 'do not show a diff on failure')
   .option('--inspect', 'activate devtools in chrome')
-  .option('--inspect-brk', 'activate devtools in chrome and break on the first line')
+  .option(
+    '--inspect-brk',
+    'activate devtools in chrome and break on the first line'
+  )
   .option('--interfaces', 'display available interfaces')
   .option('--no-deprecation', 'silence deprecation warnings')
-  .option('--exit', 'force shutdown of the event loop after test run: mocha will call process.exit')
+  .option(
+    '--exit',
+    'force shutdown of the event loop after test run: mocha will call process.exit'
+  )
   .option('--no-timeouts', 'disables timeouts, given implicitly with --debug')
   .option('--no-warnings', 'silence all node process warnings')
   .option('--opts <path>', 'specify opts path', 'test/mocha.opts')
@@ -194,18 +231,38 @@ program
   .option('--log-timer-events', 'Time events including external callbacks')
   .option('--recursive', 'include sub directories')
   .option('--reporters', 'display available reporters')
-  .option('--retries <times>', 'set numbers of time to retry a failed test case')
-  .option('--throw-deprecation', 'throw an exception anytime a deprecated function is used')
+  .option(
+    '--retries <times>',
+    'set numbers of time to retry a failed test case'
+  )
+  .option(
+    '--throw-deprecation',
+    'throw an exception anytime a deprecated function is used'
+  )
   .option('--trace', 'trace function calls')
   .option('--trace-deprecation', 'show stack traces on deprecations')
   .option('--trace-warnings', 'show stack traces on node process warnings')
   .option('--use_strict', 'enforce strict mode')
-  .option('--watch-extensions <ext>,...', 'additional extensions to monitor with --watch', list, [])
+  .option(
+    '--watch-extensions <ext>,...',
+    'additional extensions to monitor with --watch',
+    list,
+    ['js']
+  )
   .option('--delay', 'wait for async suite definition')
   .option('--allow-uncaught', 'enable uncaught errors to propagate')
   .option('--forbid-only', 'causes test marked with only to fail the suite')
-  .option('--forbid-pending', 'causes pending tests and test marked with skip to fail the suite')
-  .option('--file <file>', 'include a file to be ran during the suite', collect, []);
+  .option(
+    '--forbid-pending',
+    'causes pending tests and test marked with skip to fail the suite'
+  )
+  .option(
+    '--file <file>',
+    'include a file to be ran during the suite',
+    collect,
+    []
+  )
+  .option('--exclude <file>', 'a file or glob pattern to ignore', collect, []);
 
 program._name = 'mocha';
 
@@ -310,19 +367,6 @@ if (program.reporterOptions !== undefined) {
 
 mocha.reporter(program.reporter, reporterOptions);
 
-// load reporter
-
-let Reporter = null;
-try {
-  Reporter = require(`../lib/reporters/${program.reporter}`);
-} catch (err) {
-  try {
-    Reporter = require(program.reporter);
-  } catch (err2) {
-    throw new Error(`reporter "${program.reporter}" does not exist`);
-  }
-}
-
 // --no-colors
 
 if (!program.colors) {
@@ -445,7 +489,7 @@ if (program.forbidPending) mocha.forbidPending();
 
 if (program.compilers.length > 0) {
   require('util').deprecate(() => {},
-    '"--compilers" will be removed in a future version of Mocha; see https://git.io/vdcSr for more info')();
+  '"--compilers" will be removed in a future version of Mocha; see https://git.io/vdcSr for more info')();
 }
 const extensions = ['js'];
 program.compilers.forEach(c => {
@@ -487,13 +531,24 @@ args.forEach(arg => {
     newFiles = utils.lookupFiles(arg, extensions, program.recursive);
   } catch (err) {
     if (err.message.indexOf('cannot resolve path') === 0) {
-      console.error(`Warning: Could not find any test files matching pattern: ${arg}`);
+      console.error(
+        `Warning: Could not find any test files matching pattern: ${arg}`
+      );
       return;
     }
 
     throw err;
   }
 
+  if (typeof newFiles !== 'undefined') {
+    if (typeof newFiles === 'string') {
+      newFiles = [newFiles];
+    }
+    newFiles = newFiles.filter(fileName =>
+      program.exclude.every(pattern => !minimatch(fileName, pattern))
+    );
+  }
+
   files = files.concat(newFiles);
 });
 
@@ -529,7 +584,7 @@ if (program.watch) {
     process.exit(130);
   });
 
-  const watchFiles = utils.files(cwd, [ 'js' ].concat(program.watchExtensions));
+  const watchFiles = utils.files(cwd, ['js'].concat(program.watchExtensions));
   let runAgain = false;
 
   loadAndRun = () => {
@@ -576,7 +631,7 @@ if (program.watch) {
     }
   });
 } else {
-// load
+  // load
 
   mocha.files = files;
   runner = mocha.run(program.exit ? exit : exitLater);

package/bin/options.js

@@ -16,17 +16,23 @@ module.exports = getOptions;
  * Get options.
  */
 
-function getOptions () {
-  if (process.argv.length === 3 && (process.argv[2] === '-h' || process.argv[2] === '--help')) {
+function getOptions() {
+  if (
+    process.argv.length === 3 &&
+    (process.argv[2] === '-h' || process.argv[2] === '--help')
+  ) {
     return;
   }
 
-  const optsPath = process.argv.indexOf('--opts') === -1
-    ? 'test/mocha.opts'
-    : process.argv[process.argv.indexOf('--opts') + 1];
+  const optsPath =
+    process.argv.indexOf('--opts') === -1
+      ? 'test/mocha.opts'
+      : process.argv[process.argv.indexOf('--opts') + 1];
 
   try {
-    const opts = fs.readFileSync(optsPath, 'utf8')
+    const opts = fs
+      .readFileSync(optsPath, 'utf8')
+      .replace(/^#.*$/gm, '')
       .replace(/\\\s/g, '%20')
       .split(/\s/)
       .filter(Boolean)
@@ -35,8 +41,8 @@ function getOptions () {
     process.argv = process.argv
       .slice(0, 2)
       .concat(opts.concat(process.argv.slice(2)));
-  } catch (err) {
-    // ignore
+  } catch (ignore) {
+    // NOTE: should console.error() and throw the error
   }
 
   process.env.LOADED_MOCHA_OPTS = true;

package/browser-entry.js

@@ -17,7 +17,7 @@ var Mocha = require('./lib/mocha');
  * @return {undefined}
  */
 
-var mocha = new Mocha({ reporter: 'html' });
+var mocha = new Mocha({reporter: 'html'});
 
 /**
  * Save timer references to avoid Sinon interfering (see GH-237).
@@ -38,12 +38,12 @@ var originalOnerrorHandler = global.onerror;
  * Revert to original onerror handler if previously defined.
  */
 
-process.removeListener = function (e, fn) {
+process.removeListener = function(e, fn) {
   if (e === 'uncaughtException') {
     if (originalOnerrorHandler) {
       global.onerror = originalOnerrorHandler;
     } else {
-      global.onerror = function () {};
+      global.onerror = function() {};
     }
     var i = uncaughtExceptionHandlers.indexOf(fn);
     if (i !== -1) {
@@ -56,9 +56,9 @@ process.removeListener = function (e, fn) {
  * Implements uncaughtException listener.
  */
 
-process.on = function (e, fn) {
+process.on = function(e, fn) {
   if (e === 'uncaughtException') {
-    global.onerror = function (err, url, line) {
+    global.onerror = function(err, url, line) {
       fn(new Error(err + ' (' + url + ':' + line + ')'));
       return !mocha.allowUncaught;
     };
@@ -74,9 +74,9 @@ mocha.suite.removeAllListeners('pre-require');
 var immediateQueue = [];
 var immediateTimeout;
 
-function timeslice () {
+function timeslice() {
   var immediateStart = new Date().getTime();
-  while (immediateQueue.length && (new Date().getTime() - immediateStart) < 100) {
+  while (immediateQueue.length && new Date().getTime() - immediateStart < 100) {
     immediateQueue.shift()();
   }
   if (immediateQueue.length) {
@@ -90,7 +90,7 @@ function timeslice () {
  * High-performance override of Runner.immediately.
  */
 
-Mocha.Runner.immediately = function (callback) {
+Mocha.Runner.immediately = function(callback) {
   immediateQueue.push(callback);
   if (!immediateTimeout) {
     immediateTimeout = setTimeout(timeslice, 0);
@@ -102,8 +102,8 @@ Mocha.Runner.immediately = function (callback) {
  * This is useful when running tests in a browser because window.onerror will
  * only receive the 'message' attribute of the Error.
  */
-mocha.throwError = function (err) {
-  uncaughtExceptionHandlers.forEach(function (fn) {
+mocha.throwError = function(err) {
+  uncaughtExceptionHandlers.forEach(function(fn) {
     fn(err);
   });
   throw err;
@@ -114,7 +114,7 @@ mocha.throwError = function (err) {
  * Normally this would happen in Mocha.prototype.loadFiles.
  */
 
-mocha.ui = function (ui) {
+mocha.ui = function(ui) {
   Mocha.prototype.ui.call(this, ui);
   this.suite.emit('pre-require', global, null, this);
   return this;
@@ -124,9 +124,9 @@ mocha.ui = function (ui) {
  * Setup mocha with the given setting options.
  */
 
-mocha.setup = function (opts) {
+mocha.setup = function(opts) {
   if (typeof opts === 'string') {
-    opts = { ui: opts };
+    opts = {ui: opts};
   }
   for (var opt in opts) {
     if (opts.hasOwnProperty(opt)) {
@@ -140,7 +140,7 @@ mocha.setup = function (opts) {
  * Run mocha, returning the Runner.
  */
 
-mocha.run = function (fn) {
+mocha.run = function(fn) {
   var options = mocha.options;
   mocha.globals('location');
 
@@ -155,10 +155,14 @@ mocha.run = function (fn) {
     mocha.invert();
   }
 
-  return Mocha.prototype.run.call(mocha, function (err) {
+  return Mocha.prototype.run.call(mocha, function(err) {
     // The DOM Document is not available in Web Workers.
     var document = global.document;
-    if (document && document.getElementById('mocha') && options.noHighlighting !== true) {
+    if (
+      document &&
+      document.getElementById('mocha') &&
+      options.noHighlighting !== true
+    ) {
       Mocha.utils.highlightTags('code');
     }
     if (fn) {

package/lib/browser/progress.js

@@ -9,7 +9,7 @@ module.exports = Progress;
 /**
  * Initialize a new `Progress` indicator.
  */
-function Progress () {
+function Progress() {
   this.percent = 0;
   this.size(0);
   this.fontSize(11);
@@ -23,7 +23,7 @@ function Progress () {
  * @param {number} size
  * @return {Progress} Progress instance.
  */
-Progress.prototype.size = function (size) {
+Progress.prototype.size = function(size) {
   this._size = size;
   return this;
 };
@@ -35,7 +35,7 @@ Progress.prototype.size = function (size) {
  * @param {string} text
  * @return {Progress} Progress instance.
  */
-Progress.prototype.text = function (text) {
+Progress.prototype.text = function(text) {
   this._text = text;
   return this;
 };
@@ -47,7 +47,7 @@ Progress.prototype.text = function (text) {
  * @param {number} size
  * @return {Progress} Progress instance.
  */
-Progress.prototype.fontSize = function (size) {
+Progress.prototype.fontSize = function(size) {
   this._fontSize = size;
   return this;
 };
@@ -58,7 +58,7 @@ Progress.prototype.fontSize = function (size) {
  * @param {string} family
  * @return {Progress} Progress instance.
  */
-Progress.prototype.font = function (family) {
+Progress.prototype.font = function(family) {
   this._font = family;
   return this;
 };
@@ -69,7 +69,7 @@ Progress.prototype.font = function (family) {
  * @param {number} n
  * @return {Progress} Progress instance.
  */
-Progress.prototype.update = function (n) {
+Progress.prototype.update = function(n) {
   this.percent = n;
   return this;
 };
@@ -80,7 +80,7 @@ Progress.prototype.update = function (n) {
  * @param {CanvasRenderingContext2d} ctx
  * @return {Progress} Progress instance.
  */
-Progress.prototype.draw = function (ctx) {
+Progress.prototype.draw = function(ctx) {
   try {
     var percent = Math.min(this.percent, 100);
     var size = this._size;
@@ -112,7 +112,7 @@ Progress.prototype.draw = function (ctx) {
     var w = ctx.measureText(text).width;
 
     ctx.fillText(text, x - w / 2 + 1, y + fontSize / 2 - 1);
-  } catch (err) {
+  } catch (ignore) {
     // don't fail if we can't render progress
   }
   return this;

package/lib/browser/tty.js

@@ -1,10 +1,10 @@
 'use strict';
 
-exports.isatty = function isatty () {
+exports.isatty = function isatty() {
   return true;
 };
 
-exports.getWindowSize = function getWindowSize () {
+exports.getWindowSize = function getWindowSize() {
   if ('innerHeight' in global) {
     return [global.innerHeight, global.innerWidth];
   }