Skip to content

Upgrading mocha 5 to 6

Breaking5.2.0 → 6.2.3Breaking11Security4Platform1Deprecated7New21Changed8Fixed59Other47

Full comparisonBack to mocha
BreakingUpgrade verdict

11 breaking changes and a platform requirement change and 4 security fixes.

In plain terms
  • The old --compilers flag no longer works and Mocha will error out if you pass it.
  • The short -d flag no longer turns on debug mode and is silently ignored.
  • If you rely on watching JavaScript files, you must now list js in the watch extensions.
  • You can no longer combine the two test-filtering options; Mocha will stop with an error.
Must act Top 5 of 23 that need code or config changes

Node.js requirement changed in 6.0.0-0: >= 4.0.0 → >= 6.0.0.

Adds ansi-colors 3.2.3, find-up 3.0.0, js-yaml 3.13.1, log-symbols 2.2.0, ms 2.1.1, node-environment-flags 1.0.5, object.assign 4.1.0, strip-json-comments 2.0.1, which 1.3.1, wide-align 1.1.3, yargs 13.3.2, yargs-parser 13.1.2, yargs-unparser 1.6.0.

Drops commander.

Installs 171 packages in all (was 23).

Also installs ansi-regex, ansi-styles, argparse, array-buffer-byte-length, array.prototype.reduce, arraybuffer.prototype.slice, async-function, async-generator-function, available-typed-arrays, call-bind, call-bind-apply-helpers, call-bound, camelcase, chalk, cliui and 111 more.

Moves debug 3.1.0 → 3.2.6, glob 7.1.2 → 7.1.3, he 1.1.1 → 1.2.0, minimist 0.0.8 → 1.2.8, mkdirp 0.5.1 → 0.5.4, ms 2.0.0 → 2.1.1, supports-color 5.4.0 → 5.5.0, 6.0.0. Your build may pick other versions.

What you must change

Breaking11
Removes support for the --compilers option; using it now fails with a link to more information.
--compilers
6.0.0GitHub ReleaseSummarizedView source
Removes -d as an alias for --debug; -d is now ignored.
-d--debug
6.0.0GitHub ReleaseSummarizedView source
--watch-extensions no longer implies js; js must be added explicitly.
--watch-extensions
6.0.0GitHub ReleaseSummarizedView source
Makes --grep and --fgrep mutually exclusive; using both now fails instead of ignoring --grep.
--grep--fgrep
6.0.0GitHub ReleaseSummarizedView source
The tap reporter now emits error messages.
tap
6.0.0GitHub ReleaseSummarizedView source
Timeout exceeded exceptions now include the filepath where applicable.
6.0.0GitHub ReleaseSummarizedView source
Moves lib/template.html to lib/browser/template.html.
lib/template.htmllib/browser/template.html
6.0.0GitHub ReleaseSummarizedView source
Throws an exception if Mocha cannot parse or find a mocha.opts at a user-specified path.
mocha.opts
6.0.0GitHub ReleaseSummarizedView source
Instantiating a Base-extending reporter without a Runner parameter now throws an exception.
BaseRunner
6.0.0GitHub ReleaseSummarizedView source
All exceptions from Mocha's programmatic API now have a code property; check code instead of message.
codemessage
6.0.0GitHub ReleaseSummarizedView source
Conditionally skipping in a before hook now also skips subsequent before hooks and tests in nested suites.
before
6.0.0GitHub ReleaseSummarizedView source
Security4
Updates dependencies mkdirp, yargs-parser and yargs as a security fix.
mkdirpyargs-parseryargs
6.2.3GitHub ReleaseSummarizedView source
Upgrades js-yaml to address a code injection vulnerability.
js-yaml
6.1.4GitHub ReleaseSummarizedView source
Updates dependency js-yaml to v3.13.0 per npm security advisory.
js-yaml
6.1.0GitHub ReleaseSummarizedView source
Avoids potential ReDoS when diffing large objects.
6.0.0GitHub ReleaseSummarizedView source
Platform1
Drops support for Node.js v4.x.
6.0.0GitHub ReleaseSummarizedView source

Deprecations to plan for

Deprecated7
Renames --exclude to --ignore and creates an alias.
--exclude--ignore
6.2.0GitHub ReleaseSummarizedView source
Soft-deprecates this.skip() in "after all" hooks, emitting a warning; support will likely be removed in the next major version.
this.skip()
6.1.0GitHub ReleaseSummarizedView source
Soft-deprecates -gc in favor of --gc-global, emitting a warning on use.
-gc--gc-global
6.0.0GitHub ReleaseSummarizedView source
Soft-deprecates the function exported by bin/options in favor of loadMochaOpts or loadOptions from lib/cli/options.
bin/optionsloadMochaOptsloadOptionslib/cli/options
6.0.0GitHub ReleaseSummarizedView source
Soft-deprecates the Mocha constructor option useColors in favor of color: false.
MochacoloruseColors
6.0.0GitHub ReleaseSummarizedView source
Soft-deprecates the Mocha constructor option enableTimeouts in favor of timeout: false.
MochatimeoutenableTimeouts
6.0.0GitHub ReleaseSummarizedView source
Considers mocha.opts legacy and prefers RC file or package.json configuration.
mocha.opts
6.0.0GitHub ReleaseSummarizedView source