-
#4832: Loading of config files throws wrong error (@juergba)
-
#4799: Reporter: configurable
maxDiffSize
reporter-option (@norla)
- #4777: Add Node v17 to CI test matrix (@outsideris)
- #4764: Revert deprecation of
EVENT_SUITE_ADD_*
events (@beatfactor)
- #4746: Browser: stop using all global vars in
browser-entry.js
(@PaperStrike)
- #4754: Remove dependency wide-align (@juergba)
- #4736: ESM: remove code for Node versions <10 (@juergba)
- #4623:
XUNIT
andJSON
reporter crash inparallel
mode (@curtisman)
- #4716: Add new option
--fail-zero
(@juergba) - #4691: Add new option
--node-option
(@juergba) - #4607: Add output option to
JSON
reporter (@dorny)
-
#4702: Error rethrow from cwd-relative path while loading
.mocharc.js
(@kirill-golovan) -
#4688: Usage of custom interface in parallel mode (@juergba)
-
#4687: ESM: don't swallow
MODULE_NOT_FOUND
errors in case oftype:module
(@giltayar)
We added a separate browser bundle mocha-es2018.js
in javascript ES2018, as we skipped the transpilation down to ES5. This is an experimental step towards freezing Mocha's support of IE11.
- #4653: ESM: proper version check in
hasStableEsmImplementation
(@alexander-fenster)
Mocha is going ESM-first! This means that it will now use ESM import(test_file)
to load the test files, instead of the CommonJS require(test_file)
. This is not a problem, as import
can also load most files that require
does. In the rare cases where this fails, it will fallback to require(...)
. This ESM-first approach is the next step in Mocha's ESM migration, and allows ESM loaders to load and transform the test file.
-
#4638: Limit the size of
actual
/expected
fordiff
generation (@juergba) -
#4389: Refactoring: Consuming log-symbols alternate to code for win32 in reporters/base (@MoonSupport)
- #4646: Deprecate
Runner(suite: Suite, delay: boolean)
signature (@juergba) - #4643: Update production dependencies (@juergba)
- #4502: CLI file parsing errors now have error codes (@evaline-ju)
- #4614: Watch: fix crash when reloading files (@outsideris)
- #4630: Add
options.require
to Mocha constructor forroot hook
plugins on parallel runs (@juergba) - #4617: Dynamically generating tests with
top-level await
and ESM test files (@juergba) - #4608: Update default file extensions (@outsideris)
Also thanks to @outsideris for various improvements on our GH actions workflows.
- #4599: Fix regression in
require
interface (@alexander-fenster)
- #4601: Add build to GH actions run (@christian-bromann)
- #4596: Filter active sponsors/backers (@juergba)
- #4225: Update config file examples (@pkuczynski)
- #4577: Browser: fix
EvalError
caused by regenerator-runtime (@snoack) - #4574: ESM: allow
import
from mocha in parallel mode (@nicojs)
- #4506: Add error code for test timeout errors (@boneskull)
- #4112: Add BigInt support to stringify util function (@JosejeSinohui)
- #4557: Add file location when SyntaxError happens in ESM (@giltayar)
- #4521: Fix
require
error when bundling Mocha with Webpack (@devhazem)
- #4507: Add support for typescript-style docstrings (@boneskull)
- #4503: Add GH Actions workflow status badge (@outsideris)
- #4494: Add example of generating tests dynamically with a closure (@maxwellgerber)
- #4556: Upgrade all dependencies to latest stable (@AviVahl)
- #4543: Update dependencies yargs and yargs-parser (@juergba)
Also thanks to @outsideris and @HyunSangHan for various fixes to our website and documentation.
Fixed stuff.
- #4489: Fix problematic handling of otherwise-unhandled
Promise
rejections and erroneous "done()
called twice" errors (@boneskull) - #4496: Avoid
MaxListenersExceededWarning
in watch mode (@boneskull)
Also thanks to @akeating for a documentation fix!
The major feature added in v8.2.0 is addition of support for global fixtures.
While Mocha has always had the ability to run setup and teardown via a hook (e.g., a before()
at the top level of a test file) when running tests in serial, Mocha v8.0.0 added support for parallel runs. Parallel runs are incompatible with this strategy; e.g., a top-level before()
would only run for the file in which it was defined.
With global fixtures, Mocha can now perform user-defined setup and teardown regardless of mode, and these fixtures are guaranteed to run once and only once. This holds for parallel mode, serial mode, and even "watch" mode (the teardown will run once you hit Ctrl-C, just before Mocha finally exits). Tasks such as starting and stopping servers are well-suited to global fixtures, but not sharing resources--global fixtures do not share context with your test files (but they do share context with each other).
Here's a short example of usage:
// fixtures.js
// can be async or not
exports.mochaGlobalSetup = async function() {
this.server = await startSomeServer({port: process.env.TEST_PORT});
console.log(`server running on port ${this.server.port}`);
};
exports.mochaGlobalTeardown = async function() {
// the context (`this`) is shared, but not with the test files
await this.server.stop();
console.log(`server on port ${this.server.port} stopped`);
};
// this file can contain root hook plugins as well!
// exports.mochaHooks = { ... }
Fixtures are loaded with --require
, e.g., mocha --require fixtures.js
.
For detailed information, please see the documentation and this handy-dandy flowchart to help understand the differences between hooks, root hook plugins, and global fixtures (and when you should use each).
- #4308: Support run-once global setup & teardown fixtures (@boneskull)
- #4442: Multi-part extensions (e.g.,
test.js
) now usable with--extension
option (@jordanstephens) - #4472: Leading dots (e.g.,
.js
,.test.js
) now usable with--extension
option (@boneskull) - #4434: Output of
json
reporter now containsspeed
("fast"/"medium"/"slow") property (@wwhurin) - #4464: Errors thrown by serializer in parallel mode now have error codes (@evaline-ju)
For implementors of custom reporters:
- #4409: Parallel mode and custom reporter improvements (@boneskull):
- Support custom worker-process-only reporters (
Runner.prototype.workerReporter()
); reporters should subclassParallelBufferedReporter
inmocha/lib/nodejs/reporters/parallel-buffered
- Allow opt-in of object reference matching for "sufficiently advanced" custom reporters (
Runner.prototype.linkPartialObjects()
); use if strict object equality is needed when consumingRunner
event data - Enable detection of parallel mode (
Runner.prototype.isParallelMode()
)
- Support custom worker-process-only reporters (
- #4476: Workaround for profoundly bizarre issue affecting
npm
v6.x causing some of Mocha's deps to be installed whenmocha
is present in a package'sdevDependencies
andnpm install --production
is run the package's working copy (@boneskull) - #4465: Worker processes guaranteed (as opposed to "very likely") to exit before Mocha does; fixes a problem when using
nyc
with Mocha in parallel mode (@boneskull) - #4419: Restore
lookupFiles()
inmocha/lib/utils
, which was broken/missing in Mocha v8.1.0; it now prints a deprecation warning (useconst {lookupFiles} = require('mocha/lib/cli')
instead) (@boneskull)
Thanks to @AviVahl, @donghoon-song, @ValeriaVG, @znarf, @sujin-park, and @majecty for other helpful contributions!
- #4425: Restore
Mocha.utils.lookupFiles()
and Webpack compatibility (both broken since v8.1.0);Mocha.utils.lookupFiles()
is now deprecated and will be removed in the next major revision of Mocha; userequire('mocha/lib/cli').lookupFiles
instead (@boneskull)
- #4418: Fix command-line flag incompatibility in forthcoming Node.js v14.9.0 (@boneskull)
- #4401: Fix missing global variable in browser (@irrationnelle)
- Various fixes by @sujin-park, @wwhurin & @Donghoon759
- #4394: Fix regression wherein certain reporters did not correctly detect terminal width (@boneskull)
In this release, Mocha now builds its browser bundle with Rollup and Babel, which will provide the project's codebase more flexibility and consistency.
While we've been diligent about backwards compatibility, it's possible consumers of the browser bundle will encounter differences (other than an increase in the bundle size). If you do encounter an issue with the build, please report it here.
This release does not drop support for IE11.
Other community contributions came from @Devjeel, @Harsha509 and @sharath2106. Thank you to everyone who contributed to this release!
Do you read Korean? See this guide to running parallel tests in Mocha, translated by our maintainer, @outsideris.
- #4287: Use background colors with inline diffs for better visual distinction (@michael-brade)
- #4328: Fix "watch" mode when Mocha run in parallel (@boneskull)
- #4382: Fix root hook execution in "watch" mode (@indieisaconcept)
- #4383: Consistent auto-generated hook titles (@cspotcode)
- #4359: Better errors when running
mocha init
(@boneskull) - #4341: Fix weirdness when using
delay
option in browser (@craigtaub)
- #4378, #4333: Update javascript-serialize (@martinoppitz, @wnghdcjfe)
- #4354: Update yargs-unparser (@martinoppitz)
- #4173: Document how to use
--enable-source-maps
with Mocha (@bcoe) - #4343: Clean up some API docs (@craigtaub)
- #4318: Sponsor images are now self-hosted (@Munter)
The obligatory patch after a major.
- #4328: Fix
--parallel
when combined with--watch
(@boneskull)
In this major release, Mocha adds the ability to run tests in parallel. Better late than never! Please note the breaking changes detailed below.
Let's welcome @giltayar and @nicojs to the maintenance team!
-
#4164: Mocha v8.0.0 now requires Node.js v10.12.0 or newer. Mocha no longer supports the Node.js v8.x line ("Carbon"), which entered End-of-Life at the end of 2019 (@UlisesGascon)
-
#4175: Having been deprecated with a warning since v7.0.0,
mocha.opts
is no longer supported (@juergba)✨ WORKAROUND: Replace
mocha.opts
with a configuration file. -
#4260: Remove
enableTimeout()
(this.enableTimeout()
) from the context object (@craigtaub)✨ WORKAROUND: Replace usage of
this.enableTimeout(false)
in your tests withthis.timeout(0)
. -
#4315: The
spec
option no longer supports a comma-delimited list of files (@juergba)✨ WORKAROUND: Use an array instead (e.g.,
"spec": "foo.js,bar.js"
becomes"spec": ["foo.js", "bar.js"]
). -
#4309: Drop support for Node.js v13.x line, which is now End-of-Life (@juergba)
-
#4282:
--forbid-only
will throw an error even if exclusive tests are avoided via--grep
or other means (@arvidOtt) -
#4223: The context object's
skip()
(this.skip()
) in a "before all" (before()
) hook will no longer execute subsequent sibling hooks, in addition to hooks in child suites (@juergba) -
#4178: Remove previously soft-deprecated APIs (@wnghdcjfe):
Mocha.prototype.ignoreLeaks()
Mocha.prototype.useColors()
Mocha.prototype.useInlineDiffs()
Mocha.prototype.hideDiff()
-
#4245: Add ability to run tests in parallel for Node.js (see docs) (@boneskull)
❗ See also #4244; Root Hook Plugins (docs) -- root hooks must be defined via Root Hook Plugins to work in parallel mode
-
#4299: In some circumstances, Mocha can run ES modules under Node.js v10 -- use at your own risk! (@giltayar)
- #4246: Add documentation for parallel mode and Root Hook plugins (@boneskull)
- #4200: Drop mkdirp and replace it with fs.mkdirSync (@HyunSangHan)
(All bug fixes in Mocha v8.0.0 are also breaking changes, and are listed above)
- #4234: Add ability to run tests in a mocha instance multiple times (@nicojs)
- #4219: Exposing filename in JSON, doc, and json-stream reporters (@Daniel0113)
- #4244: Add Root Hook Plugins (@boneskull)
- #4258: Fix missing dot in name of configuration file (@sonicdoe)
- #4194: Check if module.paths really exists (@ematipico)
- #4256:
--forbid-only
does not recognizeit.only
whenbefore
crashes (@arvidOtt) - #4152: Bug with multiple async done() calls (@boneskull)
- #4275: Improper warnings for invalid reporters (@boneskull)
- #4288: Broken hook.spec.js test for IE11 (@boneskull)
- #4081: Insufficient white space for API docs in view on mobile (@HyunSangHan)
- #4255: Update mocha-docdash for UI fixes on API docs (@craigtaub)
- #4235: Enable emoji on website; enable normal ul elements (@boneskull)
- #4272: Fetch sponsors at build time, show ALL non-skeevy sponsors (@boneskull)
- #4249: Refactoring improving encapsulation (@arvidOtt)
- #4242: CI add job names, add Node.js v14 to matrix (@boneskull)
- #4237: Refactor validatePlugins to throw coded errors (@boneskull)
- #4236: Better debug output (@boneskull)
- #4251: Prevent karma-mocha from stalling (@juergba)
- #4222: Update dependency mkdirp to v0.5.5 (@outsideris)
- #4208: Add Wallaby logo to site (@boneskull)
- #4190: Show Netlify badge on footer (@outsideris)
#4038: Add Node.js native ESM support (@giltayar)
Mocha supports writing your test files as ES modules:
- Node.js only v12.11.0 and above
- Node.js below v13.2.0, you must set
--experimental-modules
option - current limitations: please check our documentation
- for programmatic usage: see API: loadFilesAsync()
Note: Node.JS native ECMAScript Modules implementation has status: Stability: 1 - Experimental
- #4181: Programmatic API cannot access retried test objects (@juergba)
- #4174: Browser: fix
allowUncaught
option (@juergba)
- #4058: Manage author list in AUTHORS instead of
package.json
(@outsideris)
- #4138: Upgrade ESLint v6.8 (@kaicataldo)
- #4165: Fix exception when skipping tests programmatically (@juergba)
- #4153: Restore backwards compatibility for
reporterOptions
(@holm) - #4150: Fix recovery of an open test upon uncaught exception (@juergba)
- #4147: Fix regression of leaking uncaught exception handler (@juergba)
- #4146: Update copyright & trademark notices per OJSF (@boneskull)
- #4140: Fix broken links (@KyoungWan)
- #3885: Drop Node.js v6.x support (@mojosoeun)
- #3890: Remove Node.js debug-related flags
--debug
/--debug-brk
and deprecatedebug
argument (@juergba) - #3962: Changes to command-line options (@ParkSB):
--list-interfaces
replaces--interfaces
--list-reporters
replaces--reporters
- Hook pattern of
this.skip()
(@juergba): - #3967: Remove deprecated
getOptions()
andlib/cli/options.js
(@juergba) - #4083: Uncaught exception in
pending
test: don't swallow, but retrospectively fail the test for correct exit code (@juergba) - #4004: Align
Mocha
constructor's option names with command-line options (@juergba)
- #3980: Refactor and improve
--watch
mode with chokidar (@geigerzaehler):- adds command-line options
--watch-files
and--watch-ignore
- removes
--watch-extensions
- adds command-line options
- #3979: Type "rs\n" to restart tests (@broofa)
These are soft-deprecated, and will emit a warning upon use. Support will be removed in (likely) the next major version of Mocha:
- #4125: Fix timeout handling with
--inspect-brk
/--inspect
(@juergba) - #4070:
Mocha
constructor: improve browser setup (@juergba) - #4068: XUnit reporter should handle exceptions during diff generation (@rgroothuijsen)
- #4030: Fix
--allow-uncaught
withthis.skip()
(@juergba)
- #4129: Fix broken links (@SaeromB)
- #4127: Add reporter alias names to docs (@khg0712)
- #4101: Clarify invalid usage of
done()
(@jgehrcke) - #4092: Replace
:coffee:
with emoji ☕️ (@pzrq) - #4088: Initial draft of project charter (@boneskull)
- #4066: Change
sh
tobash
for code block in docs/index.md (@HyunSangHan) - #4045: Update README.md concerning GraphicsMagick installation (@HyunSangHan)
- #3988: Fix sponsors background color for readability (@outsideris)
- #4118: Update node-environment-flags to 1.0.6 (@kylef)
- #4097: Add GH Funding Metadata (@SheetJSDev)
- #4089: Add funding information to
package.json
(@Munter) - #4077: Improve integration tests (@soobing)
- #4025: Fix duplicate
EVENT_RUN_END
events upon uncaught exception (@juergba) - #4051: Fix "unhide" function in
html
reporter (browser) (@pec9399) - #4063: Fix use of esm in Node.js v8.x (@boneskull)
- #4033: Fix output when multiple async exceptions are thrown (@juergba)
- #4046: Site accessibility fixes (@Mia-jeong)
- #4026: Update docs for custom reporters in browser (@Lindsay-Needs-Sleep)
- #3971: Adopt new OpenJS Foundation Code of Conduct (@craigtaub)
- #3955: tty.getWindowSize is not a function inside a "worker_threads" worker (@1999)
- #3970: remove extraGlobals() (@juergba)
- #3984: Update yargs-unparser to v1.6.0 (@juergba)
- #3983: Package 'esm': spawn child-process for correct loading (@juergba)
- #3986: Update yargs to v13.3.0 and yargs-parser to v13.1.1 (@juergba)
- #3886: fix styles on mochajs.org (@outsideris)
- #3966: Remove jsdoc index.html placeholder from eleventy file structure and fix broken link in jsdoc tutorial (@Munter)
- #3765: Add Matomo to website (@MarioDiaz98)
- #3947: Clarify effect of .skip() (@oliversalzburg)
- #3827: Do not fork child-process if no Node flags are present (@boneskull)
- #3725: Base reporter store ref to console.log, see mocha/wiki (@craigtaub)
- #3942: Fix "No test files found" Error when file is passed via
--file
(@gabegorelick) - #3914: Modify Mocha constructor to accept options
global
orglobals
(@pascalpp) - #3894: Fix parsing of config files with
_mocha
binary (@juergba) - #3834: Fix CLI parsing with default values (@boneskull, @juergba)
- #3831: Fix
--timeout
/--slow
string values and duplicate arguments (@boneskull, @juergba)
- #3906: Document option to define custom report name for XUnit reporter (@pkuczynski)
- #3889: Adds doc links for mocha-examples (@craigtaub)
- #3887: Fix broken links (@toyjhlee)
- #3841: Fix anchors to configuration section (@trescube)
- #3915, #3929: Increase tests coverage for
--watch
options (@geigerzaehler)
- #3953: Collect test files later, prepares improvements to the
--watch
mode behavior (@geigerzaehler) - #3939: Upgrade for npm audit (@boneskull)
- #3930: Extract
runWatch
into separate module (@geigerzaehler) - #3922: Add
mocha.min.js
file to stacktrace filter (@brian-lagerman) - #3919: Update CI config files to use Node-12.x (@plroebuck)
- #3892: Rework reporter tests (@plroebuck)
- #3872: Rename
--exclude
to--ignore
and create alias (@boneskull) - #3963: Hide stacktrace when cli args are missing (@outsideris)
- #3956: Do not redeclare variable in docs array example (@DanielRuf)
- #3957: Remove duplicate line-height property in
mocha.css
(@DanielRuf) - #3960: Don't re-initialize grep option on watch re-run (@geigerzaehler)
- #3877: Upgrade js-yaml, addressing code injection vulnerability (@bjornstar)
- #3863: Fix
yargs
-related global scope pollution (@inukshuk) - #3869: Fix failure when installed w/
pnpm
(@boneskull)
- #3867: Re-publish v6.1.1 from POSIX OS to avoid dropped executable flags (@boneskull)
- #3866: Fix Windows End-of-Line publishing issue (@juergba & @cspotcode)
- #3845: Update dependency "js-yaml" to v3.13.0 per npm security advisory (@plroebuck)
- #3766: Make reporter constructor support optional
options
parameter (@plroebuck) - #3760: Add support for config files with
.jsonc
extension (@sstephant)
These are soft-deprecated, and will emit a warning upon use. Support will be removed in (likely) the next major version of Mocha:
- #3829: Use cwd-relative pathname to load config file (@plroebuck)
- #3745: Fix async calls of
this.skip()
in "before each" hooks (@juergba) - #3669: Enable
--allow-uncaught
for uncaught exceptions thrown inside hooks (@givanse)
and some regressions:
- #3848: Fix
Suite
cloning by copyingroot
property (@fatso83) - #3816: Guard against undefined timeout option (@boneskull)
- #3814: Update "yargs" in order to avoid deprecation message (@boneskull)
- #3788: Fix support for multiple node flags (@aginzberg)
- mochajs/mocha-examples: New repository of working examples of common configurations using mocha (@craigtaub)
- #3850: Remove pound icon showing on header hover on docs (@jd2rogers2)
- #3812: Add autoprefixer to documentation page CSS (@Munter)
- #3811: Update doc examples "tests.html" (@DavidLi119)
- #3807: Mocha website HTML tweaks (@plroebuck)
- #3793: Update config file example ".mocharc.yml" (@cspotcode)
- #3830: Replace dependency "findup-sync" with "find-up" for faster startup (@cspotcode)
- #3799: Update devDependencies to fix many npm vulnerabilities (@XhmikosR)
Two more regressions fixed:
- #3768: Test file paths no longer dropped from
mocha.opts
(@boneskull) - #3767:
--require
does not break on module names that look like certainnode
flags (@boneskull)
The obligatory round of post-major-release bugfixes.
These issues were regressions.
- #3754: Mocha again finds
test.js
when run without arguments (@plroebuck) - #3756: Mocha again supports third-party interfaces via
--ui
(@boneskull) - #3755: Fix broken
--watch
(@boneskull) - #3759: Fix unwelcome deprecation notice when Mocha run against languages (CoffeeScript) with implicit return statements; returning a non-
undefined
value from adescribe
callback is no longer considered deprecated (@boneskull)
- #3738: Upgrade to
@mocha/docdash@2
(@tendonstrength) - #3751: Use preferred names for example config files (@Szauka)
- #3726: Add ability to unload files from
require
cache (@plroebuck)
- #3737: Fix falsy values from options globals (@plroebuck)
- #3707: Fix encapsulation issues for
Suite#_onlyTests
andSuite#_onlySuites
(@vkarpov15) - #3711: Fix diagnostic messages dealing with plurality and markup of output (@plroebuck)
- #3723: Fix "reporter-option" to allow comma-separated options (@boneskull)
- #3722: Fix code quality and performance of
lookupFiles
andfiles
(@plroebuck) - #3650, #3654: Fix noisy error message when no files found (@craigtaub)
- #3632: Tests having an empty title are no longer confused with the "root" suite (@juergba)
- #3666: Fix missing error codes (@vkarpov15)
- #3684: Fix exiting problem in Node.js v11.7.0+ (@addaleax)
- #3691: Fix
--delay
(and other boolean options) not working in all cases (@boneskull) - #3692: Fix invalid command-line argument usage not causing actual errors (@boneskull)
- #3698, #3699: Fix debug-related Node.js options not working in all cases (@boneskull)
- #3700: Growl notifications now show the correct number of tests run (@outsideris)
- #3686: Avoid potential ReDoS when diffing large objects (@cyjake)
- #3715: Fix incorrect order of emitted events when used programmatically (@boneskull)
- #3706: Fix regression wherein
--reporter-option
/--reporter-options
did not support comma-separated key/value pairs (@boneskull)
- #3677: Add error objects for createUnsupportedError and createInvalidExceptionError (@boneskull)
- #3733: Removed unnecessary processing in post-processing hook (@wanseob)
- #3730: Update nyc to latest version (@coreyfarrell)
- #3648, #3680: Fixes to support latest versions of unexpected and unexpected-sinon (@sunesimonsen)
- #3638: Add meta tag to site (@MartijnCuppens)
- #3653: Fix parts of test suite failing to run on Windows (@boneskull)
- Fix missing
mocharc.json
in published package (@boneskull)
Documentation for this release can be found at next.mochajs.org!
Welcome @plroebuck, @craigtaub, & @markowsiak to the team!
- #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 impliesjs
; it must be explicitly added (@TheDancingCode)
- #2908:
tap
reporter emits error messages (@chrmod) - #2819: When conditionally skipping in a
before
hook, subsequentbefore
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 tolib/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 aRunner
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). SomeError
messages have changed. Please use thecode
property to checkError
types instead of themessage
property; these descriptions will be localized in the future. (@craigtaub)
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 theloadMochaOpts
orloadOptions
(preferred) functions exported by thelib/cli/options
module
Regarding the Mocha
class constructor (from lib/mocha
):
- Use property
color: false
instead ofuseColors: false
- Use property
timeout: false
instead ofenableTimeouts: 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 introduced in #3556:
-
Mocha now supports "RC" files in JS, JSON, YAML, or
package.json
-based (usingmocha
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 explicitpackage.json
to read themocha
prop from - Use
--no-config
or--no-package
to completely disable loading of configuration via RC file andpackage.json
, respectively - Configurations are merged as applicable using the priority list:
- Command-line arguments
- RC file
package.json
mocha.opts
- 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 ofnode
(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, ormocha.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 ofnode
- Support all allowed
-
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 onlytest/*.coffee
(nottest/*.js
), you can domocha --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) -
#2529:
Runner
now emits aretry
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)
- #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)
- #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
- #3557: Use
ms
userland module instead of hand-rolled solution (@gizemkeser) - Many CI fixes and other refactors by @plroebuck
- Test refactors by @outsideris
- #3375: Add support for comments in
mocha.opts
(@plroebuck)
- #3346: Exit correctly from
before
hooks when using--bail
(@outsideris)
- #3330: Use
Buffer.from()
(@harrysarson) - #3295: Remove redundant folder (@DavNej)
- #3356: Refactoring (@plroebuck)
- #3325: Revert change which broke
--watch
(@boneskull)
- #3318: Fix failures in circular objects in JSON reporter (@jeversmann, @boneskull)
- #3323: Publish actual API documentation! (@dfberry, @Munter)
- #3299: Improve docs around exclusive tests (@nicgirault)
- #3302, #3308, #3310, #3315, #3316: Build matrix improvements (more info) (@outsideris, @boneskull)
- #3272: Refactor reporter tests (@jMuzsik)
Welcome @outsideris to the team!
- #3096: Fix
--bail
failing to bail within hooks (@outsideris) - #3184: Don't skip too many suites (using
describe.skip()
) (@outsideris)
- #3133: Improve docs regarding "pending" behavior (@ematicipo)
- #3276, #3274: Fix broken stuff in
CHANGELOG.md
(@tagoro9, @honzajavorek)
- #3208: Improve test coverage for AMD users (@outsideris)
- #3267: Remove vestiges of PhantomJS from CI (@anishkny)
- #2952: Fix a debug message (@boneskull)
- #3265: Fixes regression in "watch" functionality introduced in v5.0.2 (@outsideris)
This patch features a fix to address a potential "low severity" ReDoS vulnerability in the diff package (a dependency of Mocha).
- #3011: Expose
generateDiff()
inBase
reporter (@harrysarson)
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!
-
#3226: Do not swallow errors that are thrown asynchronously from passing tests (@boneskull). Example:
```js 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 theend
event twice; you may need to change your reporter to userunner.once('end')
intead ofrunner.on('end')
. -
#3093: Fix stack trace reformatting problem (@outsideris)
- #3248: Update
browser-stdout
to v1.3.1 (@honzajavorek)
...your garden-variety patch release.
Special thanks to Wallaby.js for their continued support! ❤️
- #1838:
--delay
now works with.only()
(@silviom) - #3119: Plug memory leak present in v8 (@boneskull)
- #3132, #3098: Update
--glob
docs (@outsideris) - #3212: Update Wallaby.js-related docs (@ArtemGovorov)
- #3205: Remove outdated cruft (@boneskull)
- #3224: Add proper Wallaby.js config (@ArtemGovorov)
- #3230: Update copyright year (@josephlin55555)
Mocha starts off 2018 right by again dropping support for unmaintained rubbish.
Welcome @vkarpov15 to the team!
- #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.
- #3181: Add useful new
--file
command line argument (documentation) (@hswolff)
- #3187: Fix inaccurate test duration reporting (@FND)
- #3202: Fix bad markup in HTML reporter (@DanielRuf)
- #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)
- #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)