v6.0.0-0

6.0.0-0 / 2019-01-01

Documentation for this release can be found at next.mochajs.org!

Welcome @plroebuck, @craigtaub, & @markowsiak to the team!

💥 Breaking Changes

• #3149: Drop Node.js v4.x support (@outsideris)
• #3556: Changes to command-line options (@boneskull):
  • --grep and --fgrep are now mutually exclusive; attempting to use both will cause Mocha to fail instead of simply ignoring --grep
  • --compilers is no longer supported; attempting to use will cause Mocha to fail with a link to more information
  • -d is no longer an alias for --debug; -d is currently ignored
  • #3275: --watch-extensions no longer implies js; it must be explicitly added (@TheDancingCode)
• #2908: tap reporter emits error messages (@chrmod)
• #2819: When conditionally skipping in a before hook, subsequent before hooks and tests in nested suites are now skipped (@bannmoore)
• #627: Emit filepath in "timeout exceeded" exceptions where applicable (@boneskull)
• #3556: lib/template.html has moved to lib/browser/template.html (@boneskull)
• #2576: An exception is now thrown if Mocha fails to parse or find a mocha.opts at a user-specified path (@plroebuck)
• #3458: Instantiating a Base-extending reporter without a Runner parameter will throw an exception (@craigtaub)
• #3125: For consumers of Mocha's programmatic API, all exceptions thrown from Mocha now have a code property (and some will have additional metadata). Some Error messages have changed. Please use the code property to check Error types instead of the message property; these descriptions will be localized in the future. (@craigtaub)

📠 Deprecations

These are soft-deprecated, and will emit a warning upon use. Support will be removed in (likely) the next major version of Mocha:

• -gc users should use --gc-global instead
• Consumers of the function exported by bin/options should now use the loadMochaOpts or loadOptions (preferred) functions exported by the lib/cli/options module

Regarding the Mocha class constructor (from lib/mocha):

• Use property color: false instead of useColors: false
• Use property timeout: false instead of enableTimeouts: false

All of the above deprecations were introduced by #3556.

mocha.opts is now considered "legacy"; please prefer RC file or package.json over mocha.opts.

🎉 Enhancements

Enhancements introduced in #3556:

• Mocha now supports "RC" files in JS, JSON, YAML, or package.json-based (using mocha property) format

  • .mocharc.js, .mocharc.json, .mocharc.yaml or .mocharc.yml are valid "rc" file names and will be automatically loaded
  • Use --config /path/to/rc/file to specify an explicit path
  • Use --package /path/to/package.json to specify an explicit package.json to read the mocha prop from
  • Use --no-config or --no-package to completely disable loading of configuration via RC file and package.json, respectively
  • Configurations are merged as applicable using the priority list:
    1. Command-line arguments
    2. RC file
    3. package.json
    4. mocha.opts
    5. Mocha's own defaults
  • Check out these example config files

• Node/V8 flag support in mocha executable:

  • Support all allowed node flags as supported by the running version of node (also thanks to @demurgos)
  • Support any V8 flag by prepending --v8- to the flag name
  • All flags are also supported via config files, package.json properties, or mocha.opts
  • Debug-related flags (e.g., --inspect) now imply --no-timeouts
  • Use of e.g., --debug will automatically invoke --inspect if supported by running version of node

• Support negation of any Mocha-specific command-line flag by prepending --no- to the flag name

• Interfaces now have descriptions when listed using --interfaces flag

• Mocha constructor supports all options

• --extension is now an alias for --watch-extensions and affects non-watch-mode test runs as well. For example, to run only test/*.coffee (not test/*.js), you can do mocha --require coffee-script/register --extensions coffee.

• #3552: tap reporter is now TAP13-capable (@plroebuck & @mollstam)

• #3535: Mocha's version can now be queried programmatically via public property Mocha.prototype.version (@plroebuck)

• #3428: xunit reporter shows diffs (@mlucool)

• #2529: Runner now emits a retry event when tests are retried (reporters can listen for this) (@catdad)

• #2962, #3111: In-browser notification support; warn about missing prereqs when --growl supplied (@plroebuck)

🐛 Fixes

• #3356: --no-timeouts and --timeout 0 now does what you'd expect (@boneskull)
• #3475: Restore --no-exit option (@boneskull)
• #3570: Long-running tests now respect SIGINT (@boneskull)
• #2944: --forbid-only and --forbid-pending now "fail fast" when encountered on a suite (@outsideris)
• #1652, #2951: Fix broken clamping of timeout values (@plroebuck)
• #2095, #3521: Do not log stdout: prefix in browser console (@Bamieh)
• #3595: Fix mochajs.org deployment problems (@papandreou)
• #3518: Improve utils.isPromise() (@fabiosantoscode)
• #3320: Fail gracefully when non-extensible objects are thrown in async tests (@fargies)
• #2475: XUnit does not duplicate test result numbers in "errors" and "failures"; "failures" will always be zero (@mlucool)
• #3398, #3598, #3457, #3617: Fix regression wherein --bail would not execute "after" nor "after each" hooks (@juergba)
• #3580: Fix potential exception when using XUnit reporter programmatically (@Lana-Light)
• #1304: Do not output color to TERM=dumb (@plroebuck)

📖 Documentation

• #3525: Improvements to .github/CONTRIBUTING.md (@markowsiak)
• #3466: Update description of slow option (@finfin)
• #3405: Remove references to bower installations (@goteamtim)
• #3361: Improvements to --watch docs (@benglass)
• #3136: Improve docs around globbing and shell expansion (@akrawchyk)
• #2819: Update docs around skips and hooks (@bannmoore)
• Many improvements by @outsideris

🔩 Other

• #3557: Use ms userland module instead of hand-rolled solution (@gizemkeser)
• Many CI fixes and other refactor...

v5.2.0

5.2.0 / 2018-05-18

🎉 Enhancements

• #3375: Add support for comments in mocha.opts (@plroebuck)

🐛 Fixes

• #3346: Exit correctly from before hooks when using --bail (@outsideris)

📖 Documentation

• #3328: Mocha-flavored API docs! (@Munter)

🔩 Other

• #3330: Use Buffer.from() (@harrysarson)
• #3295: Remove redundant folder (@DavNej)
• #3356: Refactoring (@plroebuck)

v5.1.1

5.1.1 / 2018-04-18

🐛 Fixes

• #3325: Revert change which broke --watch (@boneskull)

v5.1.0

5.1.0 / 2018-04-12

🎉 Enhancements

• #3210: Add --exclude option (@metalex9)

🐛 Fixes

• #3318: Fix failures in circular objects in JSON reporter (@jeversmann, @boneskull)

📖 Documentation

• #3323: Publish actual API documentation! (@dfberry, @Munter)
• #3299: Improve docs around exclusive tests (@nicgirault)

🔩 Other

• #3302, #3308, #3310, #3315, #3316: Build matrix improvements (more info) (@outsideris, @boneskull)
• #3272: Refactor reporter tests (@jMuzsik)

v5.0.5

5.0.5 / 2018-03-22

Welcome @outsideris to the team!

🐛 Fixes

• #3096: Fix --bail failing to bail within hooks (@outsideris)
• #3184: Don't skip too many suites (using describe.skip()) (@outsideris)

📖 Documentation

• #3133: Improve docs regarding "pending" behavior (@ematicipo)
• #3276, #3274: Fix broken stuff in CHANGELOG.md (@tagoro9, @honzajavorek)

🔩 Other

• #3208: Improve test coverage for AMD users (@outsideris)
• #3267: Remove vestiges of PhantomJS from CI (@anishkny)
• #2952: Fix a debug message (@boneskull)

v5.0.4

5.0.4 / 2018-03-07

🐛 Fixes

• #3265: Fixes regression in "watch" functionality introduced in v5.0.2 (@outsideris)

v5.0.3

5.0.3 / 2018-03-06

This patch features a fix to address a potential "low severity" ReDoS vulnerability in the diff package (a dependency of Mocha).

🔒 Security Fixes

• #3266: Bump diff to v3.5.0 (@anishkny)

🔩 Other

• #3011: Expose generateDiff() in Base reporter (@harrysarson)

v5.0.2

5.0.2 / 2018-03-05

This release fixes a class of tests which report as false positives. Certain tests will now break, though they would have previously been reported as passing. Details below. Sorry for the inconvenience!

🐛 Fixes

• #3226: Do not swallow errors that are thrown asynchronously from passing tests (@boneskull). Example:

  it('should actually fail, sorry!', function (done) {
    // passing assertion
    assert(true === true);
  
    // test complete & is marked as passing
    done();
  
    // ...but something evil lurks within
    setTimeout(() => {
      throw new Error('chaos!');
    }, 100);
  });

  Previously to this version, Mocha would have silently swallowed the chaos! exception, and you wouldn't know. Well, now you know. Mocha cannot recover from this gracefully, so it will exit with a nonzero code.

  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)

🔩 Other

• #3248: Update browser-stdout to v1.3.1 (@honzajavorek)

v5.0.1

5.0.1 / 2018-02-07

...your garden-variety patch release.

Special thanks to Wallaby.js for their continued support! ❤️

🐛 Fixes

• #1838: --delay now works with .only() (@silviom)
• #3119: Plug memory leak present in v8 (@boneskull)

📖 Documentation

• #3132, #3098: Update --glob docs (@outsideris)
• #3212: Update Wallaby.js-related docs (@ArtemGovorov)
• #3205: Remove outdated cruft (@boneskull)

🔩 Other

• #3224: Add proper Wallaby.js config (@ArtemGovorov)
• #3230: Update copyright year (@josephlin55555)

v5.0.0

5.0.0 / 2018-01-17

Mocha starts off 2018 right by again dropping support for unmaintained rubbish.

Welcome @vkarpov15 to the team!

💥 Breaking Changes

• #3148: Drop support for IE9 and IE10 (@Bamieh)
  Practically speaking, only code which consumes (through bundling or otherwise) the userland buffer module should be affected. However, Mocha will no longer test against these browsers, nor apply fixes for them.

🎉 Enhancements

• #3181: Add useful new --file command line argument (documentation) (@hswolff)

🐛 Fixes

• #3187: Fix inaccurate test duration reporting (@FND)
• #3202: Fix bad markup in HTML reporter (@DanielRuf)

😎 Developer Experience

• #2352: Ditch GNU Make for nps to manage scripts (@TedYav)

📖 Documentation

• #3137: Add missing --no-timeouts docs (@dfberry)
• #3134: Improve done() callback docs (@maraisr)
• #3135: Fix cross-references (@vkarpov15)
• #3163: Fix tpyos (@tbroadley)
• #3177: Tweak README.md organization (@xxczaki)
• Misc updates (@boneskull)

🔩 Other

• #3118: Move TextMate Integration to its own repo (@Bamieh)
• #3185: Add Node.js v9 to build matrix; remove v7 (@xxczaki)
• #3172: Markdown linting (@boneskull)
• Test & Netlify updates (@Munter, @boneskull)