Skip to content

Latest commit

 

History

History
1178 lines (727 loc) · 78.5 KB

CHANGELOG.md

File metadata and controls

1178 lines (727 loc) · 78.5 KB
Raw

Changelog

10.4.0 / 2024-03-26

🎉 Enhancements

  • #4829 feat: include .cause stacks in the error stack traces (@voxpelli)
  • #4985 feat: add file path to xunit reporter (@bmish)

🐛 Fixes

  • #5074 fix: harden error handling in lib/cli/run.js (@stalet)

🔩 Other

10.3.0 / 2024-02-08

This is a stable release equivalent to 10.30.0-prerelease.

10.3.0-prerelease / 2024-01-18

This is a prerelease version to test our ability to release. Other than removing or updating dependencies, it contains no intended user-facing changes.

🔩 Other

10.2.0 / 2022-12-11

🎉 Enhancements

  • #4945: API: add possibility to decorate ESM name before import (@j0tunn)

🐛 Fixes

📖 Documentation

10.1.0 / 2022-10-16

🎉 Enhancements

  • #4896: Browser: add support for prefers-color-scheme: dark (@greggman)

🔩 Other

10.0.0 / 2022-05-01

💥 Breaking Changes

🔩 Other

Also thanks to @ea2305 and @SukkaW for improvements to our documentation.

9.2.2 / 2022-03-11

🐛 Fixes

🔩 Other

9.2.1 / 2022-02-19

🐛 Fixes

  • #4832: Loading of config files throws wrong error (@juergba)

  • #4799: Reporter: configurable maxDiffSize reporter-option (@norla)

9.2.0 / 2022-01-24

🎉 Enhancements

  • #4813: Parallel: assign each worker a worker-id (@forty)

🔩 Other

9.1.4 / 2022-01-14

🐛 Fixes

🔩 Other

9.1.3 / 2021-10-15

🐛 Fixes

🔩 Other

9.1.2 / 2021-09-25

🐛 Fixes

🔩 Other

9.1.1 / 2021-08-28

🐛 Fixes

9.1.0 / 2021-08-20

🎉 Enhancements

9.0.3 / 2021-07-25

🐛 Fixes

  • #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 of type:module (@giltayar)

9.0.2 / 2021-07-03

🐛 Fixes

  • #4668: ESM: make --require <dir> work with new import-first loading (@giltayar)

🔩 Other

9.0.1 / 2021-06-18

🔩 Other

  • #4657: Browser: add separate bundle for modern browsers (@juergba)

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.

9.0.0 / 2021-06-07

💥 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.

  • #4636: Remove deprecated utils.lookupFiles() (@juergba)

  • #4638: Limit the size of actual/expected for diff generation (@juergba)

  • #4389: Refactoring: Consuming log-symbols alternate to code for win32 in reporters/base (@MoonSupport)

🎉 Enhancements

🐛 Fixes

  • #4128: Fix: control stringification of error message (@syeutyu)

🔩 Other

8.4.0 / 2021-05-07

🎉 Enhancements

🐛 Fixes

📖 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.

8.3.2 / 2021-03-12

🐛 Fixes

📖 Documentation

8.3.1 / 2021-03-06

🐛 Fixes

  • #4577: Browser: fix EvalError caused by regenerator-runtime (@snoack)
  • #4574: ESM: allow import from mocha in parallel mode (@nicojs)

8.3.0 / 2021-02-11

🎉 Enhancements

🐛 Fixes

  • #4557: Add file location when SyntaxError happens in ESM (@giltayar)
  • #4521: Fix require error when bundling Mocha with Webpack (@devhazem)

📖 Documentation

🔩 Other

Also thanks to @outsideris and @HyunSangHan for various fixes to our website and documentation.

8.2.1 / 2020-11-02

Fixed stuff.

🐛 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!

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).

🎉 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())

🐛 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!

8.1.3 / 2020-08-28

🐛 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)

8.1.2 / 2020-08-25

🐛 Fixes

🔒 Security Fixes

📖 Documentation

8.1.1 / 2020-08-04

🐛 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.

🎉 Enhancements

  • #4287: Use background colors with inline diffs for better visual distinction (@michael-brade)

🐛 Fixes

🔒 Security Fixes

📖 Documentation & Website

🔩 Other

  • #4293: Use Rollup and Babel in build pipeline; add source map to published files (@Munter)

8.0.1 / 2020-06-10

The obligatory patch after a major.

🐛 Fixes

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!

💥 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)

    ✨ 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 with this.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()

🎉 Enhancements

📖 Documentation

  • #4246: Add documentation for parallel mode and Root Hook plugins (@boneskull)

🔩 Other

🐛 Fixes

(All bug fixes in Mocha v8.0.0 are also breaking changes, and are listed above)

7.2.0 / 2020-05-22

🎉 Enhancements

🐛 Fixes

📖 Documentation

🔩 Other

7.1.2 / 2020-04-26

🔩 Other

📖 Documentation

7.1.1 / 2020-03-18

🔒 Security Fixes

  • #4204: Update dependencies mkdirp, yargs-parser and yargs (@juergba)

🐛 Fixes

📖 Documentation

7.1.0 / 2020-02-26

🎉 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

🐛 Fixes

📖 Documentation

🔩 Other

7.0.1 / 2020-01-25

🐛 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)

📖 Documentation

🔩 Other

7.0.0 / 2020-01-05

💥 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)

🎉 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)

📠 Deprecations

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

  • #3968: Deprecate legacy configuration via mocha.opts (@juergba)

🐛 Fixes

🔍 Coverage

📖 Documentation

🔩 Other

6.2.3 / 2020-03-25

🔒 Security Fixes

6.2.2 / 2019-10-18

🐛 Fixes

📖 Documentation

6.2.1 / 2019-09-29

🐛 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)

📖 Documentation

6.2.0 / 2019-07-18

🎉 Enhancements

🐛 Fixes

📖 Documentation

🔍 Coverage

🔩 Other

6.1.4 / 2019-04-18

🔒 Security Fixes

6.1.3 / 2019-04-11

🐛 Fixes

6.1.2 / 2019-04-08

🐛 Fixes

  • #3867: Re-publish v6.1.1 from POSIX OS to avoid dropped executable flags (@boneskull)

6.1.1 / 2019-04-07

🐛 Fixes

6.1.0 / 2019-04-07

🔒 Security Fixes

  • #3845: Update dependency "js-yaml" to v3.13.0 per npm security advisory (@plroebuck)

🎉 Enhancements

  • #3766: Make reporter constructor support optional options parameter (@plroebuck)
  • #3760: Add support for config files with .jsonc extension (@sstephant)

📠 Deprecations

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

🐛 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-uncaught for uncaught exceptions thrown inside hooks (@givanse)

and some regressions:

📖 Documentation

🔩 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

🐛 Fixes

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 certain node flags (@boneskull)

6.0.1 / 2019-02-21

The obligatory round of post-major-release bugfixes.

🐛 Fixes

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 a describe callback is no longer considered deprecated (@boneskull)

📖 Documentation

6.0.0 / 2019-02-18

🎉 Enhancements

🐛 Fixes

  • #3737: Fix falsy values from options globals (@plroebuck)
  • #3707: Fix encapsulation issues for Suite#_onlyTests and Suite#_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 and files (@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)

📖 Documentation

🔩 Other

6.0.0-1 / 2019-01-02

🐛 Fixes

  • Fix missing mocharc.json in published package (@boneskull)

6.0.0-0 / 2019-01-01

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

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

💥 Breaking Changes

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

📠 Deprecations

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

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

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

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

All of the above deprecations were introduced by #3556.

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

🎉 Enhancements

Enhancements introduced in #3556:

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

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

  • Node/V8 flag support in mocha executable:

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

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

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

  • Mocha constructor supports all options

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

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

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

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

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

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

🐛 Fixes

📖 Documentation

🔩 Other

5.2.0 / 2018-05-18

🎉 Enhancements

🐛 Fixes

📖 Documentation

🔩 Other

5.1.1 / 2018-04-18

🐛 Fixes

5.1.0 / 2018-04-12

🎉 Enhancements

🐛 Fixes

📖 Documentation

🔩 Other

5.0.5 / 2018-03-22

Welcome @outsideris to the team!

🐛 Fixes

📖 Documentation

🔩 Other

5.0.4 / 2018-03-07

🐛 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).

🔒 Security Fixes

🔩 Other

5.0.2 / 2018-03-05

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

🐛 Fixes

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

    ```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 the end event twice; you may need to change your reporter to use runner.once('end') intead of runner.on('end').

  • #3093: Fix stack trace reformatting problem (@outsideris)

🔩 Other

5.0.1 / 2018-02-07

...your garden-variety patch release.

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

🐛 Fixes

📖 Documentation

🔩 Other

5.0.0 / 2018-01-17

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

Welcome @vkarpov15 to the team!

💥 Breaking Changes

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

🎉 Enhancements

🐛 Fixes

😎 Developer Experience

📖 Documentation

🔩 Other