| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| mocha (source) | ^6.2.0
-> ^9.0.0
| | | | |
mochajs/mocha
Compare Source
:bug: Fixes
:nut_and_bolt: Other
Compare Source
:bug: Fixes
Compare Source
:tada: Enhancements
:nut_and_bolt: Other
Compare Source
:bug: Fixes
:nut_and_bolt: Other
Compare Source
:bug: Fixes
:nut_and_bolt: Other
Compare Source
:bug: Fixes
:nut_and_bolt: Other
Compare Source
:bug: Fixes
Compare Source
:tada: Enhancements
Compare Source
:bug: Fixes
Compare Source
:bug: Fixes
- #4668: ESM: make
--require <dir>
work with new import
-first loading (@giltayar)
:nut_and_bolt: Other
Compare Source
:nut_and_bolt: Other
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.
Compare Source
:boom: Breaking Changes
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.
:tada: Enhancements
:bug: Fixes
:nut_and_bolt: Other
Compare Source
:tada: Enhancements
:bug: Fixes
:book: Documentation
- #4630: Add
options.require
to Mocha constructor for root 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.
Compare Source
:bug: Fixes
:book: Documentation
Compare Source
:bug: Fixes
Compare Source
:tada: Enhancements
:bug: Fixes
:book: Documentation
:nut_and_bolt: Other
Also thanks to @outsideris and @HyunSangHan for various fixes to our website and documentation.
Compare Source
Fixed stuff.
:bug: Fixes
- #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!
Compare Source
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).
:tada: Enhancements
For implementors of custom reporters:
- #4409: Parallel mode and custom reporter improvements (@boneskull):
- Support custom worker-process-only reporters (
Runner.prototype.workerReporter()
); reporters should subclass ParallelBufferedReporter
in mocha/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 consuming Runner
event data
- Enable detection of parallel mode (
Runner.prototype.isParallelMode()
)
:bug: Fixes
- #4476: Workaround for profoundly bizarre issue affecting
npm
v6.x causing some of Mocha's deps to be installed when mocha
is present in a package's devDependencies
and npm 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()
in mocha/lib/utils
, which was broken/missing in Mocha v8.1.0; it now prints a deprecation warning (use const {lookupFiles} = require('mocha/lib/cli')
instead) (@boneskull)
Thanks to @AviVahl, @donghoon-song, @ValeriaVG, @znarf, @sujin-park, and @majecty for other helpful contributions!
Compare Source
:bug: Fixes
- #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; use require('mocha/lib/cli').lookupFiles
instead (@boneskull)
Compare Source
:bug: Fixes
:lock: Security Fixes
:book: Documentation
Compare Source
:bug: Fixes
- #4394: Fix regression wherein certain reporters did not correctly detect terminal width (@boneskull)
Compare Source
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.
:tada: Enhancements
:bug: Fixes
:lock: Security Fixes
:book: Documentation & Website
:nut_and_bolt: Other
- #4293: Use Rollup and Babel in build pipeline; add source map to published files (@Munter)
Compare Source
The obligatory patch after a major.
:bug: Fixes
Compare Source
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!
:boom: Breaking Changes
-
#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)
:sparkles: WORKAROUND: Replace mocha.opts
with a configuration file.
-
#4260: Remove enableTimeout()
(this.enableTimeout()
) from the context object (@craigtaub)
:sparkles: WORKAROUND: Replace usage of this.enableTimeout(false)
in your tests with this.timeout(0)
.
-
#4315: The spec
option no longer supports a comma-delimited list of files (@juergba)
:sparkles: 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()
:tada: Enhancements
:book: Documentation
:nut_and_bolt: Other
:bug: Fixes
(All bug fixes in Mocha v8.0.0 are also breaking changes, and are listed above)
Compare Source
:tada: Enhancements
:bug: Fixes
:book: Documentation
:nut_and_bolt: Other
Compare Source
:nut_and_bolt: Other
:book: Documentation
Compare Source
:lock: Security Fixes
:bug: Fixes
:book: Documentation
Compare Source
:tada: Enhancements
#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
:bug: Fixes
:book: Documentation
:nut_and_bolt: Other
Compare Source
:bug: Fixes
- #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)
:book: Documentation
:nut_and_bolt: Other
Compare Source
:boom: Breaking Changes
- #3885: Drop Node.js v6.x support (@mojosoeun)
- #3890: Remove Node.js debug-related flags
--debug
/--debug-brk
and deprecate debug
argument (@juergba)
- #3962: Changes to command-line options (@ParkSB):
--list-interfaces
replaces --interfaces
--list-reporters
replaces --reporters
- Hook pattern of
this.skip()
(@juergba):
- #3859: When conditionally skipping in a
it
test, related afterEach
hooks are now executed
- #3741: When conditionally skipping in a
beforeEach
hook, subsequent inner beforeEach
hooks are now skipped and related afterEach
hooks are executed
- #4136: Disallow
this.skip()
within after
hooks
- #3967: Remove deprecated
getOptions()
and lib/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)
:tada: Enhancements
- #3980: Refactor and improve
--watch
mode with chokidar (@geigerzaehler):
- adds command-line options
--watch-files
and --watch-ignore
- removes
--watch-extensions
- #3979: Type "rs\n" to restart tests (@broofa)
:fax: Deprecations
These are soft-deprecated, and will emit a warning upon use. Support will be removed in (likely) the next major version of Mocha:
:bug: Fixes
:mag: Coverage
:book: Documentation
:nut_and_bolt: Other