Compare Versions - mocha
npm / mocha / Compare Versions
→
12.0.0-beta-7 (2026-02-03)
🩹 Fixes
- bump diff dependency to ^8.0.3 (#5674) (15fb31a)
- print helpful message when internal CLI error happens (#5344) (1e11836)
📚 Documentation
🧹 Chores
12.0.0-beta-4 (2026-01-04)
🌟 Features
- ESM configuration file (#5397) (dff9d78)
- migrate Markdown lint to
@eslint/markdown(#5593) (d9e1f0a)
🩹 Fixes
📚 Documentation
🧹 Chores
- ci: use OIDC token for trusted publishing to
npm(#5610) (dc0fdb7) - create exclusions for nyc (#5609) (702473a)
- main: release 12.0.0-beta-4 (#5598) (424516e)
- prevent unwanted Prettier rewrites (#5591) (3ea1578)
- remove broken browser-test.yml (#5615) (33ce345)
- remove legacy
docs/(#5583) (d8c310e) - revert "chore(main): release 12.0.0-beta-4 (#5598)" (#5619) (dba8091)
🤖 Automation
12.0.0-beta-3 (2026-01-01)
🌟 Features
- add mocha.mjs export (#5527) (e1cf23c)
- bump serialize-javascript from 6.0.2 to 7.0.2 (#5589) (24fb1b6)
- bump strip-json-comments from 3 to 5 (#5484) (9b0db24)
🩹 Fixes
- allow importing ESM interface and reporters (#5563) (bc9fc84)
- docs-next: backer's logo is consistent regardless of size (#5594) (1a53a10)
- surface ts-node compile errors (#5572) (add4cf8)
📚 Documentation
- bumped docs-next Astro to ^5.16.6 (#5574) (806222b)
- fix light mode Astro accent text color (#5585) (9cc3ada)
- update Contributor License Agreement link in CONTRIBUTING.md (#5567) (410ce0d)
🧹 Chores
- normalized ESLint config to v9's recommended structure (#5575) (7f9ed1f)
- update Rollup to v4 (#5510) (cafa782)
🤖 Automation
12.0.0-beta-10 (2026-02-21)
🌟 Features
🩹 Fixes
- change Pending to properly extend Error (#5679) (158effd)
- deps: update dependency chokidar to v5 (#5734) (ff2f17f)
- deps: update dependency minimatch to v10 (#5743) (3f3e449)
- deps: update dependency starlight-package-managers to ^0.12.0 (#5717) (aa4ba48)
📚 Documentation
🧹 Chores
- Configure Renovate (#5678) (a9c9b90)
- deps: update dependency @rollup/plugin-alias to v6 (#5718) (267d751)
- deps: update dependency @rollup/plugin-commonjs to v29 (#5719) (9ed4ee5)
- deps: update dependency astro to v5.17.1 (#5703) (ec3d1fa)
- deps: update dependency chai to v4.5.0 (#5705) (870f9f8)
- deps: update dependency cross-env to v10 (#5721) (20b7476)
- deps: update dependency knip to v5.83.1 (#5708) (d833413)
- deps: update dependency npm-run-all2 to v8 (#5727) (e38e0ec)
- deps: update dependency prettier to v3.8.1 (#5709) (2f98cfd)
- deps: update dependency rimraf to v6 (#5728) (ba124e9)
- deps: update dependency rollup to v4.57.1 (#5710) (178749d)
- deps: update dependency unexpected-map to v3 (#5736) (c1f3379)
- deps: update dependency unist-util-visit to v5.1.0 (#5711) (7ede894)
- deps: update dependency webdriverio to v9 (#5739) (ff334df)
- deps: update dependency webpack-cli to v6 (#5741) (95c9d75)
- deps: update dependency workerpool to v9.3.4 (#5715) (c030a3b)
- deps: update remark (#5745) (37a25f1)
- fix timeout issue with some XUnit tests (53cc467)
- switch Suite from util.inherits to ES2015 classes (#5179) (1ce690e)
🤖 Automation
12.0.0-beta-1 (2025-11-25)
Maintainer notes: This is a beta release. It will be followed by 0 or more betas adding features and bugfixes, then 0 or more release candidates once we finish the v12 feature set, then a full release. For details, see #5551. Thanks for using Mocha, and happy testing!
⚠ BREAKING CHANGES
- cleanup references of --compilers (#5403)
- cleanup references of --opts (#5402)
- change the default of --forbid-only to check for process.env.CI (#5496)
- bump minimum Node.js version from 18.18.0 to 20.19.0 (#5477)
🌟 Features
- allow FIFOs as test files (#5512) (ca4af43)
- bump minimum Node.js version from 18.18.0 to 20.19.0 (#5477) (1c34eef)
- change the default of --forbid-only to check for process.env.CI (#5496) (3d94dde)
- cleanup references of --compilers (#5403) (f75d150)
- cleanup references of --opts (#5402)
🩹 Fixes
- correct assertion import syntax in getting-started guide (#5526) (fb0215b)
- handle empty null-prototyped objects (#5506) (2a0bce0)
📚 Documentation
- add maintainer expectations to MAINTAINERS.md (#5514) (76f95a1)
- migrate how-to wiki pages to main documentation (#5463) (b85aec6)
- migrate programmatic usage to docs, development content to DEVELOPMENT.md (#5464) (cb47925)
- test/integration/README: remove ref to non-existent dir (#5516) (d2c2d40)
- update TSC Members' hourly rate to $75 (#5488)
🧹 Chores
- applied formatting to all files (#5493) (76d7194)
- fix broken link in .github/CONTRIBUTING.md (681e843)
- remove Node.js 18 from test-smoke in CI too (d643105)
- switch from Coveralls to Codecov (#5447) (f4e7e54)
- unpin node-version in release-please (#5550) (62c90cd)
- use
ps-listinstead ofpidtreeto remove wmic (#5479) (b2985b3)
🤖 Automation
11.7.2 (2025-09-01)
🩹 Fixes
- fail with an informative error message on a file with a broken default import (#5413) (b0e6135)
- load mjs files correctly (#5429) (a947b9b)
📚 Documentation
- add banner from old site to new site, link from new to old (#5414) (dedef11)
- add info on spies to legacy docs (#5421) (21f5544)
- explain node import swallowing error (#5401) (09f5b2c)
- fix links in new site (#5416) (b2bc769)
- migrate assertion libraries wiki link to main docs (#5442) (95f3ca8)
- migrate count assertions wiki page to docs (#5438) (02a306c)
- migrate shared behaviours to docs-next (#5432) (1dc4aa9)
- migrate Spies wiki page to explainers (#5420) (cbcf007)
- Migrate tagging wiki page to docs (#5435) (876247a)
- migrate third party reporters wiki page to docs (#5433) (f70764c)
- migrate to global leak wiki page to docs (#5437) (8a6fdca)
- update /next bug report link to be docs issue template (#5424) (668cb66)
🧹 Chores
- add issue form for ⚡️ Performance (#5406) (a908b3b)
- add test for
-R import-only-loader(#5391) (6ee5b48) - also test Node.js 24 in CI (#5405) (15f5980)
- bump CI to use 20.19.4, 22.18.0, 24.6.0 (#5430) (ace5eb4)
- bump Knip to 5.61.2 (#5394) (f3d7430)
- cleanup references of --opts (#5402) (1096b37)
- enabled ESLint's no-unused-vars (#5399) (d4168ae)
- move callback and object typedefs to a new types.d.ts (#5351) (3300d21)
- rewrite base path instead of copy-pasting (#5431) (c6c6740)
- unify caught errors as err (#5439) (d4912e7)
- Update experimental module detection test and pin exact Node versions (#5417) (2489090)
🤖 Automation
11.1.0 (2025-01-02)
🌟 Features
- bump yargs to 17 (#5165) (8f1c8d8)
- Note that this also included a version bump of
yargs-parserfrom^20.2.9to^21.1., which fixed a bug that caused extra quotes in file paths to be removed. See #5341 for more information.
- Note that this also included a version bump of
What's Changed
- feat: add option to not fail on failing test suite by @ilgonmic in https://github.com/mochajs/mocha/pull/4771
New Contributors
- @ilgonmic made their first contribution in https://github.com/mochajs/mocha/pull/4771
Full Changelog: https://github.com/mochajs/mocha/compare/v10.6.1...v10.7.0
What's Changed
- fix: do not exit when only unref'd timer is present in test code by @boneskull in https://github.com/mochajs/mocha/pull/3825
- fix: support canonical module by @JacobLey in https://github.com/mochajs/mocha/pull/5040
Full Changelog: https://github.com/mochajs/mocha/compare/v10.6.0...v10.6.1
What's Changed
- feat: allow ^ versions for character encoding packages by @JoshuaKGoldberg in https://github.com/mochajs/mocha/pull/5150
- feat: allow ^ versions for yargs packages by @JoshuaKGoldberg in https://github.com/mochajs/mocha/pull/5152
- feat: allow ^ versions for file matching packages by @JoshuaKGoldberg in https://github.com/mochajs/mocha/pull/5151
- feat: allow ^ versions for data serialization packages by @JoshuaKGoldberg in https://github.com/mochajs/mocha/pull/5153
- feat: allow ^ versions for miscellaneous packages by @JoshuaKGoldberg in https://github.com/mochajs/mocha/pull/5154
Full Changelog: https://github.com/mochajs/mocha/compare/v10.5.2...v10.6.0
What's Changed
- fix: better tracking of seen objects in error serialization by @sam-super in https://github.com/mochajs/mocha/pull/5032
New Contributors
- @sam-super made their first contribution in https://github.com/mochajs/mocha/pull/5032
Full Changelog: https://github.com/mochajs/mocha/compare/v10.5.1...v10.5.2
What's Changed
- fix: Add error handling for nonexistent file case with --file option by @khoaHyh in https://github.com/mochajs/mocha/pull/5086
New Contributors
- @khoaHyh made their first contribution in https://github.com/mochajs/mocha/pull/5086
Full Changelog: https://github.com/mochajs/mocha/compare/v10.5.0...v10.5.1
:tada: Enhancements
- #5015 feat: use <progress> and <svg> for browser progress indicator instead of <canvas> (@yourWaifu)
- #5143 feat: allow using any 3.x chokidar dependencies (@simhnna)
- #4835 feat: add MOCHA_OPTIONS env variable (@icholy)
:bug: Fixes
- #5107 fix: include stack in browser uncaught error reporting (@JoshuaKGoldberg)
:nut_and_bolt: Other
- #5110 chore: switch two-column list styles to be opt-in (@marjys)
- #5135 chore: fix some typos in comments (@StevenMia)
- #5130 chore: rename 'master' to 'main' in docs and tooling (@JoshuaKGoldberg)
10.4.0 / 2024-03-26
:tada: Enhancements
- #4829 feat: include
.causestacks in the error stack traces (@voxpelli) - #4985 feat: add file path to xunit reporter (@bmish)
:bug: Fixes
:nut_and_bolt: Other
- #5077 chore: add mtfoley/pr-compliance-action (@JoshuaKGoldberg)
- #5060 chore: migrate ESLint config to flat config (@JoshuaKGoldberg)
- #5095 chore: revert #5069 to restore Netlify builds (@voxpelli)
- #5097 docs: add sponsored to sponsorship link rels (@JoshuaKGoldberg)
- #5093 chore: add 'status: in triage' label to issue templates and docs (@JoshuaKGoldberg)
- #5083 docs: fix CHANGELOG.md headings to start with a root-level h1 (@JoshuaKGoldberg)
- #5100 chore: fix header generation and production build crashes (@JoshuaKGoldberg)
- #5104 chore: bump ESLint ecmaVersion to 2020 (@JoshuaKGoldberg)
- #5116 fix: eleventy template builds crash with 'unexpected token at ": string, msg..."' (@LcsK)
- #4869 docs: fix documentation concerning glob expansion on UNIX (@binki)
- #5122 test: fix xunit integration test (@voxpelli)
- #5123 chore: activate dependabot for workflows (@voxpelli)
- #5125 build(deps): bump the github-actions group with 2 updates (@dependabot)
This is a stable release equivalent to v10.3.0-preminor.0.
What's Changed
- Fix deprecated warn gh actions by @outsideris in https://github.com/mochajs/mocha/pull/4962
- fix #4837 Update glob due to vulnerability in dep by @jb2311 in https://github.com/mochajs/mocha/pull/4970
- Add Node v19 to test matrix by @juergba in https://github.com/mochajs/mocha/pull/4974
- chore: fix the ci by @Uzlopak in https://github.com/mochajs/mocha/pull/5020
- update can-i-use by @Uzlopak in https://github.com/mochajs/mocha/pull/5021
- chore: remove uuid dev dependency by @Uzlopak in https://github.com/mochajs/mocha/pull/5022
- chore: remove nanoid as dependency by @Uzlopak in https://github.com/mochajs/mocha/pull/5024
- chore: remove touch as dev dependency by @Uzlopak in https://github.com/mochajs/mocha/pull/5023
- chore: remove stale workflow by @JoshuaKGoldberg in https://github.com/mochajs/mocha/pull/5029
- docs: fix fragment ID for yargs' "extends" documentation by @Spencer-Doak in https://github.com/mochajs/mocha/pull/4918
- docs: use mocha.js instead of mocha in the example run by @nikolas in https://github.com/mochajs/mocha/pull/4927
- docs: fix jsdoc return type of
titlePathmethod by @F3n67u in https://github.com/mochajs/mocha/pull/4886 - docs: overhaul contributing and maintenance docs for end-of-year 2023 by @JoshuaKGoldberg in https://github.com/mochajs/mocha/pull/5038
- docs: touchups to labels and a template title post-revamp by @JoshuaKGoldberg in https://github.com/mochajs/mocha/pull/5050
- fix: add alt text to Built with Netlify badge by @JoshuaKGoldberg in https://github.com/mochajs/mocha/pull/5068
- chore: inline nyan reporter's write function by @JoshuaKGoldberg in https://github.com/mochajs/mocha/pull/5056
- chore: remove unnecessary canvas dependency by @JoshuaKGoldberg in https://github.com/mochajs/mocha/pull/5069
New Contributors
- @jb2311 made their first contribution in https://github.com/mochajs/mocha/pull/4970
- @Uzlopak made their first contribution in https://github.com/mochajs/mocha/pull/5020
- @Spencer-Doak made their first contribution in https://github.com/mochajs/mocha/pull/4918
- @nikolas made their first contribution in https://github.com/mochajs/mocha/pull/4927
- @F3n67u made their first contribution in https://github.com/mochajs/mocha/pull/4886
Full Changelog: https://github.com/mochajs/mocha/compare/v10.2.0...v10.3.0
A test release tagged with next on npm, to test that we can do releases at all. See #5081 for context.
What's Changed
- Fix deprecated warn gh actions by @outsideris in https://github.com/mochajs/mocha/pull/4962
- fix #4837 Update glob due to vulnerability in dep by @jb2311 in https://github.com/mochajs/mocha/pull/4970
- Add Node v19 to test matrix by @juergba in https://github.com/mochajs/mocha/pull/4974
- chore: fix the ci by @Uzlopak in https://github.com/mochajs/mocha/pull/5020
- update can-i-use by @Uzlopak in https://github.com/mochajs/mocha/pull/5021
- chore: remove uuid dev dependency by @Uzlopak in https://github.com/mochajs/mocha/pull/5022
- chore: remove nanoid as dependency by @Uzlopak in https://github.com/mochajs/mocha/pull/5024
- chore: remove touch as dev dependency by @Uzlopak in https://github.com/mochajs/mocha/pull/5023
- chore: remove stale workflow by @JoshuaKGoldberg in https://github.com/mochajs/mocha/pull/5029
- docs: fix fragment ID for yargs' "extends" documentation by @Spencer-Doak in https://github.com/mochajs/mocha/pull/4918
- docs: use mocha.js instead of mocha in the example run by @nikolas in https://github.com/mochajs/mocha/pull/4927
- docs: fix jsdoc return type of
titlePathmethod by @F3n67u in https://github.com/mochajs/mocha/pull/4886 - docs: overhaul contributing and maintenance docs for end-of-year 2023 by @JoshuaKGoldberg in https://github.com/mochajs/mocha/pull/5038
- docs: touchups to labels and a template title post-revamp by @JoshuaKGoldberg in https://github.com/mochajs/mocha/pull/5050
- fix: add alt text to Built with Netlify badge by @JoshuaKGoldberg in https://github.com/mochajs/mocha/pull/5068
- chore: inline nyan reporter's write function by @JoshuaKGoldberg in https://github.com/mochajs/mocha/pull/5056
- chore: remove unnecessary canvas dependency by @JoshuaKGoldberg in https://github.com/mochajs/mocha/pull/5069
New Contributors
- @jb2311 made their first contribution in https://github.com/mochajs/mocha/pull/4970
- @Uzlopak made their first contribution in https://github.com/mochajs/mocha/pull/5020
- @Spencer-Doak made their first contribution in https://github.com/mochajs/mocha/pull/4918
- @nikolas made their first contribution in https://github.com/mochajs/mocha/pull/4927
- @F3n67u made their first contribution in https://github.com/mochajs/mocha/pull/4886
Full Changelog: https://github.com/mochajs/mocha/compare/v10.2.0...v10.3.0-preminor.0
10.2.0 / 2022-12-11
:tada: Enhancements
:bug: Fixes
- #4946: Browser: color of failed test icon (@kleisauke)
:book: Documentation
- #4944: Remove duplicated header (@PauloGoncalvesBH)
10.1.0 / 2022-10-16
:tada: Enhancements
:nut_and_bolt: Other
- #4912: Browser: increase contrast for replay buttons (@JoshuaKGoldberg)
- #4905: Use standard
Promise.allSettledinstead of polyfill (@outsideris) - #4899: Upgrade official GitHub actions to latest (@ddzz)
- #4770: Fix regex in function
clean(@yetingli)
10.0.0 / 2022-05-01
:boom: Breaking Changes
-
#4863: Rename executable
bin/mochatobin/mocha.js(@juergba) -
#4865:
--ignoreoption in Windows: upgrade Minimatch (@juergba)
:nut_and_bolt: Other
-
#4876: Add Node.js v18 to CI test matrix (@outsideris)
-
#4852: Replace deprecated
String.prototype.substr()(@CommanderRoot)
Also thanks to @ea2305 and @SukkaW for improvements to our documentation.
9.1.4 / 2022-01-14
Please also note our announcements.
:bug: Fixes
:nut_and_bolt: Other
- #4777: Add Node v17 to CI test matrix (@outsideris)
9.1.3 / 2021-10-15
Please also note our announcements.
:bug: Fixes
:nut_and_bolt: Other
- #4764: Revert deprecation of
EVENT_SUITE_ADD_*events (@beatfactor)
9.1.2 / 2021-09-25
Please also note our announcements.
:bug: Fixes
- #4746: Browser: stop using all global vars in
browser-entry.js(@PaperStrike)
:nut_and_bolt: Other
9.1.1 / 2021-08-28
Please also note our announcements.
:bug: Fixes
- #4623:
XUNITandJSONreporter crash inparallelmode (@curtisman)
9.0.1 / 2021-06-18
: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.
- #4653: ESM: proper version check in
hasStableEsmImplementation(@alexander-fenster)
9.0.0 / 2021-06-07
: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.
-
#4638: Limit the size of
actual/expectedfordiffgeneration (@juergba) -
#4389: Refactoring: Consuming log-symbols alternate to code for win32 in reporters/base (@MoonSupport)
:tada: Enhancements
:bug: Fixes
:nut_and_bolt: Other
8.4.0 / 2021-05-07
:tada: Enhancements
- #4502: CLI file parsing errors now have error codes (@evaline-ju)
:bug: Fixes
- #4614: Watch: fix crash when reloading files (@outsideris)
:book: Documentation
- #4630: Add
options.requireto Mocha constructor forroot hookplugins on parallel runs (@juergba) - #4617: Dynamically generating tests with
top-level awaitand ESM test files (@juergba) - #4608: Update default file extensions (@outsideris)
Also thanks to @outsideris for various improvements on our GH actions workflows.
8.3.2 / 2021-03-12
:bug: Fixes
- #4599: Fix regression in
requireinterface (@alexander-fenster)
:book: Documentation
- #4601: Add build to GH actions run (@christian-bromann)
- #4596: Filter active sponsors/backers (@juergba)
- #4225: Update config file examples (@pkuczynski)
8.3.0 / 2021-02-11
:tada: Enhancements
- #4506: Add error code for test timeout errors (@boneskull)
- #4112: Add BigInt support to stringify util function (@JosejeSinohui)
:bug: Fixes
- #4557: Add file location when SyntaxError happens in ESM (@giltayar)
- #4521: Fix
requireerror when bundling Mocha with Webpack (@devhazem)
:book: Documentation
- #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)
:nut_and_bolt: Other
- #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.
8.2.1 / 2020-11-02
Fixed stuff.
:bug: Fixes
- #4489: Fix problematic handling of otherwise-unhandled
Promiserejections and erroneous "done()called twice" errors (@boneskull) - #4496: Avoid
MaxListenersExceededWarningin watch mode (@boneskull)
Also thanks to @akeating for a documentation fix!
8.2.0 / 2020-10-16
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
- #4308: Support run-once global setup & teardown fixtures (@boneskull)
- #4442: Multi-part extensions (e.g.,
test.js) now usable with--extensionoption (@jordanstephens) - #4472: Leading dots (e.g.,
.js,.test.js) now usable with--extensionoption (@boneskull) - #4434: Output of
jsonreporter 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 subclassParallelBufferedReporterinmocha/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 consumingRunnerevent data - Enable detection of parallel mode (
Runner.prototype.isParallelMode())
- Support custom worker-process-only reporters (
:bug: Fixes
- #4476: Workaround for profoundly bizarre issue affecting
npmv6.x causing some of Mocha's deps to be installed whenmochais present in a package'sdevDependenciesandnpm install --productionis 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
nycwith 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!
8.1.3 / 2020-08-28
: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; userequire('mocha/lib/cli').lookupFilesinstead (@boneskull)
8.1.2 / 2020-08-25
:bug: Fixes
- #4418: Fix command-line flag incompatibility in forthcoming Node.js v14.9.0 (@boneskull)
- #4401: Fix missing global variable in browser (@irrationnelle)
:lock: Security Fixes
:book: Documentation
- Various fixes by @sujin-park, @wwhurin & @Donghoon759
8.1.1 / 2020-08-04
:bug: Fixes
- #4394: Fix regression wherein certain reporters did not correctly detect terminal width (@boneskull)
8.1.0 / 2020-07-30
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
- #4287: Use background colors with inline diffs for better visual distinction (@michael-brade)
:bug: Fixes
- #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
delayoption in browser (@craigtaub)
:lock: Security Fixes
- #4378, #4333: Update javascript-serialize (@martinoppitz, @wnghdcjfe)
- #4354: Update yargs-unparser (@martinoppitz)
:book: Documentation & Website
- #4173: Document how to use
--enable-source-mapswith Mocha (@bcoe) - #4343: Clean up some API docs (@craigtaub)
- #4318: Sponsor images are now self-hosted (@Munter)
:nut_and_bolt: Other
8.0.1 / 2020-06-10
The obligatory patch after a major.
:bug: Fixes
- #4328: Fix
--parallelwhen combined with--watch(@boneskull)
8.0.0 / 2020-06-10
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.optsis no longer supported (@juergba):sparkles: WORKAROUND: Replace
mocha.optswith a configuration file. -
#4260: Remove
enableTimeout()(this.enableTimeout()) from the context object (@craigtaub):sparkles: WORKAROUND: Replace usage of
this.enableTimeout(false)in your tests withthis.timeout(0). -
#4315: The
specoption 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-onlywill throw an error even if exclusive tests are avoided via--grepor 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
-
#4245: Add ability to run tests in parallel for Node.js (see docs) (@boneskull)
:exclamation: 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)
:book: Documentation
- #4246: Add documentation for parallel mode and Root Hook plugins (@boneskull)
:nut_and_bolt: Other
- #4200: Drop mkdirp and replace it with fs.mkdirSync (@HyunSangHan)
:bug: Fixes
(All bug fixes in Mocha v8.0.0 are also breaking changes, and are listed above)
7.2.0 / 2020-05-22
:tada: Enhancements
- #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)
:bug: Fixes
- #4258: Fix missing dot in name of configuration file (@sonicdoe)
- #4194: Check if module.paths really exists (@ematipico)
- #4256:
--forbid-onlydoes not recognizeit.onlywhenbeforecrashes (@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)
:book: Documentation
- #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)
:nut_and_bolt: Other
- #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)
7.1.2 / 2020-04-26
:nut_and_bolt: Other
- #4251: Prevent karma-mocha from stalling (@juergba)
- #4222: Update dependency mkdirp to v0.5.5 (@outsideris)
:book: Documentation
- #4208: Add Wallaby logo to site (@boneskull)
7.1.0 / 2020-02-26
: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-modulesoption - 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
- #4181: Programmatic API cannot access retried test objects (@juergba)
- #4174: Browser: fix
allowUncaughtoption (@juergba)
:book: Documentation
- #4058: Manage author list in AUTHORS instead of
package.json(@outsideris)
:nut_and_bolt: Other
- #4138: Upgrade ESLint v6.8 (@kaicataldo)
7.0.1 / 2020-01-25
: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
- #4146: Update copyright & trademark notices per OJSF (@boneskull)
- #4140: Fix broken links (@KyoungWan)
:nut_and_bolt: Other
7.0.0 / 2020-01-05
:boom: Breaking Changes
- #3885: Drop Node.js v6.x support (@mojosoeun)
- #3890: Remove Node.js debug-related flags
--debug/--debug-brkand deprecatedebugargument (@juergba) - #3962: Changes to command-line options (@ParkSB):
--list-interfacesreplaces--interfaces--list-reportersreplaces--reporters
- Hook pattern of
this.skip()(@juergba): - #3967: Remove deprecated
getOptions()andlib/cli/options.js(@juergba) - #4083: Uncaught exception in
pendingtest: don't swallow, but retrospectively fail the test for correct exit code (@juergba) - #4004: Align
Mochaconstructor's option names with command-line options (@juergba)
:tada: Enhancements
- #3980: Refactor and improve
--watchmode with chokidar (@geigerzaehler):- adds command-line options
--watch-filesand--watch-ignore - removes
--watch-extensions
- adds command-line options
- #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
- #4125: Fix timeout handling with
--inspect-brk/--inspect(@juergba) - #4070:
Mochaconstructor: improve browser setup (@juergba) - #4068: XUnit reporter should handle exceptions during diff generation (@rgroothuijsen)
- #4030: Fix
--allow-uncaughtwiththis.skip()(@juergba)
:mag: Coverage
:book: Documentation
- #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
shtobashfor code block in docs/index.md (@HyunSangHan) - #4045: Update README.md concerning GraphicsMagick installation (@HyunSangHan)
- #3988: Fix sponsors background color for readability (@outsideris)
:nut_and_bolt: Other
7.0.0-esm1 / 2020-01-12
This is an experimental release based on v7.0.0: npm i mocha@7.0.0-esm1
:tada: Enhancements
#4038: Add Node.js native ESM support (@giltayar)
Enables Mocha to load ECMAScript Modules test files, also valid for --file option.
Limitations:
- Node.js only v12.11.0 and above
- Node.js below v13.2.0, you must set
--experimental-modulesoption - ESM not (yet) supported for:
--watchmode--requireoption--reportercustom reporters--uicustom interfacesmocharcconfiguration file
6.2.2 / 2019-10-18
:bug: Fixes
- #4025: Fix duplicate
EVENT_RUN_ENDevents upon uncaught exception (@juergba) - #4051: Fix "unhide" function in
htmlreporter (browser) (@pec9399) - #4063: Fix use of esm in Node.js v8.x (@boneskull)
- #4033: Fix output when multiple async exceptions are thrown (@juergba)
:book: Documentation
- #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)
6.2.1 / 2019-09-29
:bug: Fixes
- #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)
:book: Documentation
- #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)
6.2.0 / 2019-07-18
:tada: Enhancements
- #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)
:bug: Fixes
- #3960: Don't re-initialize grep option on watch re-run (@geigerzaehler)
- #3942: Fix "No test files found" Error when file is passed via
--file(@gabegorelick) - #3914: Modify Mocha constructor to accept options
globalorglobals(@pascalpp) - #3894: Fix parsing of config files with
_mochabinary (@juergba) - #3834: Fix CLI parsing with default values (@boneskull, @juergba)
- #3831: Fix
--timeout/--slowstring values and duplicate arguments (@boneskull, @juergba)
:book: Documentation
- #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)
:mag: Coverage
- #3915, #3929: Increase tests coverage for
--watchoptions (@geigerzaehler)
:nut_and_bolt: Other
- #3953: Collect test files later, prepares improvements to the
--watchmode behavior (@geigerzaehler) - #3939: Upgrade for npm audit (@boneskull)
- #3930: Extract
runWatchinto separate module (@geigerzaehler) - #3922: Add
mocha.min.jsfile to stacktrace filter (@brian-lagerman) - #3919: Update CI config files to use Node-12.x (@plroebuck)
- #3892: Rework reporter tests (@plroebuck)
- #3872: Rename
--excludeto--ignoreand 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)
6.1.4 / 2019-04-18
:lock: Security Fixes
- #3877: Upgrade js-yaml, addressing code injection vulnerability (@bjornstar)
6.1.3 / 2019-04-11
:bug: Fixes
- #3863: Fix
yargs-related global scope pollution (@inukshuk) - #3869: Fix failure when installed w/
pnpm(@boneskull)
6.1.2 / 2019-04-08
:bug: Fixes
- #3867: Re-publish v6.1.1 from POSIX OS to avoid dropped executable flags (@boneskull)
6.1.1 / 2019-04-07
:bug: Fixes
- #3866: Fix Windows End-of-Line publishing issue (@juergba & @cspotcode)
6.1.0 / 2019-04-07
:lock: Security Fixes
- #3845: Update dependency "js-yaml" to v3.13.0 per npm security advisory (@plroebuck)
:tada: Enhancements
- #3766: Make reporter constructor support optional
optionsparameter (@plroebuck) - #3760: Add support for config files with
.jsoncextension (@sstephant)
: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
- #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-uncaughtfor uncaught exceptions thrown inside hooks (@givanse)
and some regressions:
- #3848: Fix
Suitecloning by copyingrootproperty (@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)
:book: Documentation
- 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)
:nut_and_bolt: Other
- #3830: Replace dependency "findup-sync" with "find-up" for faster startup (@cspotcode)
- #3799: Update devDependencies to fix many npm vulnerabilities (@XhmikosR)
6.0.2 / 2019-02-25
:bug: Fixes
Two more regressions fixed:
- #3768: Test file paths no longer dropped from
mocha.opts(@boneskull) - #3767:
--requiredoes not break on module names that look like certainnodeflags (@boneskull)
6.0.1 / 2019-02-21
The obligatory round of post-major-release bugfixes.
:bug: Fixes
These issues were regressions.
- #3754 - Mocha again finds
test.jswhen 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-
undefinedvalue from adescribecallback is no longer considered deprecated (@boneskull)
:book: Documentation
- #3738 - Upgrade to
@mocha/docdash@2(@tendonstrength) - #3751 - Use preferred names for example config files (@Szauka)
6.0.0 / 2019-02-18
:boom: Breaking Changes
- #3149: Drop Node.js v4.x support (@outsideris)
- #3556: Changes to command-line options (@boneskull):
--grepand--fgrepare now mutually exclusive; attempting to use both will cause Mocha to fail instead of simply ignoring--grep--compilersis no longer supported; attempting to use will cause Mocha to fail with a link to more information-dis no longer an alias for--debug;-dis currently ignored- #3275:
--watch-extensionsno longer impliesjs; it must be explicitly added (@TheDancingCode)
- #2908:
tapreporter emits error messages (@chrmod) - #2819: When conditionally skipping in a
beforehook, subsequentbeforehooks and tests in nested suites are now skipped (@bannmoore) - #627: Emit filepath in "timeout exceeded" exceptions where applicable (@boneskull)
- #3556:
lib/template.htmlhas moved tolib/browser/template.html(@boneskull) - #2576: An exception is now thrown if Mocha fails to parse or find a
mocha.optsat a user-specified path (@plroebuck) - #3458: Instantiating a
Base-extending reporter without aRunnerparameter will throw an exception (@craigtaub) - #3125: For consumers of Mocha's programmatic API, all exceptions thrown from Mocha now have a
codeproperty (and some will have additional metadata). SomeErrormessages have changed. Please use thecodeproperty to checkErrortypes instead of themessageproperty; these descriptions will be localized in the future. (@craigtaub)
: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:
-gcusers should use--gc-globalinstead- Consumers of the function exported by
bin/optionsshould now use theloadMochaOptsorloadOptions(preferred) functions exported by thelib/cli/optionsmodule
Regarding the Mocha class constructor (from lib/mocha):
- Use property
color: falseinstead ofuseColors: false - Use property
timeout: falseinstead 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.
:tada: Enhancements
- #3726: Add ability to unload files from
requirecache (@plroebuck)
Enhancements introduced in #3556:
-
Mocha now supports "RC" files in JS, JSON, YAML, or
package.json-based (usingmochaproperty) format.mocharc.js,.mocharc.json,.mocharc.yamlor.mocharc.ymlare valid "rc" file names and will be automatically loaded- Use
--config /path/to/rc/fileto specify an explicit path - Use
--package /path/to/package.jsonto specify an explicitpackage.jsonto read themochaprop from - Use
--no-configor--no-packageto 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.jsonmocha.opts- Mocha's own defaults
- Check out these example config files
-
Node/V8 flag support in
mochaexecutable:- Support all allowed
nodeflags 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.jsonproperties, ormocha.opts - Debug-related flags (e.g.,
--inspect) now imply--no-timeouts - Use of e.g.,
--debugwill automatically invoke--inspectif 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
--interfacesflag -
Mochaconstructor supports all options -
--extensionis now an alias for--watch-extensionsand 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:
tapreporter is now TAP13-capable (@plroebuck & @mollstam) -
#3535: Mocha's version can now be queried programmatically via public property
Mocha.prototype.version(@plroebuck) -
#2529:
Runnernow emits aretryevent when tests are retried (reporters can listen for this) (@catdad) -
#2962, #3111: In-browser notification support; warn about missing prereqs when
--growlsupplied (@plroebuck)
:bug: Fixes
- #3737: Fix falsy values from options globals (@plroebuck)
- #3707: Fix encapsulation issues for
Suite#_onlyTestsandSuite#_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
lookupFilesandfiles(@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-optionsdid not support comma-separated key/value pairs (@boneskull) - Fix missing
mocharc.jsonin published package (@boneskull) - #3356:
--no-timeoutsand--timeout 0now does what you'd expect (@boneskull) - #3475: Restore
--no-exitoption (@boneskull) - #3570: Long-running tests now respect
SIGINT(@boneskull) - #2944:
--forbid-onlyand--forbid-pendingnow "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
--bailwould 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)
:book: Documentation
- #3525: Improvements to
.github/CONTRIBUTING.md(@markowsiak) - #3466: Update description of
slowoption (@finfin) - #3405: Remove references to bower installations (@goteamtim)
- #3361: Improvements to
--watchdocs (@benglass) - #3136: Improve docs around globbing and shell expansion (@akrawchyk)
- #2819: Update docs around skips and hooks (@bannmoore)
- Many improvements by @outsideris
- #3652: Switch from Jekyll to Eleventy (@Munter)
:nut_and_bolt: Other
- #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)
- #3557: Use
msuserland module instead of hand-rolled solution (@gizemkeser) - Many CI fixes and other refactors by @plroebuck
- Test refactors by @outsideris
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!
:boom: Breaking Changes
- #3149: Drop Node.js v4.x support (@outsideris)
- #3556: Changes to command-line options (@boneskull):
--grepand--fgrepare now mutually exclusive; attempting to use both will cause Mocha to fail instead of simply ignoring--grep--compilersis no longer supported; attempting to use will cause Mocha to fail with a link to more information-dis no longer an alias for--debug;-dis currently ignored- #3275:
--watch-extensionsno longer impliesjs; it must be explicitly added (@TheDancingCode)
- #2908:
tapreporter emits error messages (@chrmod) - #2819: When conditionally skipping in a
beforehook, subsequentbeforehooks and tests in nested suites are now skipped (@bannmoore) - #627: Emit filepath in "timeout exceeded" exceptions where applicable (@boneskull)
- #3556:
lib/template.htmlhas moved tolib/browser/template.html(@boneskull) - #2576: An exception is now thrown if Mocha fails to parse or find a
mocha.optsat a user-specified path (@plroebuck) - #3458: Instantiating a
Base-extending reporter without aRunnerparameter will throw an exception (@craigtaub) - #3125: For consumers of Mocha's programmatic API, all exceptions thrown from Mocha now have a
codeproperty (and some will have additional metadata). SomeErrormessages have changed. Please use thecodeproperty to checkErrortypes instead of themessageproperty; these descriptions will be localized in the future. (@craigtaub)
: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:
-gcusers should use--gc-globalinstead- Consumers of the function exported by
bin/optionsshould now use theloadMochaOptsorloadOptions(preferred) functions exported by thelib/cli/optionsmodule
Regarding the Mocha class constructor (from lib/mocha):
- Use property
color: falseinstead ofuseColors: false - Use property
timeout: falseinstead 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.
:tada: Enhancements
Enhancements introduced in #3556:
-
Mocha now supports "RC" files in JS, JSON, YAML, or
package.json-based (usingmochaproperty) format.mocharc.js,.mocharc.json,.mocharc.yamlor.mocharc.ymlare valid "rc" file names and will be automatically loaded- Use
--config /path/to/rc/fileto specify an explicit path - Use
--package /path/to/package.jsonto specify an explicitpackage.jsonto read themochaprop from - Use
--no-configor--no-packageto 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.jsonmocha.opts- Mocha's own defaults
- Check out these example config files
-
Node/V8 flag support in
mochaexecutable:- Support all allowed
nodeflags 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.jsonproperties, ormocha.opts - Debug-related flags (e.g.,
--inspect) now imply--no-timeouts - Use of e.g.,
--debugwill automatically invoke--inspectif 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
--interfacesflag -
Mochaconstructor supports all options -
--extensionis now an alias for--watch-extensionsand 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:
tapreporter is now TAP13-capable (@plroebuck & @mollstam) -
#3535: Mocha's version can now be queried programmatically via public property
Mocha.prototype.version(@plroebuck) -
#2529:
Runnernow emits aretryevent when tests are retried (reporters can listen for this) (@catdad) -
#2962, #3111: In-browser notification support; warn about missing prereqs when
--growlsupplied (@plroebuck)
:bug: Fixes
- #3356:
--no-timeoutsand--timeout 0now does what you'd expect (@boneskull) - #3475: Restore
--no-exitoption (@boneskull) - #3570: Long-running tests now respect
SIGINT(@boneskull) - #2944:
--forbid-onlyand--forbid-pendingnow "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
--bailwould 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)
:book: Documentation
- #3525: Improvements to
.github/CONTRIBUTING.md(@markowsiak) - #3466: Update description of
slowoption (@finfin) - #3405: Remove references to bower installations (@goteamtim)
- #3361: Improvements to
--watchdocs (@benglass) - #3136: Improve docs around globbing and shell expansion (@akrawchyk)
- #2819: Update docs around skips and hooks (@bannmoore)
- Many improvements by @outsideris
:nut_and_bolt: Other
- #3557: Use
msuserland module instead of hand-rolled solution (@gizemkeser) - Many CI fixes and other refactors by @plroebuck
- Test refactors by @outsideris
5.2.0 / 2018-05-18
:tada: Enhancements
- #3375: Add support for comments in
mocha.opts(@plroebuck)
:bug: Fixes
- #3346: Exit correctly from
beforehooks when using--bail(@outsideris)
:book: Documentation
:nut_and_bolt: Other
- #3330: Use
Buffer.from()(@harrysarson) - #3295: Remove redundant folder (@DavNej)
- #3356: Refactoring (@plroebuck)
5.1.0 / 2018-04-12
:tada: Enhancements
:bug: Fixes
- #3318: Fix failures in circular objects in JSON reporter (@jeversmann, @boneskull)
:book: Documentation
- #3323: Publish actual API documentation! (@dfberry, @Munter)
- #3299: Improve docs around exclusive tests (@nicgirault)
:nut_and_bolt: Other
- #3302, #3308, #3310, #3315, #3316: Build matrix improvements (more info) (@outsideris, @boneskull)
- #3272: Refactor reporter tests (@jMuzsik)
5.0.5 / 2018-03-22
Welcome @outsideris to the team!
:bug: Fixes
- #3096: Fix
--bailfailing to bail within hooks (@outsideris) - #3184: Don't skip too many suites (using
describe.skip()) (@outsideris)
:book: Documentation
- #3133: Improve docs regarding "pending" behavior (@ematicipo)
- #3276, #3274: Fix broken stuff in
CHANGELOG.md(@tagoro9, @honzajavorek)
:nut_and_bolt: Other
- #3208: Improve test coverage for AMD users (@outsideris)
- #3267: Remove vestiges of PhantomJS from CI (@anishkny)
- #2952: Fix a debug message (@boneskull)
5.0.4 / 2018-03-07
:bug: Fixes
- #3265: Fixes regression in "watch" functionality introduced in v5.0.2 (@outsideris)
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).
:lock: Security Fixes
:nut_and_bolt: Other
- #3011: Expose
generateDiff()inBasereporter (@harrysarson)
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!
:bug: 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
Runnerinstance will emit theendevent twice; you may need to change your reporter to userunner.once('end')intead ofrunner.on('end'). -
#3093: Fix stack trace reformatting problem (@outsideris)
:nut_and_bolt: Other
- #3248: Update
browser-stdoutto v1.3.1 (@honzajavorek)
5.0.1 / 2018-02-07
...your garden-variety patch release.
Special thanks to Wallaby.js for their continued support! :heart:
:bug: Fixes
- #1838:
--delaynow works with.only()(@silviom) - #3119: Plug memory leak present in v8 (@boneskull)
:book: Documentation
- #3132, #3098: Update
--globdocs (@outsideris) - #3212: Update Wallaby.js-related docs (@ArtemGovorov)
- #3205: Remove outdated cruft (@boneskull)
:nut_and_bolt: Other
- #3224: Add proper Wallaby.js config (@ArtemGovorov)
- #3230: Update copyright year (@josephlin55555)
5.0.0 / 2018-01-17
Mocha starts off 2018 right by again dropping support for unmaintained rubbish.
Welcome @vkarpov15 to the team!
:boom: 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.
:tada: Enhancements
- #3181: Add useful new
--filecommand line argument (documentation) (@hswolff)
:bug: Fixes
- #3187: Fix inaccurate test duration reporting (@FND)
- #3202: Fix bad markup in HTML reporter (@DanielRuf)
:sunglasses: Developer Experience
:book: Documentation
- #3137: Add missing
--no-timeoutsdocs (@dfberry) - #3134: Improve
done()callback docs (@maraisr) - #3135: Fix cross-references (@vkarpov15)
- #3163: Fix tpyos (@tbroadley)
- #3177: Tweak
README.mdorganization (@xxczaki) - Misc updates (@boneskull)
:nut_and_bolt: 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)
4.1.0 / 2017-12-28
This is mainly a "housekeeping" release.
Welcome @Bamieh and @xxczaki to the team!
:bug:: Fixes
- #2661:
progressreporter now accepts reporter options (@canoztokmak) - #3142:
xitinbddinterface now properly returns itsTestobject (@Bamieh) - #3075: Diffs now computed eagerly to avoid misinformation when reported (@abrady0)
- #2745:
--helpwill now help you even if you have amocha.opts(@Zarel)
:tada: Enhancements
- #2514: The
--no-diffflag 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 into the main repo under
docs/(@boneskull) - #2896: Add maintainer guide (@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)
4.0.1 / 2017-10-05
:bug: Fixes
- #3051: Upgrade Growl to v1.10.3 to fix its peer dep problems (@dpogue)
4.0.0 / 2017-10-02
You might want to read this before filing a new bug! :stuck_out_tongue_closed_eyes:
:boom: Breaking Changes
For more info, please read this article.
Compatibility
- #3016: Drop support for unmaintained versions of Node.js (@boneskull):
- 0.10.x
- 0.11.x
- 0.12.x
- iojs (any)
- 5.x.x
- #2979: Drop support for non-ES5-compliant browsers (@boneskull):
- IE7
- IE8
- PhantomJS 1.x
- #2615: Drop Bower support; old versions (3.x, etc.) will remain available (@ScottFreeCode, @boneskull)
Default Behavior
- #2879: By default, Mocha will no longer force the process to exit once all tests complete. This means any test code (or code under test) which would normally prevent
nodefrom exiting will do so when run in Mocha. Supply the--exitflag to revert to pre-v4.0.0 behavior (@ScottFreeCode, @boneskull)
Reporter Output
- #2095: Remove
stdout:prefix from browser reporter logs (@skeggse) - #2295: Add separator in "unified diff" output (@olsonpm)
- #2686: Print failure message when
--forbid-pendingor--forbid-onlyis specified (@ScottFreeCode) - #2814: Indent contexts for better readability when reporting failures (@charlierudolph)
:-1: Deprecations
- #2493: The
--compilerscommand-line option is now soft-deprecated and will emit a warning onSTDERR. Read this for more info and workarounds (@ScottFreeCode, @boneskull)
:tada: Enhancements
:book: Documentation
:nut_and_bolt: Other
- #2890: Speed up build by (re-)consolidating SauceLabs tests (@boneskull)
3.5.2 / 2017-09-10
:bug: Fixes
- #3001: Fix AMD-related failures first appearing in v3.5.1 (@boneskull)
3.5.1 / 2017-09-09
:newspaper: News
- :mega: Mocha is now sponsoring PDXNode! If you're in the Portland area, come check out the monthly talks and hack nights!
:bug: Fixes
- #2997: Fix missing
xitexport for "require" interface (@solodynamo) - #2957: Fix unicode character handling in XUnit reporter failures (@jkrems)
:nut_and_bolt: Other
- #2986: Add issue and PR templates (@kungapal)
- #2918: Drop bash dependency for glob-related tests (@ScottFreeCode)
- #2922: Improve
--compilerscoverage (@ScottFreeCode) - #2981: Fix tpyos and spelling errors (@jsoref)
v3.5.0 / 2017-07-31
:newspaper: News
- Mocha now has a code of conduct (thanks @kungapal!).
- Old issues and PRs are now being marked "stale" by Probot's "Stale" plugin. If an issue is marked as such, and you would like to see it remain open, simply add a new comment to the ticket or PR.
- WARNING: Support for non-ES5-compliant environments will be dropped starting with version 4.0.0 of Mocha!
:lock: Security Fixes
- #2860: Address CVE-2015-8315 via upgrade of debug (@boneskull)
:tada: Enhancements
- #2696: Add
--forbid-onlyand--forbid-pendingflags. Use these in CI or hooks to ensure tests aren't accidentally being skipped! (@charlierudolph) - #2813: Support Node.js 8's
--napi-modulesflag (@jupp0r)
:nut_and_bolt: Other
- Various CI-and-test-related fixes and improvements (@boneskull, @dasilvacontin, @PopradiArpad, @Munter, @ScottFreeCode)
- "Officially" support Node.js 8 (@elergy)
3.4.2 / 2017-05-24
:bug: Fixes
- #2802: Remove call to deprecated os.tmpDir (@makepanic)
- #2820: Eagerly set process.exitCode (@chrisleck)
:nut_and_bolt: Other
Fixed a publishing mishap with git's autocrlf settings.
Thanks to all our contributors, maintainers, sponsors, and users! ❤️
As highlights:
- We've got coverage now!
- Testing is looking less flaky \o/.
- No more nitpicking about "mocha.js" build on PRs.
:tada: Enhancements
- #2659: Adds support for loading reporter from an absolute or relative path (@sul4bh)
- #2769: Support
--inspect-brkon command-line (@igwejk)
:bug: Fixes
:mag: Coverage
- #2672: Add coverage for node tests (@c089, @Munter)
- #2680: Increase tests coverage for base reporter (@epallerols)
- #2690: Increase tests coverage for doc reporter (@craigtaub)
- #2701: Increase tests coverage for landing, min, tap and list reporters (@craigtaub)
- #2691: Increase tests coverage for spec + dot reporters (@craigtaub)
- #2698: Increase tests coverage for xunit reporter (@craigtaub)
- #2699: Increase tests coverage for json-stream, markdown and progress reporters (@craigtaub)
- #2703: Cover .some() function in utils.js with tests (@seppevs)
- #2773: Add tests for loading reporters w/ relative/absolute paths (@sul4bh)
:nut_and_bolt: Other
- Remove bin/.eslintrc; ensure execs are linted (@boneskull)
- #2542: Expand CONTRIBUTING.md (@boneskull)
- #2660: Double timeouts on integration tests (@Munter)
- #2653: Update copyright year ([@Scottkao85], @Munter)
- #2621: Update dependencies to enable Greenkeeper (@boneskull, @greenkeeper)
- #2625: Use trusty container in travis-ci; use "artifacts" addon (@boneskull)
- #2670: doc(CONTRIBUTING): fix link to org members (@coderbyheart)
- Add Mocha propaganda to README.md (@boneskull)
- #2470: Avoid test flake in "delay" test (@boneskull)
- #2675: Limit browser concurrency on sauce (@boneskull)
- #2669: Use temporary test-only build of mocha.js for browsers tests (@Munter)
- Fix "projects" link in README.md (@boneskull)
- #2678: Chore(Saucelabs): test on IE9, IE10 and IE11 (@coderbyheart)
- #2648: Use
semistandarddirectly (@kt3k) - #2727: Make the build reproducible (@lamby)
3.2.0 / 2016-11-24
:newspaper: News
Mocha is now a JS Foundation Project!
Mocha is proud to have joined the JS Foundation. For more information, read the announcement.
Contributor License Agreement
Under the foundation, all contributors to Mocha must sign the JS Foundation CLA before their code can be merged. When sending a PR--if you have not already signed the CLA--a friendly bot will ask you to do so.
Mocha remains licensed under the MIT license.
:bug: Bug Fix
- #2535: Fix crash when
--watchencounters broken symlinks (@villesau) - #2593: Fix (old) regression; incorrect symbol shown in
listreporter (@Aldaviva) - #2584: Fix potential error when running XUnit reporter (@vobujs)
:tada: Enhancement
- #2294: Improve timeout error messaging (@jeversmann, @boneskull)
- #2520: Add info about
--inspectflag to CLI help (@ughitsaaron)
:nut_and_bolt: Other
- #2570: Use karma-mocha proper (@boneskull)
- Licenses updated to reflect new copyright, add link to license and browser matrix to
README.md(@boneskull, @ScottFreeCode, @dasilvacontin)
Thanks to all our contributors, sponsors and backers! Keep on the lookout for a public roadmap and new contribution guide coming soon.
3.1.2 / 2016-10-10
:bug: Bug Fix
- #2528: Recovery gracefully if an
Error'sstackproperty isn't writable ([@boneskull])
3.1.1 / 2016-10-09
:bug: Bug Fix
- #1417: Don't report
done()was called multiple times when it wasn't (@frankleonrose)
:nut_and_bolt: Other
- #2490: Lint with semistandard config (@makepanic)
- #2525: Lint all
.jsfiles ([@boneskull]) - #2524: Provide workaround for developers unable to run browser tests on macOS Sierra ([@boneskull])
3.1.0 / 2016-09-27
:tada: Enhancement
- #2357: Support
--inspecton command-line (@simov) - #2194: Human-friendly error if no files are matched on command-line (@Munter)
- #1744: Human-friendly error if a Suite has no callback (BDD/TDD only) (@anton)
:bug: Bug Fix
- #2488: Fix case in which variables beginning with lowercase "D" may not have been reported properly as global leaks (@JustATrick) :laughing:
- #2465: Always halt execution in async function when
this.skip()is called (@boneskull) - #2445: Exits with expected code 130 when
SIGINTencountered; exit code can no longer rollover at 256 (@Munter) - #2315: Fix uncaught TypeError thrown from callback stack (@1999)
- Fix broken
only()/skip()in IE7/IE8 (@boneskull) - #2502: Fix broken stack trace filter on Node.js under Windows (@boneskull)
- #2496: Fix diff output for objects instantiated with
Stringconstructor (more) (@boneskull)
See #2350 and CHANGELOG.md in the v3.0.0 branch.
See #2350 for more information.
See #2350 for more information.