mocha 3.0.2 → 3.2.0

package/CHANGELOG.md

@@ -1,3 +1,106 @@
+# 3.2.0 / 2016-11-24
+
+## :newspaper: News
+
+### Mocha is now a JS Foundation Project!
+
+Mocha is proud to have joined the [JS Foundation](https://js.foundation).  For more information, [read the announcement](https://js.foundation/announcements/2016/10/17/Linux-Foundation-Unites-JavaScript-Community-Open-Web-Development/).
+
+### Contributor License Agreement
+
+Under the foundation, all contributors to Mocha must sign the [JS Foundation CLA](https://js.foundation/CLA/) before their code can be merged.  When sending a PR--if you have not already signed the CLA--a friendly bot will ask you to do so.
+
+Mocha remains licensed under the [MIT license](https://github.com/mochajs/mocha/blob/master/LICENSE).
+
+## :bug: Bug Fix
+
+- [#2535]: Fix crash when `--watch` encounters broken symlinks ([@villesau])
+- [#2593]: Fix (old) regression; incorrect symbol shown in `list` reporter ([@Aldaviva])
+- [#2584]: Fix potential error when running XUnit reporter ([@vobujs])
+
+## :tada: Enhancement
+
+- [#2294]: Improve timeout error messaging ([@jeversmann], [@boneskull])
+- [#2520]: Add info about `--inspect` flag to CLI help ([@ughitsaaron])
+
+## :nut_and_bolt: Other
+
+- [#2570]: Use [karma-mocha](https://npmjs.com/package/karma-mocha) proper ([@boneskull])
+- Licenses updated to reflect new copyright, add link to license and browser matrix to `README.md` ([@boneskull], [@ScottFreeCode], [@dasilvacontin])
+
+[#2294]: https://github.com/mochajs/mocha/issues/2294
+[#2535]: https://github.com/mochajs/mocha/issues/2535
+[#2520]: https://github.com/mochajs/mocha/pull/2520
+[#2593]: https://github.com/mochajs/mocha/pull/2593
+[#2584]: https://github.com/mochajs/mocha/issues/2584
+[#2570]: https://github.com/mochajs/mocha/issues/2570
+[@Aldaviva]: https://github.com/Aldaviva
+[@jeversmann]: https://github.com/jeversmann
+[@ughitsaaron]: https://github.com/ughitsaaron
+[@villesau]: https://github.com/villesau
+[@vobujs]: https://github.com/vobujs
+
+Thanks to all our contributors, sponsors and backers!  Keep on the lookout for a public roadmap and new contribution guide coming soon.
+
+# 3.1.2 / 2016-10-10
+
+## :bug: Bug Fix
+
+- [#2528]: Recovery gracefully if an `Error`'s `stack` property isn't writable ([@boneskull])
+
+[#2528]: https://github.com/mochajs/mocha/issues/2528
+
+# 3.1.1 / 2016-10-09
+
+## :bug: Bug Fix
+
+- [#1417]: Don't report `done()` was called multiple times when it wasn't ([@frankleonrose])
+ 
+## :nut_and_bolt: Other
+
+- [#2490]: Lint with [semistandard](https://npmjs.com/package/semistandard) config ([@makepanic])
+- [#2525]: Lint all `.js` files ([@boneskull])
+- [#2524]: Provide workaround for developers unable to run browser tests on macOS Sierra ([@boneskull])
+
+[#1417]: https://github.com/mochajs/mocha/issues/1417
+[#2490]: https://github.com/mochajs/mocha/issues/2490
+[#2525]: https://github.com/mochajs/mocha/issues/2525
+[#2524]: https://github.com/mochajs/mocha/issues/2524
+[@makepanic]: https://github.com/makepanic
+[@frankleonrose]: https://github.com/frankleonrose
+
+# 3.1.0 / 2016-09-27
+
+## :tada: Enhancement
+
+- [#2357]: Support `--inspect` on command-line ([@simov])
+- [#2194]: Human-friendly error if no files are matched on command-line ([@Munter])
+- [#1744]: Human-friendly error if a Suite has no callback (BDD/TDD only) ([@anton])
+
+## :bug: Bug Fix
+
+- [#2488]: Fix case in which *variables beginning with lowercase "D"* may not have been reported properly as global leaks ([@JustATrick]) :laughing:
+- [#2465]: Always halt execution in async function when `this.skip()` is called ([@boneskull])
+- [#2445]: Exits with expected code 130 when `SIGINT` encountered; exit code can no longer rollover at 256 ([@Munter])
+- [#2315]: Fix uncaught TypeError thrown from callback stack ([@1999])
+- Fix broken `only()`/`skip()` in IE7/IE8 ([@boneskull])
+- [#2502]: Fix broken stack trace filter on Node.js under Windows ([@boneskull]) 
+- [#2496]: Fix diff output for objects instantiated with `String` constructor ([more](https://youtrack.jetbrains.com/issue/WEB-23383)) ([@boneskull])
+
+[#2496]: https://github.com/mochajs/mocha/issues/2496
+[#2502]: https://github.com/mochajs/mocha/issues/2502
+[#2315]: https://github.com/mochajs/mocha/issues/2315
+[#2445]: https://github.com/mochajs/mocha/pull/2445
+[#2465]: https://github.com/mochajs/mocha/issues/2465
+[#2488]: https://github.com/mochajs/mocha/issues/2488
+[#1744]: https://github.com/mochajs/mocha/issues/1744
+[#2194]: https://github.com/mochajs/mocha/issues/2194
+[#2357]: https://github.com/mochajs/mocha/issues/2357
+[@1999]: https://github.com/1999
+[@JustATrick]: https://github.com/JustATrick
+[@anton]: https://github.com/anton
+[@simov]: https://github.com/simov
+
 # 3.0.2 / 2016-08-08
 
 ## :bug: Bug Fix

package/LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2011-2016 TJ Holowaychuk <tj@vision-media.ca>
+Copyright (c) 2016 JS Foundation and contributors, https://js.foundation
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

package/README.md

@@ -2,11 +2,11 @@
 <p align="center">
   <img src="https://cldup.com/xFVFxOioAU.svg" alt="Mocha test framework"/>
 </p>
-<br><br>
 
 [![Build Status](https://api.travis-ci.org/mochajs/mocha.svg?branch=master)](http://travis-ci.org/mochajs/mocha) [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/mochajs/mocha?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![OpenCollective](https://opencollective.com/mochajs/backers/badge.svg)](#backers)
 [![OpenCollective](https://opencollective.com/mochajs/sponsors/badge.svg)](#sponsors)
+<br><img alt="Mocha Browser Support h/t SauceLabs" src="https://saucelabs.com/browser-matrix/mochajs.svg" width="354">
 
   Mocha is a simple, flexible, fun JavaScript test framework for node.js and the browser. For more information view the [documentation](http://mochajs.org).
 
@@ -81,4 +81,4 @@ Does your company use Mocha?  Ask your manager or marketing team if your company
 
 ## License
 
-MIT
+[MIT](LICENSE)

package/bin/_mocha

@@ -1,31 +1,34 @@
 #!/usr/bin/env node
+'use strict';
+
+/* eslint no-unused-vars: off */
 
 /**
  * Module dependencies.
  */
 
-var program = require('commander'),
-  path = require('path'),
-  fs = require('fs'),
-  resolve = path.resolve,
-  exists = fs.existsSync || path.existsSync,
-  Mocha = require('../'),
-  utils = Mocha.utils,
-  interfaceNames = Object.keys(Mocha.interfaces),
-  join = path.join,
-  cwd = process.cwd(),
-  getOptions = require('./options'),
-  mocha = new Mocha;
+var program = require('commander');
+var path = require('path');
+var fs = require('fs');
+var resolve = path.resolve;
+var exists = fs.existsSync || path.existsSync;
+var Mocha = require('../');
+var utils = Mocha.utils;
+var interfaceNames = Object.keys(Mocha.interfaces);
+var join = path.join;
+var cwd = process.cwd();
+var getOptions = require('./options');
+var mocha = new Mocha();
 
 /**
  * Save timer references to avoid Sinon interfering (see GH-237).
  */
 
-var Date = global.Date
-  , setTimeout = global.setTimeout
-  , setInterval = global.setInterval
-  , clearTimeout = global.clearTimeout
-  , clearInterval = global.clearInterval;
+var Date = global.Date;
+var setTimeout = global.setTimeout;
+var setInterval = global.setInterval;
+var clearTimeout = global.clearTimeout;
+var clearInterval = global.clearInterval;
 
 /**
  * Files.
@@ -50,23 +53,23 @@ var requires = [];
  */
 
 var images = {
-    fail: __dirname + '/../images/error.png'
-  , pass: __dirname + '/../images/ok.png'
+  fail: path.join(__dirname, '..', 'images', 'error.png'),
+  pass: path.join(__dirname, '..', 'images', 'ok.png')
 };
 
 // options
 
 program
-  .version(JSON.parse(fs.readFileSync(__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')
   .option('-O, --reporter-options <k=v,k2=v2,...>', 'reporter-specific options')
   .option('-R, --reporter <name>', 'specify the reporter to use', 'spec')
-  .option('-S, --sort', "sort test files")
-  .option('-b, --bail', "bail after first test failure")
+  .option('-S, --sort', 'sort test files')
+  .option('-b, --bail', 'bail after first test failure')
   .option('-d, --debug', "enable node's debugger, synonym for node --debug")
   .option('-g, --grep <pattern>', 'only run tests matching <pattern>')
   .option('-f, --fgrep <string>', 'only run tests containing <string>')
@@ -87,6 +90,7 @@ program
   .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('--inspect', 'activate devtools in chrome')
   .option('--interfaces', 'display available interfaces')
   .option('--no-deprecation', 'silence deprecation warnings')
   .option('--no-exit', 'require a clean shutdown of the event loop: mocha will not call process.exit')
@@ -103,7 +107,7 @@ program
   .option('--trace-deprecation', 'show stack traces on deprecations')
   .option('--use_strict', 'enforce strict mode')
   .option('--watch-extensions <ext>,...', 'additional extensions to monitor with --watch', list, [])
-  .option('--delay', 'wait for async suite definition')
+  .option('--delay', 'wait for async suite definition');
 
 program._name = 'mocha';
 
@@ -112,7 +116,7 @@ program._name = 'mocha';
 program
   .command('init <path>')
   .description('initialize a client-side mocha setup at <path>')
-  .action(function(path){
+  .action(function (path) {
     var mkdir = require('mkdirp');
     mkdir.sync(path);
     var css = fs.readFileSync(join(__dirname, '..', 'mocha.css'));
@@ -127,13 +131,13 @@ program
 
 // --globals
 
-program.on('globals', function(val){
+program.on('globals', function (val) {
   globals = globals.concat(list(val));
 });
 
 // --reporters
 
-program.on('reporters', function(){
+program.on('reporters', function () {
   console.log();
   console.log('    dot - dot matrix');
   console.log('    doc - html documentation');
@@ -154,9 +158,9 @@ program.on('reporters', function(){
 
 // --interfaces
 
-program.on('interfaces', function(){
+program.on('interfaces', function () {
   console.log('');
-  interfaceNames.forEach(function(interfaceName) {
+  interfaceNames.forEach(function (interfaceName) {
     console.log('    ' + interfaceName);
   });
   console.log('');
@@ -167,9 +171,11 @@ program.on('interfaces', function(){
 
 module.paths.push(cwd, join(cwd, 'node_modules'));
 
-program.on('require', function(mod){
+program.on('require', function (mod) {
   var abs = exists(mod) || exists(mod + '.js');
-  if (abs) mod = resolve(mod);
+  if (abs) {
+    mod = resolve(mod);
+  }
   requires.push(mod);
 });
 
@@ -190,16 +196,16 @@ Error.stackTraceLimit = Infinity; // TODO: config
 
 var reporterOptions = {};
 if (program.reporterOptions !== undefined) {
-    program.reporterOptions.split(",").forEach(function(opt) {
-        var L = opt.split("=");
-        if (L.length > 2 || L.length === 0) {
-            throw new Error("invalid reporter option '" + opt + "'");
-        } else if (L.length === 2) {
-            reporterOptions[L[0]] = L[1];
-        } else {
-            reporterOptions[L[0]] = true;
-        }
-    });
+  program.reporterOptions.split(',').forEach(function (opt) {
+    var L = opt.split('=');
+    if (L.length > 2 || L.length === 0) {
+      throw new Error("invalid reporter option '" + opt + "'");
+    } else if (L.length === 2) {
+      reporterOptions[L[0]] = L[1];
+    } else {
+      reporterOptions[L[0]] = true;
+    }
+  });
 }
 
 // reporter
@@ -214,37 +220,46 @@ try {
 } catch (err) {
   try {
     Reporter = require(program.reporter);
-  } catch (err) {
+  } catch (err2) {
     throw new Error('reporter "' + program.reporter + '" does not exist');
   }
 }
 
 // --no-colors
 
-if (!program.colors) mocha.useColors(false);
+if (!program.colors) {
+  mocha.useColors(false);
+}
 
 // --colors
 
-if (~process.argv.indexOf('--colors') ||
-    ~process.argv.indexOf('-c')) {
+if (~process.argv.indexOf('--colors') || ~process.argv.indexOf('-c')) {
   mocha.useColors(true);
 }
 
 // --inline-diffs
 
-if (program.inlineDiffs) mocha.useInlineDiffs(true);
+if (program.inlineDiffs) {
+  mocha.useInlineDiffs(true);
+}
 
 // --slow <ms>
 
-if (program.slow) mocha.suite.slow(program.slow);
+if (program.slow) {
+  mocha.suite.slow(program.slow);
+}
 
 // --no-timeouts
 
-if (!program.timeouts) mocha.enableTimeouts(false);
+if (!program.timeouts) {
+  mocha.enableTimeouts(false);
+}
 
 // --timeout
 
-if (program.timeout) mocha.suite.timeout(program.timeout);
+if (program.timeout) {
+  mocha.suite.timeout(program.timeout);
+}
 
 // --bail
 
@@ -252,35 +267,51 @@ mocha.suite.bail(program.bail);
 
 // --grep
 
-if (program.grep) mocha.grep(program.grep);
+if (program.grep) {
+  mocha.grep(program.grep);
+}
 
 // --fgrep
 
-if (program.fgrep) mocha.fgrep(program.fgrep);
+if (program.fgrep) {
+  mocha.fgrep(program.fgrep);
+}
 
 // --invert
 
-if (program.invert) mocha.invert();
+if (program.invert) {
+  mocha.invert();
+}
 
 // --check-leaks
 
-if (program.checkLeaks) mocha.checkLeaks();
+if (program.checkLeaks) {
+  mocha.checkLeaks();
+}
 
 // --stack-trace
 
-if(program.fullTrace) mocha.fullTrace();
+if (program.fullTrace) {
+  mocha.fullTrace();
+}
 
 // --growl
 
-if (program.growl) mocha.growl();
+if (program.growl) {
+  mocha.growl();
+}
 
 // --async-only
 
-if (program.asyncOnly) mocha.asyncOnly();
+if (program.asyncOnly) {
+  mocha.asyncOnly();
+}
 
 // --delay
 
-if (program.delay) mocha.delay();
+if (program.delay) {
+  mocha.delay();
+}
 
 // --globals
 
@@ -288,17 +319,21 @@ mocha.globals(globals);
 
 // --retries
 
-if (program.retries) mocha.suite.retries(program.retries);
+if (program.retries) {
+  mocha.suite.retries(program.retries);
+}
 
 // custom compiler support
 
 var extensions = ['js'];
-program.compilers.forEach(function(c) {
-  var idx = c.indexOf(':')
-    , ext = c.slice(0, idx)
-    , mod = c.slice(idx + 1);
+program.compilers.forEach(function (c) {
+  var idx = c.indexOf(':');
+  var ext = c.slice(0, idx);
+  var mod = c.slice(idx + 1);
 
-  if (mod[0] == '.') mod = join(process.cwd(), mod);
+  if (mod[0] === '.') {
+    mod = join(process.cwd(), mod);
+  }
   require(mod);
   extensions.push(ext);
   program.watchExtensions.push(ext);
@@ -306,7 +341,7 @@ program.compilers.forEach(function(c) {
 
 // requires
 
-requires.forEach(function(mod) {
+requires.forEach(function (mod) {
   require(mod);
 });
 
@@ -314,21 +349,40 @@ requires.forEach(function(mod) {
 
 mocha.ui(program.ui);
 
-//args
+// args
 
 var args = program.args;
 
 // default files to test/*.{js,coffee}
 
-if (!args.length) args.push('test');
+if (!args.length) {
+  args.push('test');
+}
+
+args.forEach(function (arg) {
+  var newFiles;
+  try {
+    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);
+      return;
+    }
 
-args.forEach(function(arg){
-  files = files.concat(utils.lookupFiles(arg, extensions, program.recursive));
+    throw err;
+  }
+
+  files = files.concat(newFiles);
 });
 
+if (!files.length) {
+  console.error('No test files found');
+  process.exit(1);
+}
+
 // resolve
 
-files = files.map(function(path){
+files = files.map(function (path) {
   return resolve(path);
 });
 
@@ -339,54 +393,58 @@ if (program.sort) {
 // --watch
 
 var runner;
+var loadAndRun;
+var purge;
+var rerun;
+
 if (program.watch) {
   console.log();
   hideCursor();
-  process.on('SIGINT', function(){
+  process.on('SIGINT', function () {
     showCursor();
     console.log('\n');
-    process.exit();
+    process.exit(130);
   });
 
-
   var watchFiles = utils.files(cwd, [ 'js' ].concat(program.watchExtensions));
   var runAgain = false;
 
-  function loadAndRun() {
+  loadAndRun = function loadAndRun () {
     try {
       mocha.files = files;
       runAgain = false;
-      runner = mocha.run(function(){
+      runner = mocha.run(function () {
         runner = null;
         if (runAgain) {
           rerun();
         }
       });
-    } catch(e) {
+    } catch (e) {
       console.log(e.stack);
     }
-  }
+  };
 
-  function purge() {
-    watchFiles.forEach(function(file){
+  purge = function purge () {
+    watchFiles.forEach(function (file) {
       delete require.cache[file];
     });
-  }
+  };
 
   loadAndRun();
 
-  function rerun() {
+  rerun = function rerun () {
     purge();
-    stop()
-    if (!program.grep)
+    stop();
+    if (!program.grep) {
       mocha.grep(null);
+    }
     mocha.suite = mocha.suite.clone();
-    mocha.suite.ctx = new Mocha.Context;
+    mocha.suite.ctx = new Mocha.Context();
     mocha.ui(program.ui);
     loadAndRun();
-  }
+  };
 
-  utils.watch(watchFiles, function(){
+  utils.watch(watchFiles, function () {
     runAgain = true;
     if (runner) {
       runner.abort();
@@ -394,32 +452,33 @@ if (program.watch) {
       rerun();
     }
   });
-
 } else {
-
 // load
 
   mocha.files = files;
   runner = mocha.run(program.exit ? exit : exitLater);
-
 }
 
-function exitLater(code) {
-  process.on('exit', function() { process.exit(code) })
+function exitLater (code) {
+  process.on('exit', function () {
+    process.exit(Math.min(code, 255));
+  });
 }
 
-function exit(code) {
+function exit (code) {
   // flush output for Node.js Windows pipe bug
   // https://github.com/joyent/node/issues/6247 is just one bug example
   // https://github.com/visionmedia/mocha/issues/333 has a good discussion
-  function done() {
-    if (!(draining--)) process.exit(code);
+  function done () {
+    if (!(draining--)) {
+      process.exit(Math.min(code, 255));
+    }
   }
 
   var draining = 0;
   var streams = [process.stdout, process.stderr];
 
-  streams.forEach(function(stream){
+  streams.forEach(function (stream) {
     // submit empty write request and wait for completion
     draining += 1;
     stream.write('', done);
@@ -428,13 +487,20 @@ function exit(code) {
   done();
 }
 
-process.on('SIGINT', function() { runner.abort(); })
+process.on('SIGINT', function () {
+  runner.abort();
+
+  // This is a hack:
+  // Instead of `process.exit(130)`, set runner.failures to 130 (exit code for SIGINT)
+  // The amount of failures will be emitted as error code later
+  runner.failures = 130;
+});
 
 /**
  * Parse list.
  */
 
-function list(str) {
+function list (str) {
   return str.split(/ *, */);
 }
 
@@ -442,7 +508,7 @@ function list(str) {
  * Hide the cursor.
  */
 
-function hideCursor(){
+function hideCursor () {
   process.stdout.write('\u001b[?25l');
 }
 
@@ -450,7 +516,7 @@ function hideCursor(){
  * Show the cursor.
  */
 
-function showCursor(){
+function showCursor () {
   process.stdout.write('\u001b[?25h');
 }
 
@@ -458,7 +524,7 @@ function showCursor(){
  * Stop play()ing.
  */
 
-function stop() {
+function stop () {
   process.stdout.write('\u001b[2K');
   clearInterval(play.timer);
 }
@@ -467,12 +533,12 @@ function stop() {
  * Play the given array of strings.
  */
 
-function play(arr, interval) {
-  var len = arr.length
-    , interval = interval || 100
-    , i = 0;
+function play (arr, interval) {
+  var len = arr.length;
+  interval = interval || 100;
+  var i = 0;
 
-  play.timer = setInterval(function(){
+  play.timer = setInterval(function () {
     var str = arr[i++ % len];
     process.stdout.write('\u001b[0G' + str);
   }, interval);