mocha 11.7.4 → 11.7.6

package/lib/cli/run-helpers.js

@@ -1,4 +1,4 @@
-'use strict';
+"use strict";
 
 /**
  * Helper scripts for the `run` command
@@ -14,16 +14,16 @@
  * @typedef {import('../runner.js')} Runner
  */
 
-const fs = require('node:fs');
-const path = require('node:path');
-const pc = require('picocolors');
-const debug = require('debug')('mocha:cli:run:helpers');
-const {watchRun, watchParallelRun} = require('./watch-run');
-const collectFiles = require('./collect-files');
-const {format} = require('node:util');
-const {createInvalidLegacyPluginError} = require('../errors');
-const {requireOrImport} = require('../nodejs/esm-utils');
-const PluginLoader = require('../plugin-loader');
+const fs = require("node:fs");
+const path = require("node:path");
+const pc = require("picocolors");
+const debug = require("debug")("mocha:cli:run:helpers");
+const { watchRun, watchParallelRun } = require("./watch-run");
+const collectFiles = require("./collect-files");
+const { format } = require("node:util");
+const { createInvalidLegacyPluginError } = require("../errors");
+const { requireOrImport } = require("../nodejs/esm-utils");
+const PluginLoader = require("../plugin-loader");
 
 /**
  * Exits Mocha when tests + code under test has finished execution (default)
@@ -31,9 +31,12 @@ const PluginLoader = require('../plugin-loader');
  * @ignore
  * @private
  */
-const exitMochaLater = clampedCode => {
-  process.on('exit', () => {
-    process.exitCode = Math.min(clampedCode, process.argv.includes('--posix-exit-codes') ? 1 : 255);
+const exitMochaLater = (clampedCode) => {
+  process.on("exit", () => {
+    process.exitCode = Math.min(
+      clampedCode,
+      process.argv.includes("--posix-exit-codes") ? 1 : 255,
+    );
   });
 };
 
@@ -44,8 +47,8 @@ const exitMochaLater = clampedCode => {
  * @ignore
  * @private
  */
-const exitMocha = clampedCode => {
-  const usePosixExitCodes = process.argv.includes('--posix-exit-codes');
+const exitMocha = (clampedCode) => {
+  const usePosixExitCodes = process.argv.includes("--posix-exit-codes");
   clampedCode = Math.min(clampedCode, usePosixExitCodes ? 1 : 255);
   let draining = 0;
 
@@ -64,10 +67,10 @@ const exitMocha = clampedCode => {
 
   const streams = [process.stdout, process.stderr];
 
-  streams.forEach(stream => {
+  streams.forEach((stream) => {
     // submit empty write request and wait for completion
     draining += 1;
-    stream.write('', done);
+    stream.write("", done);
   });
 
   done();
@@ -80,8 +83,8 @@ const exitMocha = clampedCode => {
  * @returns {string[]} Array of strings
  * @private
  */
-exports.list = str =>
-  Array.isArray(str) ? exports.list(str.join(',')) : str.split(/ *, */);
+exports.list = (str) =>
+  Array.isArray(str) ? exports.list(str.join(",")) : str.split(/ *, */);
 
 /**
  * `require()` the modules as required by `--require <require>`.
@@ -91,26 +94,29 @@ exports.list = str =>
  * @returns {Promise<object>} Plugin implementations
  * @private
  */
-exports.handleRequires = async (requires = [], {ignoredPlugins = []} = {}) => {
-  const pluginLoader = PluginLoader.create({ignore: ignoredPlugins});
+exports.handleRequires = async (
+  requires = [],
+  { ignoredPlugins = [] } = {},
+) => {
+  const pluginLoader = PluginLoader.create({ ignore: ignoredPlugins });
   for await (const mod of requires) {
     let modpath = mod;
     // this is relative to cwd
     if (fs.existsSync(mod) || fs.existsSync(`${mod}.js`)) {
       modpath = path.resolve(mod);
-      debug('resolved required file %s to %s', mod, modpath);
+      debug("resolved required file %s to %s", mod, modpath);
     }
     const requiredModule = await requireOrImport(modpath);
-    if (requiredModule && typeof requiredModule === 'object') {
+    if (requiredModule && typeof requiredModule === "object") {
       if (pluginLoader.load(requiredModule)) {
-        debug('found one or more plugin implementations in %s', modpath);
+        debug("found one or more plugin implementations in %s", modpath);
       }
     }
     debug('loaded required module "%s"', mod);
   }
   const plugins = await pluginLoader.finalize();
   if (Object.keys(plugins).length) {
-    debug('finalized plugin implementations: %O', plugins);
+    debug("finalized plugin implementations: %O", plugins);
   }
   return plugins;
 };
@@ -127,15 +133,15 @@ const handleUnmatchedFiles = (mocha, unmatchedFiles) => {
     return;
   }
 
-  unmatchedFiles.forEach(({pattern, absolutePath}) => {
+  unmatchedFiles.forEach(({ pattern, absolutePath }) => {
     console.error(
       pc.yellow(
-        `Warning: Cannot find any files matching pattern "${pattern}" at the absolute path "${absolutePath}"`
-      )
+        `Warning: Cannot find any files matching pattern "${pattern}" at the absolute path "${absolutePath}"`,
+      ),
     );
   });
   console.log(
-    'No test file(s) found with the given pattern, exiting with code 1'
+    "No test file(s) found with the given pattern, exiting with code 1",
   );
 
   return mocha.run(exitMocha(1));
@@ -152,8 +158,8 @@ const handleUnmatchedFiles = (mocha, unmatchedFiles) => {
  */
 const singleRun = async (
   mocha,
-  {exit, passOnFailingTestSuite},
-  fileCollectParams
+  { exit, passOnFailingTestSuite },
+  fileCollectParams,
 ) => {
   const fileCollectionObj = collectFiles(fileCollectParams);
 
@@ -161,14 +167,12 @@ const singleRun = async (
     return handleUnmatchedFiles(mocha, fileCollectionObj.unmatchedFiles);
   }
 
-  debug('single run with %d file(s)', fileCollectionObj.files.length);
+  debug("single run with %d file(s)", fileCollectionObj.files.length);
   mocha.files = fileCollectionObj.files;
 
   // handles ESM modules
   await mocha.loadFilesAsync();
-  return mocha.run(
-    createExitHandler({exit, passOnFailingTestSuite})
-  );
+  return mocha.run(createExitHandler({ exit, passOnFailingTestSuite }));
 };
 
 /**
@@ -192,15 +196,13 @@ const parallelRun = async (mocha, options, fileCollectParams) => {
   }
 
   debug(
-    'executing %d test file(s) in parallel mode',
-    fileCollectionObj.files.length
+    "executing %d test file(s) in parallel mode",
+    fileCollectionObj.files.length,
   );
   mocha.files = fileCollectionObj.files;
 
   // note that we DO NOT load any files here; this is handled by the worker
-  return mocha.run(
-    createExitHandler(options)
-  );
+  return mocha.run(createExitHandler(options));
 };
 
 /**
@@ -223,7 +225,7 @@ exports.runMocha = async (mocha, options) => {
     parallel = false,
     recursive = false,
     sort = false,
-    spec = []
+    spec = [],
   } = options;
 
   const fileCollectParams = {
@@ -232,7 +234,7 @@ exports.runMocha = async (mocha, options) => {
     file,
     recursive,
     sort,
-    spec
+    spec,
   };
 
   let run;
@@ -267,15 +269,15 @@ exports.validateLegacyPlugin = (opts, pluginType, map = {}) => {
   if (Array.isArray(pluginId)) {
     throw createInvalidLegacyPluginError(
       `"--${pluginType}" can only be specified once`,
-      pluginType
+      pluginType,
     );
   }
 
-  const createUnknownError = err =>
+  const createUnknownError = (err) =>
     createInvalidLegacyPluginError(
       format('Could not load %s "%s":\n\n %O', pluginType, pluginId, err),
       pluginType,
-      pluginId
+      pluginId,
     );
 
   // if this exists, then it's already loaded, so nothing more to do.
@@ -298,13 +300,9 @@ exports.validateLegacyPlugin = (opts, pluginType, map = {}) => {
 };
 
 const createExitHandler = ({ exit, passOnFailingTestSuite }) => {
-  return code => {
-    const clampedCode = passOnFailingTestSuite
-      ? 0
-      : Math.min(code, 255);
-
-    return exit
-      ? exitMocha(clampedCode)
-      : exitMochaLater(clampedCode);
+  return (code) => {
+    const clampedCode = passOnFailingTestSuite ? 0 : Math.min(code, 255);
+
+    return exit ? exitMocha(clampedCode) : exitMochaLater(clampedCode);
   };
 };

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

@@ -1,4 +1,4 @@
-'use strict';
+"use strict";
 
 /**
  * Metadata about various options of the `run` command
@@ -14,54 +14,54 @@
  */
 const TYPES = (exports.types = {
   array: [
-    'extension',
-    'file',
-    'global',
-    'ignore',
-    'node-option',
-    'reporter-option',
-    'require',
-    'spec',
-    'watch-files',
-    'watch-ignore'
+    "extension",
+    "file",
+    "global",
+    "ignore",
+    "node-option",
+    "reporter-option",
+    "require",
+    "spec",
+    "watch-files",
+    "watch-ignore",
   ],
   boolean: [
-    'allow-uncaught',
-    'async-only',
-    'bail',
-    'check-leaks',
-    'color',
-    'delay',
-    'diff',
-    'dry-run',
-    'exit',
-    'pass-on-failing-test-suite',
-    'fail-zero',
-    'forbid-only',
-    'forbid-pending',
-    'full-trace',
-    'inline-diffs',
-    'invert',
-    'list-interfaces',
-    'list-reporters',
-    'no-colors',
-    'parallel',
-    'posix-exit-codes',
-    'recursive',
-    'sort',
-    'watch'
+    "allow-uncaught",
+    "async-only",
+    "bail",
+    "check-leaks",
+    "color",
+    "delay",
+    "diff",
+    "dry-run",
+    "exit",
+    "pass-on-failing-test-suite",
+    "fail-zero",
+    "forbid-only",
+    "forbid-pending",
+    "full-trace",
+    "inline-diffs",
+    "invert",
+    "list-interfaces",
+    "list-reporters",
+    "no-colors",
+    "parallel",
+    "posix-exit-codes",
+    "recursive",
+    "sort",
+    "watch",
   ],
-  number: ['retries', 'jobs'],
+  number: ["retries", "jobs"],
   string: [
-    'config',
-    'fgrep',
-    'grep',
-    'package',
-    'reporter',
-    'ui',
-    'slow',
-    'timeout'
-  ]
+    "config",
+    "fgrep",
+    "grep",
+    "package",
+    "reporter",
+    "ui",
+    "slow",
+    "timeout",
+  ],
 });
 
 /**
@@ -71,35 +71,35 @@ const TYPES = (exports.types = {
  * @private
  */
 exports.aliases = {
-  'async-only': ['A'],
-  bail: ['b'],
-  color: ['c', 'colors'],
-  fgrep: ['f'],
-  global: ['globals'],
-  grep: ['g'],
-  ignore: ['exclude'],
-  invert: ['i'],
-  jobs: ['j'],
-  'no-colors': ['C'],
-  'node-option': ['n'],
-  parallel: ['p'],
-  reporter: ['R'],
-  'reporter-option': ['reporter-options', 'O'],
-  require: ['r'],
-  slow: ['s'],
-  sort: ['S'],
-  timeout: ['t', 'timeouts'],
-  ui: ['u'],
-  watch: ['w']
+  "async-only": ["A"],
+  bail: ["b"],
+  color: ["c", "colors"],
+  fgrep: ["f"],
+  global: ["globals"],
+  grep: ["g"],
+  ignore: ["exclude"],
+  invert: ["i"],
+  jobs: ["j"],
+  "no-colors": ["C"],
+  "node-option": ["n"],
+  parallel: ["p"],
+  reporter: ["R"],
+  "reporter-option": ["reporter-options", "O"],
+  require: ["r"],
+  slow: ["s"],
+  sort: ["S"],
+  timeout: ["t", "timeouts"],
+  ui: ["u"],
+  watch: ["w"],
 };
 
 const ALL_MOCHA_FLAGS = Object.keys(TYPES).reduce((acc, key) => {
   // gets all flags from each of the fields in `types`, adds those,
   // then adds aliases of each flag (if any)
-  TYPES[key].forEach(flag => {
+  TYPES[key].forEach((flag) => {
     acc.add(flag);
     const aliases = exports.aliases[flag] || [];
-    aliases.forEach(alias => {
+    aliases.forEach((alias) => {
       acc.add(alias);
     });
   });
@@ -112,8 +112,8 @@ const ALL_MOCHA_FLAGS = Object.keys(TYPES).reduce((acc, key) => {
  * @returns {boolean} If `true`, this is a Mocha flag
  * @private
  */
-exports.isMochaFlag = flag => {
-  return ALL_MOCHA_FLAGS.has(flag.replace(/^--?/, ''));
+exports.isMochaFlag = (flag) => {
+  return ALL_MOCHA_FLAGS.has(flag.replace(/^--?/, ""));
 };
 
 /**
@@ -122,17 +122,17 @@ exports.isMochaFlag = flag => {
  * @returns {string | undefined} - If flag is a valid mocha flag, the expected type of argument for this flag is returned, otherwise undefined is returned.
  * @private
  */
-exports.expectedTypeForFlag = flag => {
-  const normalizedName = flag.replace(/^--?/, '');
+exports.expectedTypeForFlag = (flag) => {
+  const normalizedName = flag.replace(/^--?/, "");
 
   // If flag is an alias, get it's full name.
   const aliases = exports.aliases;
   const fullFlagName =
-    Object.keys(aliases).find(flagName =>
-      aliases[flagName].includes(normalizedName)
+    Object.keys(aliases).find((flagName) =>
+      aliases[flagName].includes(normalizedName),
     ) || normalizedName;
 
-  return Object.keys(TYPES).find(flagType =>
-    TYPES[flagType].includes(fullFlagName)
+  return Object.keys(TYPES).find((flagType) =>
+    TYPES[flagType].includes(fullFlagName),
   );
 };