Skip to content

armgit / mocha

Public Imported from GitHub
0

☕️ Classic, reliable, trusted test framework for Node.js and the browser

chore: convert run-option-metadata and exports interface to ESM (#5910)

Mostafa Nazari27b081488b05
diff --git a/bin/mocha.js b/bin/mocha.js
index 388f0681..a1b1a74d 100755
--- a/bin/mocha.js
+++ b/bin/mocha.js
@@ -19,7 +19,7 @@ const {
} = 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 = {};
diff --git a/lib/cli/node-flags.mjs b/lib/cli/node-flags.mjs
index 89059c00..b5cbe7d7 100644
--- a/lib/cli/node-flags.mjs
+++ b/lib/cli/node-flags.mjs
@@ -5,7 +5,7 @@
*/
const nodeFlags = process.allowedNodeEnvironmentFlags;
-import { isMochaFlag } from "./run-option-metadata.js";
+import { isMochaFlag } from "./run-option-metadata.mjs";
import unparse from "yargs-unparser";
/**
diff --git a/lib/cli/options.mjs b/lib/cli/options.mjs
index 08207853..b182b54e 100644
--- a/lib/cli/options.mjs
+++ b/lib/cli/options.mjs
@@ -13,7 +13,7 @@ import {
aliases,
isMochaFlag,
expectedTypeForFlag,
-} from "./run-option-metadata.js";
+} from "./run-option-metadata.mjs";
import { ONE_AND_DONE_ARGS } from "./one-and-dones.js";
import mocharc from "../mocharc.json" with { type: "json" };
import { list } from "./run-helpers.js";
diff --git a/lib/cli/run-option-metadata.js b/lib/cli/run-option-metadata.mjs
similarity index 85%
rename from lib/cli/run-option-metadata.js
rename to lib/cli/run-option-metadata.mjs
index e850502f..7195e6e8 100644
--- a/lib/cli/run-option-metadata.js
+++ b/lib/cli/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 };
diff --git a/lib/cli/run.js b/lib/cli/run.js
index 3415811c..c1846186 100644
--- a/lib/cli/run.js
+++ b/lib/cli/run.js
@@ -24,7 +24,7 @@ const {
const { ONE_AND_DONES, ONE_AND_DONE_ARGS } = require("./one-and-dones");
const debug = require("debug")("mocha:cli:run");
const defaults = require("../mocharc.json");
-const { types, aliases } = require("./run-option-metadata");
+const { types, aliases } = require("./run-option-metadata.mjs");
const { isCI, logSymbols } = require("../utils");
/**
diff --git a/lib/interfaces/exports.js b/lib/interfaces/exports.mjs
similarity index 86%
rename from lib/interfaces/exports.js
rename to lib/interfaces/exports.mjs
index fac6aedb..bdb58001 100644
--- a/lib/interfaces/exports.js
+++ b/lib/interfaces/exports.mjs
@@ -1,6 +1,5 @@
-"use strict";
-var Suite = require("../suite");
-var Test = require("../test");
+import Suite from "../suite.js";
+import Test from "../test.js";
/**
* Exports-style (as Node.js module) interface:
@@ -19,7 +18,7 @@ var Test = require("../test");
*
* @param {Suite} suite Root suite.
*/
-module.exports = function (suite) {
+function exportsInterface(suite) {
var suites = [suite];
suite.on(Suite.constants.EVENT_FILE_REQUIRE, visit);
@@ -55,6 +54,8 @@ module.exports = function (suite) {
}
}
}
-};
+}
-module.exports.description = 'Node.js module ("exports") style';
+exportsInterface.description = 'Node.js module ("exports") style';
+
+export { exportsInterface };
diff --git a/lib/interfaces/index.js b/lib/interfaces/index.js
index 48ad0fd1..c3d245cb 100644
--- a/lib/interfaces/index.js
+++ b/lib/interfaces/index.js
@@ -3,4 +3,5 @@
exports.bdd = require("./bdd");
exports.tdd = require("./tdd");
exports.qunit = require("./qunit");
-exports.exports = require("./exports");
+const { exportsInterface } = require("./exports.mjs");
+exports.exports = exportsInterface;
diff --git a/test/node-unit/cli/mocha-flags.spec.js b/test/node-unit/cli/mocha-flags.spec.js
index 5218baea..6cb20187 100644
--- a/test/node-unit/cli/mocha-flags.spec.js
+++ b/test/node-unit/cli/mocha-flags.spec.js
@@ -4,7 +4,7 @@ var { expect } = require("chai");
const {
types,
expectedTypeForFlag,
-} = require("../../../lib/cli/run-option-metadata");
+} = require("../../../lib/cli/run-option-metadata.mjs");
describe("mocha-flags", function () {
describe("expectedTypeForFlag()", function () {
diff --git a/test/node-unit/cli/node-flags.spec.js b/test/node-unit/cli/node-flags.spec.js
index ecc3adbb..77061c6a 100644
--- a/test/node-unit/cli/node-flags.spec.js
+++ b/test/node-unit/cli/node-flags.spec.js
@@ -7,7 +7,7 @@ const {
unparseNodeFlags,
} = require("../../../lib/cli/node-flags.mjs");
-const { isMochaFlag } = require("../../../lib/cli/run-option-metadata");
+const { isMochaFlag } = require("../../../lib/cli/run-option-metadata.mjs");
describe("node-flags", function () {
describe("isNodeFlag()", function () {
diff --git a/test/node-unit/cli/run.spec.js b/test/node-unit/cli/run.spec.js
index aa61661e..e76e94c7 100644
--- a/test/node-unit/cli/run.spec.js
+++ b/test/node-unit/cli/run.spec.js
@@ -1,7 +1,7 @@
"use strict";
const { builder } = require("../../../lib/cli/run");
-const { types } = require("../../../lib/cli/run-option-metadata");
+const { types } = require("../../../lib/cli/run-option-metadata.mjs");
describe("command", function () {
describe("run", function () {