mocha 12.0.0-beta-9.2 → 12.0.0-beta-9.4

package/bin/mocha.js

@@ -4,22 +4,22 @@
 
 /**
  * This wrapper executable checks for known node flags and appends them when found,
- * before invoking the "real" executable (`lib/cli/cli.js`)
+ * before invoking the "real" executable (`lib/cli/cli.mjs`)
  *
  * @module bin/mocha
  * @private
  */
 
 const os = require("node:os");
-const { loadOptions } = require("../lib/cli/options");
+const { loadOptions } = require("../lib/cli/options.mjs");
 const {
   unparseNodeFlags,
   isNodeFlag,
   impliesNoTimeouts,
-} = require("../lib/cli/node-flags");
+} = 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");
+const { aliases } = require("../lib/cli/run-option-metadata.mjs");
 
 const mochaArgs = {};
 const nodeArgs = {};
@@ -81,7 +81,7 @@ if (mochaArgs._) {
 
 if (mochaArgs["node-option"] || Object.keys(nodeArgs).length || hasInspect) {
   const { spawn } = require("node:child_process");
-  const mochaPath = require.resolve("../lib/cli/cli.js");
+  const mochaPath = require.resolve("../lib/cli/cli.mjs");
 
   const nodeArgv =
     (mochaArgs["node-option"] &&
@@ -146,5 +146,5 @@ if (mochaArgs["node-option"] || Object.keys(nodeArgs).length || hasInspect) {
   });
 } else {
   debug("running Mocha in-process");
-  require("../lib/cli/cli").main([], mochaArgs);
+  require("../lib/cli/cli.mjs").main([], mochaArgs);
 }

package/browser-entry.js

@@ -8,8 +8,8 @@
 
 process.stdout = require("browser-stdout")({ label: false });
 
-var parseQuery = require("./lib/browser/parse-query");
-var highlightTags = require("./lib/browser/highlight-tags");
+var parseQuery = require("./lib/browser/parse-query.mjs").parseQuery;
+var highlightTags = require("./lib/browser/highlight-tags.mjs").highlightTags;
 var Mocha = require("./lib/mocha");
 
 /**

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

@@ -1,5 +1,3 @@
-"use strict";
-
 /**
  * Highlight the given string of `js`.
  *
@@ -31,9 +29,9 @@ function highlight(js) {
  * @private
  * @param {string} name
  */
-module.exports = function highlightTags(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,7 +5,7 @@
  * @param {string} qs
  * @return {Object<string, string>}
  */
-module.exports = function parseQuery(qs) {
+export function parseQuery(qs) {
   return qs
     .replace("?", "")
     .split("&")
@@ -21,4 +19,4 @@ module.exports = function parseQuery(qs) {
 
       return obj;
     }, {});
-};
+}

package/lib/cli/{cli.js → cli.mjs}

@@ -1,5 +1,3 @@
-"use strict";
-
 /**
  * Contains CLI entry point and public API for programmatic usage in Node.js.
  * - Option parsing is handled by {@link https://npm.im/yargs yargs}.
@@ -8,25 +6,20 @@
  * @module lib/cli
  */
 
-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, logSymbols } = require("../utils");
+import debugModule from "debug";
+import yargs from "yargs";
+import { fileURLToPath } from "node:url";
+
+import { loadOptions, YARGS_PARSER_CONFIG } from "./options.mjs";
+import { run, init } from "./commands.mjs";
+import pc from "picocolors";
+import { logSymbols } from "../utils.js";
+
+import packageJson from "../../package.json" with { type: "json" };
+
+const __filename = fileURLToPath(import.meta.url);
+
+const debug = debugModule("mocha:cli:cli");
 
 /**
  * - Accepts an `Array` of arguments
@@ -37,12 +30,8 @@ const { cwd, logSymbols } = require("../utils");
  * @param {string[]} argv - Array of arguments to parse, or by default the lovely `process.argv.slice(2)`
  * @param {object} [mochaArgs] - Object of already parsed Mocha arguments (by bin/mocha)
  */
-exports.main = (argv = process.argv.slice(2), mochaArgs) => {
+export function main(argv = process.argv.slice(2), mochaArgs) {
   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"));
-  }
 
   try {
     Error.stackTraceLimit = Infinity; // configurable via --stack-trace-limit?
@@ -50,12 +39,12 @@ exports.main = (argv = process.argv.slice(2), mochaArgs) => {
     debug("unable to set Error.stackTraceLimit = Infinity", err);
   }
 
-  var args = mochaArgs || loadOptions(argv);
+  const args = mochaArgs ?? loadOptions(argv);
 
   yargs()
     .scriptName("mocha")
-    .command(commands.run)
-    .command(commands.init)
+    .command(run)
+    .command(init)
     .updateStrings({
       "Positionals:": "Positional Arguments",
       "Options:": "Other Options",
@@ -74,27 +63,22 @@ exports.main = (argv = process.argv.slice(2), mochaArgs) => {
     })
     .help("help", "Show usage information & exit")
     .alias("help", "h")
-    .version("version", "Show version number & exit", version)
+    .version("version", "Show version number & exit", packageJson.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)}
+    Chat: ${pc.magenta(packageJson.discord)}
+  GitHub: ${pc.blue(packageJson.repository.url)}
+    Docs: ${pc.yellow(packageJson.homepage)}
       `,
     )
     .parserConfiguration(YARGS_PARSER_CONFIG)
     .config(args)
     .parse(args._);
-};
-
-exports.lookupFiles = lookupFiles;
-exports.loadOptions = loadOptions;
-exports.loadPkgRc = loadPkgRc;
-exports.loadRc = loadRc;
+}
 
 // allow direct execution
-if (require.main === module) {
-  exports.main();
+if (__filename === process.argv[1]) {
+  main();
 }

package/lib/cli/collect-files.js

@@ -4,8 +4,8 @@ const path = require("node:path");
 const pc = require("picocolors");
 const debug = require("debug")("mocha:cli:run:helpers");
 const { minimatch } = require("minimatch");
-const { NO_FILES_MATCH_PATTERN } = require("../error-constants").constants;
-const lookupFiles = require("./lookup-files");
+const { NO_FILES_MATCH_PATTERN } = require("../error-constants.mjs").constants;
+const { lookupFiles } = require("./lookup-files.mjs");
 const { castArray } = require("../utils");
 
 /**

package/lib/cli/{commands.js → commands.mjs}

@@ -1,5 +1,3 @@
-"use strict";
-
 /**
  * Exports Yargs commands
  * @see https://github.com/yargs/yargs/blob/main/docs/advanced.md
@@ -7,8 +5,6 @@
  * @module
  */
 
-module.exports = {
-  init: require("./init"),
-  // default command
-  run: require("./run"),
-};
+export * as init from "./init.mjs";
+// default command
+export { default as run } from "./run.js";

package/lib/cli/config.js

@@ -11,7 +11,7 @@ const fs = require("node:fs");
 const path = require("node:path");
 const debug = require("debug")("mocha:cli:config");
 const findUp = require("find-up");
-const { createUnparsableFileError } = require("../errors");
+const { createUnparsableFileError } = require("../errors.mjs");
 const utils = require("../utils");
 
 /**
@@ -21,6 +21,7 @@ const utils = require("../utils");
  * The user should still be able to explicitly specify a file.
  * @private
  */
+// This is documented publicly in `configuring.mdx`
 exports.CONFIG_FILES = [
   ".mocharc.cjs",
   ".mocharc.js",

package/lib/cli/index.js

@@ -1,3 +1,3 @@
 "use strict";
 
-module.exports = require("./cli");
+module.exports = require("./cli.mjs");

package/lib/cli/{init.js → init.mjs}

@@ -1,5 +1,3 @@
-"use strict";
-
 /**
  * Command module for "init" command
  *
@@ -7,22 +5,22 @@
  * @module
  */
 
-const fs = require("node:fs");
-const path = require("node:path");
+import fs from "node:fs";
+import path from "node:path";
 
-exports.command = "init <path>";
+export const command = "init <path>";
 
-exports.description = "create a client-side Mocha setup at <path>";
+export const description = "create a client-side Mocha setup at <path>";
 
-exports.builder = (yargs) =>
+export const builder = (yargs) =>
   yargs.positional("path", {
     type: "string",
     normalize: true,
   });
 
-exports.handler = (argv) => {
+export const handler = (argv) => {
   const destdir = argv.path;
-  const srcdir = path.join(__dirname, "..", "..");
+  const srcdir = path.join(import.meta.dirname, "..", "..");
   fs.mkdirSync(destdir, { recursive: true });
   const css = fs.readFileSync(path.join(srcdir, "mocha.css"));
   const js = fs.readFileSync(path.join(srcdir, "mocha.js"));

package/lib/cli/{lookup-files.js → lookup-files.mjs}

@@ -1,17 +1,18 @@
-"use strict";
 /**
  * Contains `lookupFiles`, which takes some globs/dirs/options and returns a list of files.
  * @module
  * @private
  */
 
-var fs = require("node:fs");
-var path = require("node:path");
-var glob = require("glob");
-var errors = require("../errors");
-var createNoFilesMatchPatternError = errors.createNoFilesMatchPatternError;
-var createMissingArgumentError = errors.createMissingArgumentError;
-const debug = require("debug")("mocha:cli:lookup-files");
+import fs from "node:fs";
+import path from "node:path";
+import * as glob from "glob";
+import {
+  createNoFilesMatchPatternError,
+  createMissingArgumentError,
+} from "../errors.mjs";
+import debugModule from "debug";
+const debug = debugModule("mocha:cli:lookup-files");
 
 /**
  * Determines if pathname would be a "hidden" file (or directory) on UN*X.
@@ -65,11 +66,7 @@ const hasMatchingExtname = (pathname, exts = []) =>
  * @throws {Error} if no files match pattern.
  * @throws {TypeError} if `filepath` is directory and `extensions` not provided.
  */
-module.exports = function lookupFiles(
-  filepath,
-  extensions = [],
-  recursive = false,
-) {
+export function lookupFiles(filepath, extensions = [], recursive = false) {
   const files = [];
   let stat;
 
@@ -152,4 +149,4 @@ module.exports = function lookupFiles(
   });
 
   return files;
-};
+}

package/lib/cli/{node-flags.js → node-flags.mjs}

@@ -1,5 +1,3 @@
-"use strict";
-
 /**
  * Some settings and code related to Mocha's handling of Node.js/V8 flags.
  * @private
@@ -7,8 +5,8 @@
  */
 
 const nodeFlags = process.allowedNodeEnvironmentFlags;
-const { isMochaFlag } = require("./run-option-metadata");
-const unparse = require("yargs-unparser");
+import { isMochaFlag } from "./run-option-metadata.mjs";
+import unparse from "yargs-unparser";
 
 /**
  * These flags are considered "debug" flags.
@@ -34,7 +32,7 @@ const debugFlags = new Set(["inspect", "inspect-brk"]);
  * @returns {boolean} If the flag is considered a "Node" flag.
  * @private
  */
-exports.isNodeFlag = (flag, bareword = true) => {
+export function isNodeFlag(flag, bareword = true) {
   if (!bareword) {
     // check if the flag begins with dashes; if not, not a node flag.
     if (!/^--?/.test(flag)) {
@@ -53,7 +51,7 @@ exports.isNodeFlag = (flag, bareword = true) => {
       flag,
     )
   );
-};
+}
 
 /**
  * Returns `true` if the flag is a "debug-like" flag.  These require timeouts
@@ -62,7 +60,9 @@ exports.isNodeFlag = (flag, bareword = true) => {
  * @returns {boolean}
  * @private
  */
-exports.impliesNoTimeouts = (flag) => debugFlags.has(flag);
+export function impliesNoTimeouts(flag) {
+  return debugFlags.has(flag);
+}
 
 /**
  * All non-strictly-boolean arguments to node--those with values--must specify those values using `=`, e.g., `--inspect=0.0.0.0`.
@@ -72,7 +72,7 @@ exports.impliesNoTimeouts = (flag) => debugFlags.has(flag);
  * @returns {string[]} Unparsed arguments using `=` to specify values
  * @private
  */
-exports.unparseNodeFlags = (opts) => {
+export function unparseNodeFlags(opts) {
   var args = unparse(opts);
   return args.length
     ? args
@@ -82,4 +82,4 @@ exports.unparseNodeFlags = (opts) => {
         .join("")
         .split(" ")
     : [];
-};
+}

package/lib/cli/{one-and-dones.js → one-and-dones.mjs}

@@ -1,5 +1,3 @@
-"use strict";
-
 /**
  * Contains "command" code for "one-and-dones"--options passed
  * to Mocha which cause it to just dump some info and exit.
@@ -8,7 +6,7 @@
  * @private
  */
 
-const Mocha = require("../mocha");
+import Mocha from "../mocha.js";
 
 /**
  * Dumps a sorted list of the enumerable, lower-case keys of some object
@@ -43,7 +41,7 @@ const showKeys = (obj) => {
  * @namespace
  * @private
  */
-exports.ONE_AND_DONES = {
+const ONE_AND_DONES = {
   /**
    * Dump list of built-in interfaces
    * @private
@@ -65,6 +63,8 @@ exports.ONE_AND_DONES = {
  * @type Set<string>
  * @private
  */
-exports.ONE_AND_DONE_ARGS = new Set(
-  ["help", "h", "version", "V"].concat(Object.keys(exports.ONE_AND_DONES)),
+const ONE_AND_DONE_ARGS = new Set(
+  ["help", "h", "version", "V"].concat(Object.keys(ONE_AND_DONES)),
 );
+
+export { ONE_AND_DONES, ONE_AND_DONE_ARGS };

package/lib/cli/{options.js → options.mjs}

@@ -1,5 +1,3 @@
-"use strict";
-
 /**
  * Main entry point for handling filesystem-based configuration,
  * whether that's a config file or `package.json` or whatever.
@@ -7,28 +5,29 @@
  * @private
  */
 
-const fs = require("node:fs");
-const pc = require("picocolors");
-const yargsParser = require("yargs-parser");
-const {
+import { readFileSync } from "node:fs";
+import pc from "picocolors";
+import yargsParser from "yargs-parser";
+import {
   types,
   aliases,
   isMochaFlag,
   expectedTypeForFlag,
-} = require("./run-option-metadata");
-const { ONE_AND_DONE_ARGS } = require("./one-and-dones");
-const mocharc = require("../mocharc.json");
-const { list } = require("./run-helpers");
-const { loadConfig, findConfig } = require("./config");
-const findUp = require("find-up");
-const debug = require("debug")("mocha:cli:options");
-const { isNodeFlag } = require("./node-flags");
-const {
+} from "./run-option-metadata.mjs";
+import { ONE_AND_DONE_ARGS } from "./one-and-dones.mjs";
+import mocharc from "../mocharc.json" with { type: "json" };
+import { list } from "./run-helpers.js";
+import { loadConfig, findConfig } from "./config.js";
+import { sync } from "find-up";
+import debugModule from "debug";
+const debug = debugModule("mocha:cli:options");
+import { isNodeFlag } from "./node-flags.mjs";
+import {
   createUnparsableFileError,
   createInvalidArgumentTypeError,
   createUnsupportedError,
-} = require("../errors");
-const { isNumeric } = require("../utils");
+} from "../errors.mjs";
+import { isNumeric } from "../utils.js";
 
 /**
  * The `yargs-parser` namespace
@@ -46,7 +45,7 @@ const { isNumeric } = require("../utils");
  * Base yargs parser configuration
  * @private
  */
-const YARGS_PARSER_CONFIG = {
+export const YARGS_PARSER_CONFIG = {
   "combine-arrays": true,
   "short-option-groups": false,
   "dot-notation": false,
@@ -210,34 +209,33 @@ const parse = (args = [], defaultValues = {}, ...configObjects) => {
  * @alias module:lib/cli.loadRc
  * @returns {external:yargsParser.Arguments|void} Parsed config, or nothing if `args.config` is `false`
  */
-const loadRc = (args = {}) => {
+export const loadRc = (args = {}) => {
   if (args.config !== false) {
     const config = args.config || findConfig();
     return config ? loadConfig(config) : {};
   }
 };
 
-module.exports.loadRc = loadRc;
-
 /**
  * Given path to `package.json` in `args.package`, attempt to load config from `mocha` prop.
+ * If `args.package` is falsy, attempts to load from default package location (`./package.json`)
  * @param {Object} [args] - Arguments object
- * @param {string|boolean} [args.config] - Path to `package.json` or `false` to skip
+ * @param {string|boolean} [args.config] - Path to `package.json` or `false` to use default
  * @public
  * @alias module:lib/cli.loadPkgRc
- * @returns {external:yargsParser.Arguments|void} Parsed config, or nothing if `args.package` is `false`
+ * @returns {external:yargsParser.Arguments|void} Parsed config. Throws if unparsableF. Empty object if file not found.
  */
-const loadPkgRc = (args = {}) => {
+export const loadPkgRc = (args = {}) => {
   let result;
   if (args.package === false) {
     return result;
   }
   result = {};
-  const filepath = args.package || findUp.sync(mocharc.package);
+  const filepath = args.package || sync(mocharc.package);
   if (filepath) {
     let configData;
     try {
-      configData = fs.readFileSync(filepath, "utf8");
+      configData = readFileSync(filepath, "utf8");
     } catch (err) {
       // If `args.package` was explicitly specified, throw an error
       if (filepath == args.package) {
@@ -269,8 +267,6 @@ const loadPkgRc = (args = {}) => {
   return result;
 };
 
-module.exports.loadPkgRc = loadPkgRc;
-
 /**
  * Priority list:
  *
@@ -287,7 +283,7 @@ module.exports.loadPkgRc = loadPkgRc;
  * @alias module:lib/cli.loadOptions
  * @returns {external:yargsParser.Arguments} Parsed args from everything
  */
-const loadOptions = (argv = []) => {
+export const loadOptions = (argv = []) => {
   let args = parse(argv);
   // short-circuit: look for a flag that would abort loading of options
   if (
@@ -332,6 +328,3 @@ const loadOptions = (argv = []) => {
 
   return args;
 };
-
-module.exports.loadOptions = loadOptions;
-module.exports.YARGS_PARSER_CONFIG = YARGS_PARSER_CONFIG;

package/lib/cli/run-helpers.js

@@ -21,9 +21,9 @@ 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 { createInvalidLegacyPluginError } = require("../errors.mjs");
 const { requireOrImport } = require("../nodejs/esm-utils");
-const PluginLoader = require("../plugin-loader");
+const { PluginLoader } = require("../plugin-loader.mjs");
 
 /**
  * Exits Mocha when tests + code under test has finished execution (default)

package/lib/cli/{run-option-metadata.js → run-option-metadata.mjs}

@@ -1,5 +1,3 @@
-"use strict";
-
 /**
  * Metadata about various options of the `run` command
  * @see module:lib/cli/run
@@ -12,7 +10,7 @@
  * @type {Record<string, string[]>}
  * @private
  */
-const TYPES = (exports.types = {
+const types = {
   array: [
     "extension",
     "file",
@@ -63,7 +61,7 @@ const TYPES = (exports.types = {
     "slow",
     "timeout",
   ],
-});
+};
 
 /**
  * Option aliases keyed by canonical option name.
@@ -71,7 +69,7 @@ const TYPES = (exports.types = {
  * @type {Record<string, string[]>}
  * @private
  */
-exports.aliases = {
+const aliases = {
   "async-only": ["A"],
   bail: ["b"],
   color: ["c", "colors"],
@@ -94,13 +92,13 @@ exports.aliases = {
   watch: ["w"],
 };
 
-const ALL_MOCHA_FLAGS = Object.keys(TYPES).reduce((acc, key) => {
+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) => {
+    const flagAliases = aliases[flag] || [];
+    flagAliases.forEach((alias) => {
       acc.add(alias);
     });
   });
@@ -113,7 +111,7 @@ const ALL_MOCHA_FLAGS = Object.keys(TYPES).reduce((acc, key) => {
  * @returns {boolean} If `true`, this is a Mocha flag
  * @private
  */
-exports.isMochaFlag = (flag) => {
+const isMochaFlag = (flag) => {
   return ALL_MOCHA_FLAGS.has(flag.replace(/^--?/, ""));
 };
 
@@ -123,17 +121,18 @@ 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 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),
     ) || normalizedName;
 
-  return Object.keys(TYPES).find((flagType) =>
-    TYPES[flagType].includes(fullFlagName),
+  return Object.keys(types).find((flagType) =>
+    types[flagType].includes(fullFlagName),
   );
 };
+
+export { types, aliases, isMochaFlag, expectedTypeForFlag };