mocha 11.7.5 → 12.0.0-alpha-issue-5899.2

package/README.md

@@ -1,15 +1,15 @@
 <p align="center">
-  <img src="assets/mocha-logo.svg" alt="Mocha test framework logo"/>
+  <img src="docs/src/components/mocha-logo.svg" alt="Mocha test framework logo"/>
 </p>
 
-<p align="center">☕️ Simple, flexible, fun JavaScript test framework for Node.js & The Browser ☕️</p>
+<p align="center">☕️ Classic, reliable, trusted test framework for Node.js and the browser ☕️</p>
 
 <div align="center">
 
 <a href="https://www.npmjs.com/package/mocha"><img src="https://img.shields.io/npm/v/mocha.svg" alt="NPM Version"></a>
 <a href="https://github.com/mochajs/mocha"><img src="https://img.shields.io/node/v/mocha.svg" alt="Node Version"></a>
 [![GitHub Actions Build Status](https://github.com/mochajs/mocha/actions/workflows/mocha.yml/badge.svg)](https://github.com/mochajs/mocha/actions/workflows/mocha.yml)
-<a href="https://coveralls.io/github/mochajs/mocha"><img src="https://coveralls.io/repos/github/mochajs/mocha/badge.svg" alt="Coverage Status"></a>
+<a href="https://codecov.io/gh/mochajs/mocha"><img src="https://codecov.io/gh/mochajs/mocha/branch/main/graph/badge.svg" alt="Codecov Coverage Status"></a>
 
 </div>
 
@@ -36,7 +36,7 @@
 
 [Become a backer](https://opencollective.com/mochajs) and show your support to our open source project on [our site](https://mochajs.org/#backers).
 
-<a href="https://opencollective.com/mochajs"><img src="https://opencollective.com/mochajs/tiers/backers.svg?limit=30&button=false&avatarHeight=46&width=750"></a>
+<a href="https://opencollective.com/mochajs"><img alt="Mocha's backers on Open Collective" src="https://opencollective.com/mochajs/tiers/backers.svg?limit=30&button=false&avatarHeight=46&width=750"></a>
 
 ## Sponsors
 

package/bin/_mocha

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-'use strict';
+"use strict";
 
 /**
  * This file remains for backwards compatibility only.
@@ -7,4 +7,4 @@
  * @see module:lib/cli
  */
 
-require('../lib/cli').main();
+require("../lib/cli").main();

package/bin/mocha.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 
-'use strict';
+"use strict";
 
 /**
  * This wrapper executable checks for known node flags and appends them when found,
@@ -10,16 +10,16 @@
  * @private
  */
 
-const os = require('node:os');
-const {loadOptions} = require('../lib/cli/options');
+const os = require("node:os");
+const { loadOptions } = require("../lib/cli/options.mjs");
 const {
   unparseNodeFlags,
   isNodeFlag,
-  impliesNoTimeouts
-} = require('../lib/cli/node-flags');
-const unparse = require('yargs-unparser');
-const debug = require('debug')('mocha:cli:mocha');
-const {aliases} = require('../lib/cli/run-option-metadata');
+  impliesNoTimeouts,
+} = require("../lib/cli/node-flags.mjs");
+const unparse = require("yargs-unparser");
+const debug = require("debug")("mocha:cli:mocha");
+const { aliases } = require("../lib/cli/run-option-metadata.mjs");
 
 const mochaArgs = {};
 const nodeArgs = {};
@@ -27,16 +27,16 @@ const SIGNAL_OFFSET = 128;
 let hasInspect = false;
 
 const opts = loadOptions(process.argv.slice(2));
-debug('loaded opts', opts);
+debug("loaded opts", opts);
 
 /**
  * Given option/command `value`, disable timeouts if applicable
  * @param {string} [value] - Value to check
  * @ignore
  */
-const disableTimeouts = value => {
+const disableTimeouts = (value) => {
   if (impliesNoTimeouts(value)) {
-    debug('option %s disabled timeouts', value);
+    debug("option %s disabled timeouts", value);
     mochaArgs.timeout = 0;
   }
 };
@@ -47,11 +47,11 @@ const disableTimeouts = value => {
  * @returns {string} `value` with prefix (maybe) removed
  * @ignore
  */
-const trimV8Option = value =>
-  value !== 'v8-options' && /^v8-/.test(value) ? value.slice(3) : value;
+const trimV8Option = (value) =>
+  value !== "v8-options" && /^v8-/.test(value) ? value.slice(3) : value;
 
 // sort options into "node" and "mocha" buckets
-Object.keys(opts).forEach(opt => {
+Object.keys(opts).forEach((opt) => {
   if (isNodeFlag(opt)) {
     nodeArgs[trimV8Option(opt)] = opts[opt];
   } else {
@@ -60,9 +60,9 @@ Object.keys(opts).forEach(opt => {
 });
 
 // disable 'timeout' for debugFlags
-Object.keys(nodeArgs).forEach(opt => disableTimeouts(opt));
-mochaArgs['node-option'] &&
-  mochaArgs['node-option'].forEach(opt => disableTimeouts(opt));
+Object.keys(nodeArgs).forEach((opt) => disableTimeouts(opt));
+mochaArgs["node-option"] &&
+  mochaArgs["node-option"].forEach((opt) => disableTimeouts(opt));
 
 // Native debugger handling
 // see https://nodejs.org/api/debugger.html#debugger_debugger
@@ -71,78 +71,80 @@ mochaArgs['node-option'] &&
 // A deprecation warning will be printed by node, if applicable.
 // (mochaArgs._ are "positional" arguments, not prefixed with - or --)
 if (mochaArgs._) {
-  const i = mochaArgs._.findIndex(val => val === 'inspect');
+  const i = mochaArgs._.findIndex((val) => val === "inspect");
   if (i > -1) {
     mochaArgs._.splice(i, 1);
-    disableTimeouts('inspect');
+    disableTimeouts("inspect");
     hasInspect = true;
   }
 }
 
-if (mochaArgs['node-option'] || Object.keys(nodeArgs).length || hasInspect) {
-  const {spawn} = require('node:child_process');
-  const mochaPath = require.resolve('../lib/cli/cli.js');
+if (mochaArgs["node-option"] || Object.keys(nodeArgs).length || hasInspect) {
+  const { spawn } = require("node:child_process");
+  const mochaPath = require.resolve("../lib/cli/cli.js");
 
   const nodeArgv =
-    (mochaArgs['node-option'] && mochaArgs['node-option'].map(v => '--' + v)) ||
+    (mochaArgs["node-option"] &&
+      mochaArgs["node-option"].map((v) => "--" + v)) ||
     unparseNodeFlags(nodeArgs);
 
-  if (hasInspect) nodeArgv.unshift('inspect');
-  delete mochaArgs['node-option'];
+  if (hasInspect) nodeArgv.unshift("inspect");
+  delete mochaArgs["node-option"];
 
-  debug('final node argv', nodeArgv);
+  debug("final node argv", nodeArgv);
 
   const args = [].concat(
     nodeArgv,
     mochaPath,
-    unparse(mochaArgs, {alias: aliases})
+    unparse(mochaArgs, { alias: aliases }),
   );
 
   debug(
-    'forking child process via command: %s %s',
+    "forking child process via command: %s %s",
     process.execPath,
-    args.join(' ')
+    args.join(" "),
   );
 
   const proc = spawn(process.execPath, args, {
-    stdio: 'inherit'
+    stdio: "inherit",
   });
 
-  proc.on('exit', (code, signal) => {
-    process.on('exit', () => {
+  proc.on("exit", (code, signal) => {
+    process.on("exit", () => {
       if (signal) {
-        signal = typeof signal === 'string' ? os.constants.signals[signal] : signal;
-        if (mochaArgs['posix-exit-codes'] === true) {
+        signal =
+          typeof signal === "string" ? os.constants.signals[signal] : signal;
+        if (mochaArgs["posix-exit-codes"] === true) {
           process.exitCode = SIGNAL_OFFSET + signal;
         }
         process.kill(process.pid, signal);
       } else {
-        process.exit(Math.min(code, mochaArgs['posix-exit-codes'] ? 1 : 255));
+        process.exit(Math.min(code, mochaArgs["posix-exit-codes"] ? 1 : 255));
       }
     });
   });
 
   // terminate children.
-  process.on('SIGINT', () => {
+  process.on("SIGINT", () => {
     // XXX: a previous comment said this would abort the runner, but I can't see that it does
     // anything with the default runner.
-    debug('main process caught SIGINT');
-    proc.kill('SIGINT');
+    debug("main process caught SIGINT");
+    proc.kill("SIGINT");
     // if running in parallel mode, we will have a proper SIGINT handler, so the below won't
     // be needed.
     if (!args.parallel || args.jobs < 2) {
       // win32 does not support SIGTERM, so use next best thing.
-      if (os.platform() === 'win32') {
-        proc.kill('SIGKILL');
+      if (os.platform() === "win32") {
+        proc.kill("SIGKILL");
       } else {
         // using SIGKILL won't cleanly close the output streams, which can result
         // in cut-off text or a befouled terminal.
-        debug('sending SIGTERM to child process');
-        proc.kill('SIGTERM');
+        debug("sending SIGTERM to child process");
+        proc.kill("SIGTERM");
       }
     }
   });
 } else {
-  debug('running Mocha in-process');
-  require('../lib/cli/cli').main([], mochaArgs);
+  debug("running Mocha in-process");
+  require("../lib/cli/cli").main([], mochaArgs);
 }

package/browser-entry.js

@@ -1,17 +1,16 @@
-'use strict';
+"use strict";
 
 /* eslint no-unused-vars: off */
-/* eslint-env commonjs */
 
 /**
  * Shim process.stdout.
  */
 
-process.stdout = require('browser-stdout')({label: false});
+process.stdout = require("browser-stdout")({ label: false });
 
-var parseQuery = require('./lib/browser/parse-query');
-var highlightTags = require('./lib/browser/highlight-tags');
-var Mocha = require('./lib/mocha');
+var parseQuery = require("./lib/browser/parse-query.mjs").parseQuery;
+var highlightTags = require("./lib/browser/highlight-tags.mjs").highlightTags;
+var Mocha = require("./lib/mocha");
 
 /**
  * Create a Mocha instance.
@@ -19,7 +18,7 @@ var Mocha = require('./lib/mocha');
  * @return {undefined}
  */
 
-var mocha = new Mocha({reporter: 'html'});
+var mocha = new Mocha({ reporter: "html" });
 
 /**
  * Save timer references to avoid Sinon interfering (see GH-237).
@@ -41,7 +40,7 @@ var originalOnerrorHandler = global.onerror;
  */
 
 process.removeListener = function (e, fn) {
-  if (e === 'uncaughtException') {
+  if (e === "uncaughtException") {
     if (originalOnerrorHandler) {
       global.onerror = originalOnerrorHandler;
     } else {
@@ -59,7 +58,7 @@ process.removeListener = function (e, fn) {
  */
 
 process.listenerCount = function (name) {
-  if (name === 'uncaughtException') {
+  if (name === "uncaughtException") {
     return uncaughtExceptionHandlers.length;
   }
   return 0;
@@ -70,9 +69,9 @@ process.listenerCount = function (name) {
  */
 
 process.on = function (e, fn) {
-  if (e === 'uncaughtException') {
+  if (e === "uncaughtException") {
     global.onerror = function (msg, url, line, col, err) {
-      fn(err || new Error(msg + ' (' + url + ':' + line + ':' + col + ')'));
+      fn(err || new Error(msg + " (" + url + ":" + line + ":" + col + ")"));
       return !mocha.options.allowUncaught;
     };
     uncaughtExceptionHandlers.push(fn);
@@ -80,7 +79,7 @@ process.on = function (e, fn) {
 };
 
 process.listeners = function (err) {
-  if (err === 'uncaughtException') {
+  if (err === "uncaughtException") {
     return uncaughtExceptionHandlers;
   }
   return [];
@@ -89,7 +88,7 @@ process.listeners = function (err) {
 // The BDD UI is registered by default, but no UI will be functional in the
 // browser without an explicit call to the overridden `mocha.ui` (see below).
 // Ensure that this default UI does not expose its methods to the global scope.
-mocha.suite.removeAllListeners('pre-require');
+mocha.suite.removeAllListeners("pre-require");
 
 var immediateQueue = [];
 var immediateTimeout;
@@ -136,7 +135,7 @@ mocha.throwError = function (err) {
 
 mocha.ui = function (ui) {
   Mocha.prototype.ui.call(this, ui);
-  this.suite.emit('pre-require', global, null, this);
+  this.suite.emit("pre-require", global, null, this);
   return this;
 };
 
@@ -145,8 +144,8 @@ mocha.ui = function (ui) {
  */
 
 mocha.setup = function (opts) {
-  if (typeof opts === 'string') {
-    opts = {ui: opts};
+  if (typeof opts === "string") {
+    opts = { ui: opts };
   }
   if (opts.delay === true) {
     this.delay();
@@ -154,7 +153,7 @@ mocha.setup = function (opts) {
   var self = this;
   Object.keys(opts)
     .filter(function (opt) {
-      return opt !== 'delay';
+      return opt !== "delay";
     })
     .forEach(function (opt) {
       if (Object.prototype.hasOwnProperty.call(opts, opt)) {
@@ -170,9 +169,9 @@ mocha.setup = function (opts) {
 
 mocha.run = function (fn) {
   var options = mocha.options;
-  mocha.globals('location');
+  mocha.globals("location");
 
-  var query = parseQuery(global.location.search || '');
+  var query = parseQuery(global.location.search || "");
   if (query.grep) {
     mocha.grep(query.grep);
   }
@@ -188,10 +187,10 @@ mocha.run = function (fn) {
     var document = global.document;
     if (
       document &&
-      document.getElementById('mocha') &&
+      document.getElementById("mocha") &&
       options.noHighlighting !== true
     ) {
-      highlightTags('code');
+      highlightTags("code");
     }
     if (fn) {
       fn(err);

package/index.js

@@ -1,3 +1,3 @@
-'use strict';
+"use strict";
 
-module.exports = require('./lib/mocha');
+module.exports = require("./lib/mocha");

package/lib/browser/{highlight-tags.js → highlight-tags.mjs}

@@ -1,5 +1,3 @@
-'use strict';
-
 /**
  * Highlight the given string of `js`.
  *
@@ -9,19 +7,19 @@
  */
 function highlight(js) {
   return js
-    .replace(/</g, '&lt;')
-    .replace(/>/g, '&gt;')
+    .replace(/</g, "&lt;")
+    .replace(/>/g, "&gt;")
     .replace(/\/\/(.*)/gm, '<span class="comment">//$1</span>')
     .replace(/('.*?')/gm, '<span class="string">$1</span>')
     .replace(/(\d+\.\d+)/gm, '<span class="number">$1</span>')
     .replace(/(\d+)/gm, '<span class="number">$1</span>')
     .replace(
       /\bnew[ \t]+(\w+)/gm,
-      '<span class="keyword">new</span> <span class="init">$1</span>'
+      '<span class="keyword">new</span> <span class="init">$1</span>',
     )
     .replace(
       /\b(function|new|throw|return|var|if|else)\b/gm,
-      '<span class="keyword">$1</span>'
+      '<span class="keyword">$1</span>',
     );
 }
 
@@ -31,9 +29,9 @@ function highlight(js) {
  * @private
  * @param {string} name
  */
-module.exports = function highlightTags(name) {
-  var code = document.getElementById('mocha').getElementsByTagName(name);
+export function highlightTags(name) {
+  var code = document.getElementById("mocha").getElementsByTagName(name);
   for (var i = 0, len = code.length; i < len; ++i) {
     code[i].innerHTML = highlight(code[i].innerHTML);
   }
-};
+}

package/lib/browser/{parse-query.js → parse-query.mjs}

@@ -1,5 +1,3 @@
-'use strict';
-
 /**
  * Parse the given `qs`.
  *
@@ -7,18 +5,18 @@
  * @param {string} qs
  * @return {Object<string, string>}
  */
-module.exports = function parseQuery(qs) {
+export function parseQuery(qs) {
   return qs
-    .replace('?', '')
-    .split('&')
+    .replace("?", "")
+    .split("&")
     .reduce(function (obj, pair) {
-      var i = pair.indexOf('=');
+      var i = pair.indexOf("=");
       var key = pair.slice(0, i);
-      var val = pair.slice(++i);
+      var val = pair.slice(i + 1);
 
       // Due to how the URLSearchParams API treats spaces
-      obj[key] = decodeURIComponent(val.replace(/\+/g, '%20'));
+      obj[key] = decodeURIComponent(val.replace(/\+/g, "%20"));
 
       return obj;
     }, {});
-};
+}

package/lib/browser/template.html

@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
   <head>
     <meta charset="utf-8" />
@@ -10,7 +10,7 @@
     <div id="mocha"></div>
     <script src="mocha.js"></script>
     <script>
-      mocha.setup('bdd');
+      mocha.setup("bdd");
     </script>
     <script src="tests.spec.js"></script>
     <script>

package/lib/cli/cli.js

@@ -1,4 +1,4 @@
-'use strict';
+"use strict";
 
 /**
  * Contains CLI entry point and public API for programmatic usage in Node.js.
@@ -8,21 +8,25 @@
  * @module lib/cli
  */
 
-const debug = require('debug')('mocha:cli:cli');
-const symbols = require('log-symbols');
-const yargs = require('yargs');
-const path = require('node:path');
+const debug = require("debug")("mocha:cli:cli");
+const yargs = require("yargs");
+const path = require("node:path");
 const {
   loadRc,
   loadPkgRc,
   loadOptions,
-  YARGS_PARSER_CONFIG
-} = require('./options');
-const lookupFiles = require('./lookup-files');
-const commands = require('./commands');
-const pc = require('picocolors');
-const {repository, homepage, version, discord} = require('../../package.json');
-const {cwd} = require('../utils');
+  YARGS_PARSER_CONFIG,
+} = require("./options.mjs");
+const { lookupFiles } = require("./lookup-files.mjs");
+const commands = require("./commands.mjs");
+const pc = require("picocolors");
+const {
+  repository,
+  homepage,
+  version,
+  discord,
+} = require("../../package.json");
+const { cwd, logSymbols } = require("../utils");
 
 /**
  * - Accepts an `Array` of arguments
@@ -34,46 +38,55 @@ const {cwd} = require('../utils');
  * @param {object} [mochaArgs] - Object of already parsed Mocha arguments (by bin/mocha)
  */
 exports.main = (argv = process.argv.slice(2), mochaArgs) => {
-  debug('entered main with raw args', argv);
+  debug("entered main with raw args", argv);
   // ensure we can require() from current working directory
-  if (typeof module.paths !== 'undefined') {
-    module.paths.push(cwd(), path.resolve('node_modules'));
+  if (typeof module.paths !== "undefined") {
+    debug("module.paths before modification", module.paths);
+    module.paths.push(cwd(), path.resolve("node_modules"));
+    debug("module.paths after modification", module.paths);
+  } else {
+    debug("module.paths is undefined");
   }
 
   try {
     Error.stackTraceLimit = Infinity; // configurable via --stack-trace-limit?
   } catch (err) {
-    debug('unable to set Error.stackTraceLimit = Infinity', err);
+    debug("unable to set Error.stackTraceLimit = Infinity", err);
   }
 
   var args = mochaArgs || loadOptions(argv);
 
   yargs()
-    .scriptName('mocha')
+    .scriptName("mocha")
     .command(commands.run)
     .command(commands.init)
     .updateStrings({
-      'Positionals:': 'Positional Arguments',
-      'Options:': 'Other Options',
-      'Commands:': 'Commands'
+      "Positionals:": "Positional Arguments",
+      "Options:": "Other Options",
+      "Commands:": "Commands",
     })
     .fail((msg, err, yargs) => {
-      debug('caught error sometime before command handler: %O', err);
+      debug("caught error sometime before command handler: %O", err);
       yargs.showHelp();
-      console.error(`\n${symbols.error} ${pc.red('ERROR:')} ${msg}`);
+      console.error(`\n${logSymbols.error} ${pc.red("ERROR:")} ${msg}`);
+      if (!msg) {
+        // Log raw error and stack when an unexpected error is encountered, to
+        // make debugging easier (instead of an inactionable "ERROR: null").
+        console.error(err);
+      }
       process.exit(1);
     })
-    .help('help', 'Show usage information & exit')
-    .alias('help', 'h')
-    .version('version', 'Show version number & exit', version)
-    .alias('version', 'V')
+    .help("help", "Show usage information & exit")
+    .alias("help", "h")
+    .version("version", "Show version number & exit", version)
+    .alias("version", "V")
     .wrap(process.stdout.columns ? Math.min(process.stdout.columns, 80) : 80)
     .epilog(
       `${pc.reset("Mocha Resources")}
     Chat: ${pc.magenta(discord)}
   GitHub: ${pc.blue(repository.url)}
     Docs: ${pc.yellow(homepage)}
-      `
+      `,
     )
     .parserConfiguration(YARGS_PARSER_CONFIG)
     .config(args)