mocha 4.0.1 → 4.1.0

package/CHANGELOG.md

@@ -1,3 +1,55 @@
+# 4.1.0 / 2017-12-28
+
+This is mainly a "housekeeping" release.
+
+Welcome [@Bamieh] and [@xxczaki] to the team!
+
+## :bug:: Fixes
+
+- [#2661]: `progress` reporter now accepts reporter options ([@canoztokmak])
+- [#3142]: `xit` in `bdd` interface now properly returns its `Test` object ([@Bamieh])
+- [#3075]: Diffs now computed eagerly to avoid misinformation when reported ([@abrady0])
+- [#2745]: `--help` will now help you even if you have a `mocha.opts` ([@Zarel])
+
+## :tada: Enhancements
+
+- [#2514]: The `--no-diff` flag will completely disable diff output ([@CapacitorSet])
+- [#3058]: All "setters" in Mocha's API are now also "getters" if called without arguments ([@makepanic])
+
+## :book: Documentation
+
+- [#3170]: Optimization and site speed improvements ([@Munter])
+- [#2987]: Moved the old [site repo](https://github.com/mochajs/mochajs.github.io) into the main repo under `docs/` ([@boneskull])
+- [#2896]: Add [maintainer guide](https://github.com/mochajs/mocha/blob/master/MAINTAINERS.md) ([@boneskull])
+- Various fixes and updates ([@xxczaki], [@maty21], [@leedm777])
+
+## :nut_and_bolt: Other
+
+- Test improvements and fixes ([@eugenet8k], [@ngeor], [@38elements], [@Gerhut], [@ScottFreeCode], [@boneskull])
+- Refactoring and cruft excision ([@38elements], [@Bamieh], [@finnigantime], [@boneskull])
+
+[#2661]: https://github.com/mochajs/mocha/issues/2661
+[#3142]: https://github.com/mochajs/mocha/issues/3142
+[#3075]: https://github.com/mochajs/mocha/pull/3075
+[#2745]: https://github.com/mochajs/mocha/issues/2745
+[#2514]: https://github.com/mochajs/mocha/issues/2514
+[#3058]: https://github.com/mochajs/mocha/issues/3058
+[#3170]: https://github.com/mochajs/mocha/pull/3170
+[#2987]: https://github.com/mochajs/mocha/issues/2987
+[#2896]: https://github.com/mochajs/mocha/issues/2896
+[@canoztokmak]: https://github.com/canoztokmak
+[@Bamieh]: https://github.com/Bamieh
+[@abrady0]: https://github.com/abrady0
+[@Zarel]: https://github.com/Zarel
+[@CapacitorSet]: https://github.com/CapacitorSet
+[@xxczaki]: https://github.com/xxczaki
+[@maty21]: https://github.com/maty21
+[@leedm777]: https://github.com/leedm777
+[@eugenet8k]: https://github.com/eugenet8k
+[@38elements]: https://github.com/38elements
+[@Gerhut]: https://github.com/Gerhut
+[@finnigantime]: https://github.com/finnigantime
+
 # 4.0.1 / 2017-10-05
 
 ## :bug: Fixes

package/README.md

@@ -9,23 +9,23 @@
 *Thank you* :kissing_heart: to all of you interested in helping.  These are Mocha's immediate needs:
 
 1. Increase test coverage on Node.js and browser
-  - Increase integration coverage for all reporters
-    - `html` reporter must be tested in browser
-    - ~~Basic console reporters (*not* `nyan`, `landing`, etc.) must be tested in **both** browser and Node.js contexts; PhantomJS can consume all console reporters~~
-    - ~~Filesystem-based reporters must be tested in Node.js context~~
-    - **UPDATE - May 24 2017**: Thanks to [community contributions](https://github.com/mochajs/mocha/blob/master/CHANGELOG.md#mag-coverage), the coverage on most reporters has increased dramatically!  The `html` reporter is still in [dire need of coverage](https://coveralls.io/builds/11674428/source?filename=lib%2Freporters%2Fhtml.js).
-  - Increase coverage against all interfaces (`exports` in particular).  Ideally this becomes a "matrix" where we repeat sets of integration tests across all interfaces.
-  - Refactor non-Node.js-specific tests to allow them to run in a browser context.  Node.js-specific tests include those which *require* the CLI or filesystem.  Most everything else is fair game.
+   - Increase integration coverage for all reporters
+     - `html` reporter must be tested in browser
+     - ~~Basic console reporters (*not* `nyan`, `landing`, etc.) must be tested in **both** browser and Node.js contexts; PhantomJS can consume all console reporters~~
+     - ~~Filesystem-based reporters must be tested in Node.js context~~
+     - **UPDATE - May 24 2017**: Thanks to [community contributions](https://github.com/mochajs/mocha/blob/master/CHANGELOG.md#mag-coverage), the coverage on most reporters has increased dramatically!  The `html` reporter is still in [dire need of coverage](https://coveralls.io/builds/11674428/source?filename=lib%2Freporters%2Fhtml.js).
+   - Increase coverage against all interfaces (`exports` in particular).  Ideally this becomes a "matrix" where we repeat sets of integration tests across all interfaces.
+   - Refactor non-Node.js-specific tests to allow them to run in a browser context.  Node.js-specific tests include those which *require* the CLI or filesystem.  Most everything else is fair game.
 2.  Review current open pull requests
-  - We need individuals familiar with Mocha's codebase. Got questions?  Ask them in [our chat room](https://gitter.im/mochajs/mocha).
-  - Pull requests **must** have supporting tests.  The only exceptions are pure cosmetic or non-functional changes.
-  - Pull request contributors must sign [the CLA](https://cla.js.foundation/mochajs/mocha).
+    - We need individuals familiar with Mocha's codebase. Got questions?  Ask them in [our chat room](https://gitter.im/mochajs/mocha).
+    - Pull requests **must** have supporting tests.  The only exceptions are pure cosmetic or non-functional changes.
+    - Pull request contributors must sign [the CLA](https://cla.js.foundation/mochajs/mocha).
 3. Close old, inactive issues and pull requests
-  - ~~A bot should do this.  We need a bot. Got a bot?~~ We now use GitHub's own [probot-stale](https://www.npmjs.com/package/probot-stale).
+    - ~~A bot should do this.  We need a bot. Got a bot?~~ We now use GitHub's own [probot-stale](https://www.npmjs.com/package/probot-stale).
 4. Triage issues
-  - If we run into "critical" bugs, they need fixing.
-  - "Critical" means Mocha is broken w/o workarounds for a *large percentage* of users
-  - Otherwise: respond to issues, close new dupe issues, confirm bugs, ask for more info, etc.
+   - If we run into "critical" bugs, they need fixing.
+   - "Critical" means Mocha is broken w/o workarounds for a *large percentage* of users
+   - Otherwise: respond to issues, close new dupe issues, confirm bugs, ask for more info, etc.
 
 Once we gain ground on the above items, we can work together formalize our contribution guidelines and governance.  For further info & ideas, please see our [projects](https://github.com/mochajs/mocha/projects/).
 

package/bin/.eslintrc.yml

@@ -0,0 +1,3 @@
+env:
+  es6: true
+  browser: false

package/bin/_mocha

@@ -7,52 +7,136 @@
  * Module dependencies.
  */
 
-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();
+const program = require('commander');
+const path = require('path');
+const fs = require('fs');
+const resolve = path.resolve;
+const exists = fs.existsSync;
+const Mocha = require('../');
+const utils = Mocha.utils;
+const interfaceNames = Object.keys(Mocha.interfaces);
+const join = path.join;
+const cwd = process.cwd();
+const getOptions = require('./options');
+const mocha = new Mocha();
 
 /**
  * Save timer references to avoid Sinon interfering (see GH-237).
  */
 
-var Date = global.Date;
-var setTimeout = global.setTimeout;
-var setInterval = global.setInterval;
-var clearTimeout = global.clearTimeout;
-var clearInterval = global.clearInterval;
+const Date = global.Date;
+const setTimeout = global.setTimeout;
+const setInterval = global.setInterval;
+const clearTimeout = global.clearTimeout;
+const clearInterval = global.clearInterval;
+
+/**
+ * Exits Mocha when tests + code under test has finished execution (default)
+ * @param {number} code - Exit code; typically # of failures
+ */
+const exitLater = code => {
+  process.on('exit', () => {
+    process.exit(Math.min(code, 255));
+  });
+};
+
+/**
+ * Exits Mocha when Mocha itself has finished execution, regardless of
+ * what the tests or code under test is doing.
+ * @param {number} code - Exit code; typically # of failures
+ */
+const exit = code => {
+  const clampedCode = Math.min(code, 255);
+  let draining = 0;
+
+  // Eagerly set the process's exit code in case stream.write doesn't
+  // execute its callback before the process terminates.
+  process.exitCode = clampedCode;
+
+  // 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
+  const done = () => {
+    if (!(draining--)) {
+      process.exit(clampedCode);
+    }
+  };
+
+  const streams = [process.stdout, process.stderr];
+
+  streams.forEach(stream => {
+    // submit empty write request and wait for completion
+    draining += 1;
+    stream.write('', done);
+  });
+
+  done();
+};
+
+/**
+ * Parse list.
+ */
+const list = str => str.split(/ *, */);
+
+/**
+ * Hide the cursor.
+ */
+const hideCursor = () => {
+  process.stdout.write('\u001b[?25l');
+};
+
+/**
+ * Show the cursor.
+ */
+const showCursor = () => {
+  process.stdout.write('\u001b[?25h');
+};
+
+/**
+ * Stop play()ing.
+ */
+const stop = () => {
+  process.stdout.write('\u001b[2K');
+  clearInterval(play.timer);
+};
+
+/**
+ * Play the given array of strings.
+ */
+const play = (arr, interval) => {
+  const len = arr.length;
+  interval = interval || 100;
+  let i = 0;
+
+  play.timer = setInterval(() => {
+    const str = arr[i++ % len];
+    process.stdout.write(`\u001b[0G${str}`);
+  }, interval);
+};
 
 /**
  * Files.
  */
 
-var files = [];
+let files = [];
 
 /**
  * Globals.
  */
 
-var globals = [];
+let globals = [];
 
 /**
  * Requires.
  */
 
-var requires = [];
+const requires = [];
 
 /**
  * Images.
  */
 
-var images = {
+const images = {
   fail: path.join(__dirname, '..', 'images', 'error.png'),
   pass: path.join(__dirname, '..', 'images', 'ok.png')
 };
@@ -78,7 +162,7 @@ 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')
@@ -90,6 +174,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('--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('--interfaces', 'display available interfaces')
@@ -123,12 +208,12 @@ program._name = 'mocha';
 program
   .command('init <path>')
   .description('initialize a client-side mocha setup at <path>')
-  .action(function (path) {
-    var mkdir = require('mkdirp');
+  .action(path => {
+    const mkdir = require('mkdirp');
     mkdir.sync(path);
-    var css = fs.readFileSync(join(__dirname, '..', 'mocha.css'));
-    var js = fs.readFileSync(join(__dirname, '..', 'mocha.js'));
-    var tmpl = fs.readFileSync(join(__dirname, '..', 'lib/template.html'));
+    const css = fs.readFileSync(join(__dirname, '..', 'mocha.css'));
+    const js = fs.readFileSync(join(__dirname, '..', 'mocha.js'));
+    const tmpl = fs.readFileSync(join(__dirname, '..', 'lib/template.html'));
     fs.writeFileSync(join(path, 'mocha.css'), css);
     fs.writeFileSync(join(path, 'mocha.js'), js);
     fs.writeFileSync(join(path, 'tests.js'), '');
@@ -138,13 +223,13 @@ program
 
 // --globals
 
-program.on('option:globals', function (val) {
+program.on('option:globals', val => {
   globals = globals.concat(list(val));
 });
 
 // --reporters
 
-program.on('option:reporters', function () {
+program.on('option:reporters', () => {
   console.log();
   console.log('    dot - dot matrix');
   console.log('    doc - html documentation');
@@ -165,10 +250,10 @@ program.on('option:reporters', function () {
 
 // --interfaces
 
-program.on('option:interfaces', function () {
+program.on('option:interfaces', () => {
   console.log('');
-  interfaceNames.forEach(function (interfaceName) {
-    console.log('    ' + interfaceName);
+  interfaceNames.forEach(interfaceName => {
+    console.log(`    ${interfaceName}`);
   });
   console.log('');
   process.exit();
@@ -178,8 +263,8 @@ program.on('option:interfaces', function () {
 
 module.paths.push(cwd, join(cwd, 'node_modules'));
 
-program.on('option:require', function (mod) {
-  var abs = exists(mod) || exists(mod + '.js');
+program.on('option:require', mod => {
+  const abs = exists(mod) || exists(`${mod}.js`);
   if (abs) {
     mod = resolve(mod);
   }
@@ -201,12 +286,12 @@ Error.stackTraceLimit = Infinity; // TODO: config
 
 // reporter options
 
-var reporterOptions = {};
+const reporterOptions = {};
 if (program.reporterOptions !== undefined) {
-  program.reporterOptions.split(',').forEach(function (opt) {
-    var L = opt.split('=');
+  program.reporterOptions.split(',').forEach(opt => {
+    const L = opt.split('=');
     if (L.length > 2 || L.length === 0) {
-      throw new Error("invalid reporter option '" + opt + "'");
+      throw new Error(`invalid reporter option '${opt}'`);
     } else if (L.length === 2) {
       reporterOptions[L[0]] = L[1];
     } else {
@@ -221,14 +306,14 @@ mocha.reporter(program.reporter, reporterOptions);
 
 // load reporter
 
-var Reporter = null;
+let Reporter = null;
 try {
-  Reporter = require('../lib/reporters/' + program.reporter);
+  Reporter = require(`../lib/reporters/${program.reporter}`);
 } catch (err) {
   try {
     Reporter = require(program.reporter);
   } catch (err2) {
-    throw new Error('reporter "' + program.reporter + '" does not exist');
+    throw new Error(`reporter "${program.reporter}" does not exist`);
   }
 }
 
@@ -250,6 +335,12 @@ if (program.inlineDiffs) {
   mocha.useInlineDiffs(true);
 }
 
+// --no-diff
+
+if (process.argv.indexOf('--no-diff') !== -1) {
+  mocha.hideDiff(true);
+}
+
 // --slow <ms>
 
 if (program.slow) {
@@ -347,14 +438,14 @@ if (program.forbidPending) mocha.forbidPending();
 // custom compiler support
 
 if (program.compilers.length > 0) {
-  require('util').deprecate(function () {},
+  require('util').deprecate(() => {},
     '"--compilers" will be removed in a future version of Mocha; see https://git.io/vdcSr for more info')();
 }
-var extensions = ['js'];
-program.compilers.forEach(function (c) {
-  var idx = c.indexOf(':');
-  var ext = c.slice(0, idx);
-  var mod = c.slice(idx + 1);
+const extensions = ['js'];
+program.compilers.forEach(c => {
+  const idx = c.indexOf(':');
+  const ext = c.slice(0, idx);
+  let mod = c.slice(idx + 1);
 
   if (mod[0] === '.') {
     mod = join(process.cwd(), mod);
@@ -366,7 +457,7 @@ program.compilers.forEach(function (c) {
 
 // requires
 
-requires.forEach(function (mod) {
+requires.forEach(mod => {
   require(mod);
 });
 
@@ -376,7 +467,7 @@ mocha.ui(program.ui);
 
 // args
 
-var args = program.args;
+const args = program.args;
 
 // default files to test/*.{js,coffee}
 
@@ -384,13 +475,13 @@ if (!args.length) {
   args.push('test');
 }
 
-args.forEach(function (arg) {
-  var newFiles;
+args.forEach(arg => {
+  let 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);
+      console.error(`Warning: Could not find any test files matching pattern: ${arg}`);
       return;
     }
 
@@ -407,9 +498,7 @@ if (!files.length) {
 
 // resolve
 
-files = files.map(function (path) {
-  return resolve(path);
-});
+files = files.map(path => resolve(path));
 
 if (program.sort) {
   files.sort();
@@ -417,28 +506,28 @@ if (program.sort) {
 
 // --watch
 
-var runner;
-var loadAndRun;
-var purge;
-var rerun;
+let runner;
+let loadAndRun;
+let purge;
+let rerun;
 
 if (program.watch) {
   console.log();
   hideCursor();
-  process.on('SIGINT', function () {
+  process.on('SIGINT', () => {
     showCursor();
     console.log('\n');
     process.exit(130);
   });
 
-  var watchFiles = utils.files(cwd, [ 'js' ].concat(program.watchExtensions));
-  var runAgain = false;
+  const watchFiles = utils.files(cwd, [ 'js' ].concat(program.watchExtensions));
+  let runAgain = false;
 
-  loadAndRun = function loadAndRun () {
+  loadAndRun = () => {
     try {
       mocha.files = files;
       runAgain = false;
-      runner = mocha.run(function () {
+      runner = mocha.run(() => {
         runner = null;
         if (runAgain) {
           rerun();
@@ -449,15 +538,15 @@ if (program.watch) {
     }
   };
 
-  purge = function purge () {
-    watchFiles.forEach(function (file) {
+  purge = () => {
+    watchFiles.forEach(file => {
       delete require.cache[file];
     });
   };
 
   loadAndRun();
 
-  rerun = function rerun () {
+  rerun = () => {
     purge();
     stop();
     if (!program.grep) {
@@ -469,7 +558,7 @@ if (program.watch) {
     loadAndRun();
   };
 
-  utils.watch(watchFiles, function () {
+  utils.watch(watchFiles, () => {
     runAgain = true;
     if (runner) {
       runner.abort();
@@ -484,41 +573,7 @@ if (program.watch) {
   runner = mocha.run(program.exit ? exit : exitLater);
 }
 
-function exitLater (code) {
-  process.on('exit', function () {
-    process.exit(Math.min(code, 255));
-  });
-}
-
-function exit (code) {
-  var clampedCode = Math.min(code, 255);
-
-  // Eagerly set the process's exit code in case stream.write doesn't
-  // execute its callback before the process terminates.
-  process.exitCode = clampedCode;
-
-  // 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(clampedCode);
-    }
-  }
-
-  var draining = 0;
-  var streams = [process.stdout, process.stderr];
-
-  streams.forEach(function (stream) {
-    // submit empty write request and wait for completion
-    draining += 1;
-    stream.write('', done);
-  });
-
-  done();
-}
-
-process.on('SIGINT', function () {
+process.on('SIGINT', () => {
   runner.abort();
 
   // This is a hack:
@@ -526,51 +581,3 @@ process.on('SIGINT', function () {
   // The amount of failures will be emitted as error code later
   runner.failures = 130;
 });
-
-/**
- * Parse list.
- */
-
-function list (str) {
-  return str.split(/ *, */);
-}
-
-/**
- * Hide the cursor.
- */
-
-function hideCursor () {
-  process.stdout.write('\u001b[?25l');
-}
-
-/**
- * Show the cursor.
- */
-
-function showCursor () {
-  process.stdout.write('\u001b[?25h');
-}
-
-/**
- * Stop play()ing.
- */
-
-function stop () {
-  process.stdout.write('\u001b[2K');
-  clearInterval(play.timer);
-}
-
-/**
- * Play the given array of strings.
- */
-
-function play (arr, interval) {
-  var len = arr.length;
-  interval = interval || 100;
-  var i = 0;
-
-  play.timer = setInterval(function () {
-    var str = arr[i++ % len];
-    process.stdout.write('\u001b[0G' + str);
-  }, interval);
-}

package/bin/mocha

@@ -7,17 +7,17 @@
  * when found, before invoking the "real" _mocha(1) executable.
  */
 
-var spawn = require('child_process').spawn;
-var path = require('path');
-var getOptions = require('./options');
-var args = [path.join(__dirname, '_mocha')];
+const spawn = require('child_process').spawn;
+const path = require('path');
+const getOptions = require('./options');
+const args = [path.join(__dirname, '_mocha')];
 
 // Load mocha.opts into process.argv
 // Must be loaded here to handle node-specific options
 getOptions();
 
-process.argv.slice(2).forEach(function (arg) {
-  var flag = arg.split('=')[0];
+process.argv.slice(2).forEach(arg => {
+  const flag = arg.split('=')[0];
 
   switch (flag) {
     case '-d':
@@ -69,9 +69,11 @@ process.argv.slice(2).forEach(function (arg) {
   }
 });
 
-var proc = spawn(process.execPath, args, { stdio: 'inherit' });
-proc.on('exit', function (code, signal) {
-  process.on('exit', function () {
+const proc = spawn(process.execPath, args, {
+  stdio: 'inherit'
+});
+proc.on('exit', (code, signal) => {
+  process.on('exit', () => {
     if (signal) {
       process.kill(process.pid, signal);
     } else {
@@ -81,7 +83,7 @@ proc.on('exit', function (code, signal) {
 });
 
 // terminate children.
-process.on('SIGINT', function () {
+process.on('SIGINT', () => {
   proc.kill('SIGINT'); // calls runner.abort()
   proc.kill('SIGTERM'); // if that didn't work, we're probably in an infinite loop, so make it die.
 });

package/bin/options.js

@@ -4,7 +4,7 @@
  * Dependencies.
  */
 
-var fs = require('fs');
+const fs = require('fs');
 
 /**
  * Export `getOptions`.
@@ -17,18 +17,20 @@ module.exports = getOptions;
  */
 
 function getOptions () {
-  var optsPath = process.argv.indexOf('--opts') === -1
+  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];
 
   try {
-    var opts = fs.readFileSync(optsPath, 'utf8')
+    const opts = fs.readFileSync(optsPath, 'utf8')
       .replace(/\\\s/g, '%20')
       .split(/\s/)
       .filter(Boolean)
-      .map(function (value) {
-        return value.replace(/%20/g, ' ');
-      });
+      .map(value => value.replace(/%20/g, ' '));
 
     process.argv = process.argv
       .slice(0, 2)