mocha 9.2.2 → 10.2.0

package/lib/browser/progress.js

@@ -86,6 +86,20 @@ Progress.prototype.update = function (n) {
  */
 Progress.prototype.draw = function (ctx) {
   try {
+    var darkMatcher = window.matchMedia('(prefers-color-scheme: dark)');
+    var isDarkMode = !!darkMatcher.matches;
+    var lightColors = {
+      outerCircle: '#9f9f9f',
+      innerCircle: '#eee',
+      text: '#000'
+    };
+    var darkColors = {
+      outerCircle: '#888',
+      innerCircle: '#444',
+      text: '#fff'
+    };
+    var colors = isDarkMode ? darkColors : lightColors;
+
     var percent = Math.min(this.percent, 100);
     var size = this._size;
     var half = size / 2;
@@ -100,13 +114,13 @@ Progress.prototype.draw = function (ctx) {
     ctx.clearRect(0, 0, size, size);
 
     // outer circle
-    ctx.strokeStyle = '#9f9f9f';
+    ctx.strokeStyle = colors.outerCircle;
     ctx.beginPath();
     ctx.arc(x, y, rad, 0, angle, false);
     ctx.stroke();
 
     // inner circle
-    ctx.strokeStyle = '#eee';
+    ctx.strokeStyle = colors.innerCircle;
     ctx.beginPath();
     ctx.arc(x, y, rad - 1, 0, angle, true);
     ctx.stroke();
@@ -115,6 +129,7 @@ Progress.prototype.draw = function (ctx) {
     var text = this._text || (percent | 0) + '%';
     var w = ctx.measureText(text).width;
 
+    ctx.fillStyle = colors.text;
     ctx.fillText(text, x - w / 2 + 1, y + fontSize / 2 - 1);
   } catch (ignore) {
     // don't fail if we can't render progress

package/lib/cli/commands.js

@@ -2,7 +2,7 @@
 
 /**
  * Exports Yargs commands
- * @see https://git.io/fpJ0G
+ * @see https://github.com/yargs/yargs/blob/main/docs/advanced.md
  * @private
  * @module
  */

package/lib/cli/run-option-metadata.js

@@ -39,7 +39,6 @@ const TYPES = (exports.types = {
     'forbid-only',
     'forbid-pending',
     'full-trace',
-    'growl',
     'inline-diffs',
     'invert',
     'list-interfaces',
@@ -76,7 +75,6 @@ exports.aliases = {
   fgrep: ['f'],
   global: ['globals'],
   grep: ['g'],
-  growl: ['G'],
   ignore: ['exclude'],
   invert: ['i'],
   jobs: ['j'],

package/lib/cli/run.js

@@ -141,10 +141,6 @@ exports.builder = yargs =>
         group: GROUPS.FILTERS,
         requiresArg: true
       },
-      growl: {
-        description: 'Enable Growl notifications',
-        group: GROUPS.OUTPUT
-      },
       ignore: {
         defaultDescription: '(none)',
         description: 'Ignore file(s) or glob pattern(s)',
@@ -333,7 +329,7 @@ exports.builder = yargs =>
       if (argv.compilers) {
         throw createUnsupportedError(
           `--compilers is DEPRECATED and no longer supported.
-          See https://git.io/vdcSr for migration information.`
+          See https://github.com/mochajs/mocha/wiki/compilers-deprecation for migration information.`
         );
       }
 

package/lib/interfaces/bdd.js

@@ -40,9 +40,9 @@ module.exports = function bddInterface(suite) {
 
     context.describe = context.context = function (title, fn) {
       return common.suite.create({
-        title: title,
-        file: file,
-        fn: fn
+        title,
+        file,
+        fn
       });
     };
 
@@ -55,9 +55,9 @@ module.exports = function bddInterface(suite) {
       context.describe.skip =
         function (title, fn) {
           return common.suite.skip({
-            title: title,
-            file: file,
-            fn: fn
+            title,
+            file,
+            fn
           });
         };
 
@@ -67,9 +67,9 @@ module.exports = function bddInterface(suite) {
 
     context.describe.only = function (title, fn) {
       return common.suite.only({
-        title: title,
-        file: file,
-        fn: fn
+        title,
+        file,
+        fn
       });
     };
 

package/lib/interfaces/qunit.js

@@ -49,8 +49,8 @@ module.exports = function qUnitInterface(suite) {
         suites.shift();
       }
       return common.suite.create({
-        title: title,
-        file: file,
+        title,
+        file,
         fn: false
       });
     };
@@ -64,8 +64,8 @@ module.exports = function qUnitInterface(suite) {
         suites.shift();
       }
       return common.suite.only({
-        title: title,
-        file: file,
+        title,
+        file,
         fn: false
       });
     };

package/lib/interfaces/tdd.js

@@ -47,9 +47,9 @@ module.exports = function (suite) {
      */
     context.suite = function (title, fn) {
       return common.suite.create({
-        title: title,
-        file: file,
-        fn: fn
+        title,
+        file,
+        fn
       });
     };
 
@@ -58,9 +58,9 @@ module.exports = function (suite) {
      */
     context.suite.skip = function (title, fn) {
       return common.suite.skip({
-        title: title,
-        file: file,
-        fn: fn
+        title,
+        file,
+        fn
       });
     };
 
@@ -69,9 +69,9 @@ module.exports = function (suite) {
      */
     context.suite.only = function (title, fn) {
       return common.suite.only({
-        title: title,
-        file: file,
-        fn: fn
+        title,
+        file,
+        fn
       });
     };
 

package/lib/mocha.js

@@ -9,7 +9,6 @@
 var escapeRe = require('escape-string-regexp');
 var path = require('path');
 var builtinReporters = require('./reporters');
-var growl = require('./nodejs/growl');
 var utils = require('./utils');
 var mocharc = require('./mocharc.json');
 var Suite = require('./suite');
@@ -165,7 +164,6 @@ exports.run = function (...args) {
  * @param {boolean} [options.fullTrace] - Full stacktrace upon failure?
  * @param {string[]} [options.global] - Variables expected in global scope.
  * @param {RegExp|string} [options.grep] - Test filter given regular expression.
- * @param {boolean} [options.growl] - Enable desktop notifications?
  * @param {boolean} [options.inlineDiffs] - Display inline diffs?
  * @param {boolean} [options.invert] - Invert test filter matches?
  * @param {boolean} [options.noHighlighting] - Disable syntax highlighting?
@@ -195,7 +193,7 @@ function Mocha(options = {}) {
     .ui(options.ui)
     .reporter(
       options.reporter,
-      options.reporterOption || options.reporterOptions // for backwards compability
+      options.reporterOption || options.reporterOptions // for backwards compatibility
     )
     .slow(options.slow)
     .global(options.global);
@@ -222,7 +220,6 @@ function Mocha(options = {}) {
     'forbidOnly',
     'forbidPending',
     'fullTrace',
-    'growl',
     'inlineDiffs',
     'invert'
   ].forEach(function (opt) {
@@ -432,6 +429,8 @@ Mocha.prototype.loadFiles = function (fn) {
  * @see {@link Mocha#addFile}
  * @see {@link Mocha#run}
  * @see {@link Mocha#unloadFiles}
+ * @param {Object} [options] - Settings object.
+ * @param {Function} [options.esmDecorator] - Function invoked on esm module name right before importing it. By default will passthrough as is.
  * @returns {Promise}
  * @example
  *
@@ -440,7 +439,7 @@ Mocha.prototype.loadFiles = function (fn) {
  *   .then(() => mocha.run(failures => process.exitCode = failures ? 1 : 0))
  *   .catch(() => process.exitCode = 1);
  */
-Mocha.prototype.loadFilesAsync = function () {
+Mocha.prototype.loadFilesAsync = function ({esmDecorator} = {}) {
   var self = this;
   var suite = this.suite;
   this.lazyLoadFiles(true);
@@ -453,7 +452,8 @@ Mocha.prototype.loadFilesAsync = function () {
     function (file, resultModule) {
       suite.emit(EVENT_FILE_REQUIRE, resultModule, file, self);
       suite.emit(EVENT_FILE_POST_REQUIRE, global, file, self);
-    }
+    },
+    esmDecorator
   );
 };
 
@@ -468,7 +468,7 @@ Mocha.prototype.loadFilesAsync = function () {
 Mocha.unloadFile = function (file) {
   if (utils.isBrowser()) {
     throw createUnsupportedError(
-      'unloadFile() is only suported in a Node.js environment'
+      'unloadFile() is only supported in a Node.js environment'
     );
   }
   return require('./nodejs/file-unloader').unloadFile(file);
@@ -647,49 +647,6 @@ Mocha.prototype.fullTrace = function (fullTrace) {
   return this;
 };
 
-/**
- * Enables desktop notification support if prerequisite software installed.
- *
- * @public
- * @see [CLI option](../#-growl-g)
- * @return {Mocha} this
- * @chainable
- */
-Mocha.prototype.growl = function () {
-  this.options.growl = this.isGrowlCapable();
-  if (!this.options.growl) {
-    var detail = utils.isBrowser()
-      ? 'notification support not available in this browser...'
-      : 'notification support prerequisites not installed...';
-    console.error(detail + ' cannot enable!');
-  }
-  return this;
-};
-
-/**
- * @summary
- * Determines if Growl support seems likely.
- *
- * @description
- * <strong>Not available when run in browser.</strong>
- *
- * @private
- * @see {@link Growl#isCapable}
- * @see {@link Mocha#growl}
- * @return {boolean} whether Growl support can be expected
- */
-Mocha.prototype.isGrowlCapable = growl.isCapable;
-
-/**
- * Implements desktop notifications using a pseudo-reporter.
- *
- * @private
- * @see {@link Mocha#growl}
- * @see {@link Growl#notify}
- * @param {Runner} runner - Runner instance.
- */
-Mocha.prototype._growl = growl.notify;
-
 /**
  * Specifies whitelist of variable names to be expected in global scope.
  *
@@ -713,7 +670,7 @@ Mocha.prototype.global = function (global) {
     });
   return this;
 };
-// for backwards compability, 'globals' is an alias of 'global'
+// for backwards compatibility, 'globals' is an alias of 'global'
 Mocha.prototype.globals = Mocha.prototype.global;
 
 /**
@@ -1037,9 +994,6 @@ Mocha.prototype.run = function (fn) {
   if (options.global) {
     runner.globals(options.global);
   }
-  if (options.growl) {
-    this._growl(runner);
-  }
   if (options.color !== undefined) {
     exports.reporters.Base.useColors = options.color;
   }

package/lib/nodejs/esm-utils.js

@@ -1,16 +1,18 @@
 const path = require('path');
 const url = require('url');
 
-const formattedImport = async file => {
+const forward = x => x;
+
+const formattedImport = async (file, esmDecorator = forward) => {
   if (path.isAbsolute(file)) {
     try {
-      return await import(url.pathToFileURL(file));
+      return await exports.doImport(esmDecorator(url.pathToFileURL(file)));
     } catch (err) {
       // This is a hack created because ESM in Node.js (at least in Node v15.5.1) does not emit
       // the location of the syntax error in the error thrown.
       // This is problematic because the user can't see what file has the problem,
       // so we add the file location to the error.
-      // This `if` should be removed once Node.js fixes the problem.
+      // TODO: remove once Node.js fixes the problem.
       if (
         err instanceof SyntaxError &&
         err.message &&
@@ -27,67 +29,57 @@ const formattedImport = async file => {
       throw err;
     }
   }
-  return import(file);
+  return exports.doImport(esmDecorator(file));
 };
 
-const hasStableEsmImplementation = (() => {
-  const [major, minor] = process.version.split('.');
-  // ESM is stable from v12.22.0 onward
-  // https://nodejs.org/api/esm.html#esm_modules_ecmascript_modules
-  const majorNumber = parseInt(major.slice(1), 10);
-  const minorNumber = parseInt(minor, 10);
-  return majorNumber > 12 || (majorNumber === 12 && minorNumber >= 22);
-})();
+exports.doImport = async file => import(file);
 
-exports.requireOrImport = hasStableEsmImplementation
-  ? async file => {
-      if (path.extname(file) === '.mjs') {
-        return formattedImport(file);
-      }
+exports.requireOrImport = async (file, esmDecorator) => {
+  if (path.extname(file) === '.mjs') {
+    return formattedImport(file, esmDecorator);
+  }
+  try {
+    return dealWithExports(await formattedImport(file, esmDecorator));
+  } catch (err) {
+    if (
+      err.code === 'ERR_MODULE_NOT_FOUND' ||
+      err.code === 'ERR_UNKNOWN_FILE_EXTENSION' ||
+      err.code === 'ERR_UNSUPPORTED_DIR_IMPORT'
+    ) {
       try {
-        return dealWithExports(await formattedImport(file));
-      } catch (err) {
+        // Importing a file usually works, but the resolution of `import` is the ESM
+        // resolution algorithm, and not the CJS resolution algorithm. We may have
+        // failed because we tried the ESM resolution, so we try to `require` it.
+        return require(file);
+      } catch (requireErr) {
         if (
-          err.code === 'ERR_MODULE_NOT_FOUND' ||
-          err.code === 'ERR_UNKNOWN_FILE_EXTENSION' ||
-          err.code === 'ERR_UNSUPPORTED_DIR_IMPORT'
+          requireErr.code === 'ERR_REQUIRE_ESM' ||
+          (requireErr instanceof SyntaxError &&
+            requireErr
+              .toString()
+              .includes('Cannot use import statement outside a module'))
         ) {
-          try {
-            // Importing a file usually works, but the resolution of `import` is the ESM
-            // resolution algorithm, and not the CJS resolution algorithm. So in this case
-            // if we fail, we may have failed because we tried the ESM resolution and failed
-            // So we try to `require` it
-            return require(file);
-          } catch (requireErr) {
-            if (
-              requireErr.code === 'ERR_REQUIRE_ESM' ||
-              (requireErr instanceof SyntaxError &&
-                requireErr
-                  .toString()
-                  .includes('Cannot use import statement outside a module'))
-            ) {
-              // ERR_REQUIRE_ESM happens when the test file is a JS file, but via type:module is actually ESM,
-              // AND has an import to a file that doesn't exist.
-              // This throws an `ERR_MODULE_NOT_FOUND` error above,
-              // and when we try to `require` it here, it throws an `ERR_REQUIRE_ESM`.
-              // What we want to do is throw the original error (the `ERR_MODULE_NOT_FOUND`),
-              // and not the `ERR_REQUIRE_ESM` error, which is a red herring.
-              //
-              // SyntaxError happens when in an edge case: when we're using an ESM loader that loads
-              // a `test.ts` file (i.e. unrecognized extension), and that file includes an unknown
-              // import (which thows an ERR_MODULE_NOT_FOUND). require-ing it will throw the
-              // syntax error, because we cannot require a file that has import-s.
-              throw err;
-            } else {
-              throw requireErr;
-            }
-          }
-        } else {
+          // ERR_REQUIRE_ESM happens when the test file is a JS file, but via type:module is actually ESM,
+          // AND has an import to a file that doesn't exist.
+          // This throws an `ERR_MODULE_NOT_FOUND` error above,
+          // and when we try to `require` it here, it throws an `ERR_REQUIRE_ESM`.
+          // What we want to do is throw the original error (the `ERR_MODULE_NOT_FOUND`),
+          // and not the `ERR_REQUIRE_ESM` error, which is a red herring.
+          //
+          // SyntaxError happens when in an edge case: when we're using an ESM loader that loads
+          // a `test.ts` file (i.e. unrecognized extension), and that file includes an unknown
+          // import (which throws an ERR_MODULE_NOT_FOUND). `require`-ing it will throw the
+          // syntax error, because we cannot require a file that has `import`-s.
           throw err;
+        } else {
+          throw requireErr;
         }
       }
+    } else {
+      throw err;
     }
-  : implementationOfRequireOrImportForUnstableEsm;
+  }
+};
 
 function dealWithExports(module) {
   if (module.default) {
@@ -97,28 +89,18 @@ function dealWithExports(module) {
   }
 }
 
-exports.loadFilesAsync = async (files, preLoadFunc, postLoadFunc) => {
+exports.loadFilesAsync = async (
+  files,
+  preLoadFunc,
+  postLoadFunc,
+  esmDecorator
+) => {
   for (const file of files) {
     preLoadFunc(file);
-    const result = await exports.requireOrImport(path.resolve(file));
+    const result = await exports.requireOrImport(
+      path.resolve(file),
+      esmDecorator
+    );
     postLoadFunc(file, result);
   }
 };
-
-/* istanbul ignore next */
-async function implementationOfRequireOrImportForUnstableEsm(file) {
-  if (path.extname(file) === '.mjs') {
-    return formattedImport(file);
-  }
-  // This is currently the only known way of figuring out whether a file is CJS or ESM in
-  // Node.js that doesn't necessitate calling `import` first.
-  try {
-    return require(file);
-  } catch (err) {
-    if (err.code === 'ERR_REQUIRE_ESM') {
-      return formattedImport(file);
-    } else {
-      throw err;
-    }
-  }
-}

package/lib/nodejs/parallel-buffered-runner.js

@@ -6,7 +6,6 @@
 
 'use strict';
 
-const allSettled = require('@ungap/promise-all-settled').bind(Promise);
 const Runner = require('../runner');
 const {EVENT_RUN_BEGIN, EVENT_RUN_END} = Runner.constants;
 const debug = require('debug')('mocha:parallel:parallel-buffered-runner');
@@ -271,8 +270,9 @@ class ParallelBufferedRunner extends Runner {
    *
    * @param {Function} callback - Called with an exit code corresponding to
    * number of test failures.
-   * @param {{files: string[], options: Options}} opts - Files to run and
-   * command-line options, respectively.
+   * @param {Object} [opts] - options
+   * @param {string[]} opts.files - Files to run
+   * @param {Options} opts.options - command-line options
    */
   run(callback, {files, options = {}} = {}) {
     /**
@@ -321,7 +321,7 @@ class ParallelBufferedRunner extends Runner {
           delete options[opt];
         });
 
-        const results = await allSettled(
+        const results = await Promise.allSettled(
           files.map(this._createFileRunner(pool, options))
         );
 

package/lib/reporters/html.js

@@ -181,7 +181,7 @@ function HTML(runner, options) {
       if (indexOfMessage === -1) {
         stackString = test.err.stack;
       } else {
-        stackString = test.err.stack.substr(
+        stackString = test.err.stack.slice(
           test.err.message.length + indexOfMessage
         );
       }

package/lib/reporters/json-stream.js

@@ -36,7 +36,7 @@ function JSONStream(runner, options) {
   var total = runner.total;
 
   runner.once(EVENT_RUN_BEGIN, function () {
-    writeEvent(['start', {total: total}]);
+    writeEvent(['start', {total}]);
   });
 
   runner.on(EVENT_TEST_PASS, function (test) {

package/lib/reporters/markdown.js

@@ -50,7 +50,7 @@ function Markdown(runner, options) {
     var ret = obj;
     var key = SUITE_PREFIX + suite.title;
 
-    obj = obj[key] = obj[key] || {suite: suite};
+    obj = obj[key] = obj[key] || {suite};
     suite.suites.forEach(function (suite) {
       mapTOC(suite, obj);
     });

package/lib/runner.js

@@ -135,27 +135,15 @@ class Runner extends EventEmitter {
    * @public
    * @class
    * @param {Suite} suite - Root suite
-   * @param {Object|boolean} [opts] - Options. If `boolean` (deprecated), whether to delay execution of root suite until ready.
+   * @param {Object} [opts] - Settings object
    * @param {boolean} [opts.cleanReferencesAfterRun] - Whether to clean references to test fns and hooks when a suite is done.
    * @param {boolean} [opts.delay] - Whether to delay execution of root suite until ready.
    * @param {boolean} [opts.dryRun] - Whether to report tests without running them.
    * @param {boolean} [opts.failZero] - Whether to fail test run if zero tests encountered.
    */
-  constructor(suite, opts) {
+  constructor(suite, opts = {}) {
     super();
-    if (opts === undefined) {
-      opts = {};
-    }
-    if (typeof opts === 'boolean') {
-      // TODO: remove this
-      require('./errors').deprecate(
-        '"Runner(suite: Suite, delay: boolean)" is deprecated. Use "Runner(suite: Suite, {delay: boolean})" instead.'
-      );
-      this._delay = opts;
-      opts = {};
-    } else {
-      this._delay = opts.delay;
-    }
+
     var self = this;
     this._globals = [];
     this._abort = false;
@@ -1031,7 +1019,9 @@ Runner.prototype._uncaught = function (err) {
  * @public
  * @memberof Runner
  * @param {Function} fn - Callback when finished
- * @param {{files: string[], options: Options}} [opts] - For subclasses
+ * @param {Object} [opts] - For subclasses
+ * @param {string[]} opts.files - Files to run
+ * @param {Options} opts.options - command-line options
  * @returns {Runner} Runner instance.
  */
 Runner.prototype.run = function (fn, opts = {}) {
@@ -1064,7 +1054,7 @@ Runner.prototype.run = function (fn, opts = {}) {
       debug('run(): filtered exclusive Runnables');
     }
     this.state = constants.STATE_RUNNING;
-    if (this._delay) {
+    if (this._opts.delay) {
       this.emit(constants.EVENT_DELAY_END);
       debug('run(): "delay" ended');
     }
@@ -1091,7 +1081,7 @@ Runner.prototype.run = function (fn, opts = {}) {
   this._addEventListener(process, 'uncaughtException', this.uncaught);
   this._addEventListener(process, 'unhandledRejection', this.unhandled);
 
-  if (this._delay) {
+  if (this._opts.delay) {
     // for reporters, I guess.
     // might be nice to debounce some dots while we wait.
     this.emit(constants.EVENT_DELAY_BEGIN, rootSuite);

package/lib/utils.js

@@ -76,7 +76,7 @@ exports.clean = function (str) {
     .replace(/^\uFEFF/, '')
     // (traditional)->  space/name     parameters    body     (lambda)-> parameters       body   multi-statement/single          keep body content
     .replace(
-      /^function(?:\s*|\s+[^(]*)\([^)]*\)\s*\{((?:.|\n)*?)\s*\}$|^\([^)]*\)\s*=>\s*(?:\{((?:.|\n)*?)\s*\}|((?:.|\n)*))$/,
+      /^function(?:\s*|\s[^(]*)\([^)]*\)\s*\{((?:.|\n)*?)\}$|^\([^)]*\)\s*=>\s*(?:\{((?:.|\n)*?)\}|((?:.|\n)*))$/,
       '$1$2$3'
     );