Skip to content

armgit / mocha

Public Imported from GitHub
0

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

feat: add --clear-screen option for watch mode (#6133)

Mostafa Nazari3301ed7578d2
diff --git a/docs/src/content/docs/running/cli.mdx b/docs/src/content/docs/running/cli.mdx
index 6ad0bdec..cfcc9caf 100644
--- a/docs/src/content/docs/running/cli.mdx
+++ b/docs/src/content/docs/running/cli.mdx
@@ -59,6 +59,8 @@ Reporting & Output
[string] [default: "spec"]
-O, --reporter-option, Reporter-specific options
--reporter-options (<k=v,[k1=v1,..]>) [array]
+ --clear-screen Clear the terminal before each run
+ in watch mode [boolean]
Configuration
--config Path to config file [string] [default: (nearest rc file)]
@@ -354,6 +356,15 @@ Not all reporters accept options.
Can be specified as a comma-delimited list.
+### `--clear-screen`
+
+:::note[New in v12.0.0]
+:::
+
+Clear the terminal before each run when `--watch` is set.
+
+This keeps only the latest run's output on screen, similar to the built-in behavior of the [`min` reporter](/reporters/min). It has no effect without `--watch`.
+
## Configuration
### `--config <path>`
diff --git a/lib/cli/run-option-metadata.cjs b/lib/cli/run-option-metadata.cjs
index 996fbefa..6b3bcb4a 100644
--- a/lib/cli/run-option-metadata.cjs
+++ b/lib/cli/run-option-metadata.cjs
@@ -30,6 +30,7 @@ const types = {
"async-only",
"bail",
"check-leaks",
+ "clear-screen",
"color",
"delay",
"diff",
diff --git a/lib/cli/run.cjs b/lib/cli/run.cjs
index 5a444ff4..5e59403b 100644
--- a/lib/cli/run.cjs
+++ b/lib/cli/run.cjs
@@ -275,6 +275,10 @@ exports.builder = (yargs) =>
description: "Watch files in the current working directory for changes",
group: GROUPS.FILES,
},
+ "clear-screen": {
+ description: "Clear the terminal before each run in watch mode",
+ group: GROUPS.OUTPUT,
+ },
"watch-files": {
description: "List of paths or globs to watch",
group: GROUPS.FILES,
diff --git a/lib/cli/watch-run.cjs b/lib/cli/watch-run.cjs
index b558a6e4..f688556f 100644
--- a/lib/cli/watch-run.cjs
+++ b/lib/cli/watch-run.cjs
@@ -46,7 +46,7 @@ const { logSymbols } = require("../utils.cjs");
*/
exports.watchParallelRun = (
mocha,
- { watchFiles, watchIgnore },
+ { watchFiles, watchIgnore, clearScreen },
fileCollectParams,
) => {
debug("creating parallel watcher");
@@ -54,6 +54,7 @@ exports.watchParallelRun = (
return createWatcher(mocha, {
watchFiles,
watchIgnore,
+ clearScreen,
beforeRun({ mocha }) {
// I don't know why we're cloning the root suite.
const rootSuite = mocha.suite.clone();
@@ -108,12 +109,17 @@ exports.watchParallelRun = (
* file collection. See `lib/cli/collect-files.cjs`.
* @private
*/
-exports.watchRun = (mocha, { watchFiles, watchIgnore }, fileCollectParams) => {
+exports.watchRun = (
+ mocha,
+ { watchFiles, watchIgnore, clearScreen },
+ fileCollectParams,
+) => {
debug("creating serial watcher");
return createWatcher(mocha, {
watchFiles,
watchIgnore,
+ clearScreen,
beforeRun({ mocha }) {
mocha.unloadFiles();
@@ -397,6 +403,7 @@ function createPathMatcher(allowed, ignored, basePath) {
* `chokidar.watch`.
* @param {string[]} [opts.watchIgnore] - List of paths and patterns to exclude
* from watching. See `ignored` option of `chokidar`.
+ * @param {boolean} [opts.clearScreen] - Clear the terminal before each run.
* @param {FileCollectionOptions} opts.fileCollectParams - List of extensions to watch if `opts.watchFiles` is not given.
* @returns {FSWatcher}
* @ignore
@@ -404,7 +411,7 @@ function createPathMatcher(allowed, ignored, basePath) {
*/
const createWatcher = (
mocha,
- { watchFiles, watchIgnore, beforeRun, fileCollectParams },
+ { watchFiles, watchIgnore, clearScreen, beforeRun, fileCollectParams },
) => {
if (!watchFiles) {
watchFiles = fileCollectParams.extension.map((ext) => `**/*.${ext}`);
@@ -436,6 +443,7 @@ const createWatcher = (
const rerunner = createRerunner(mocha, watcher, {
beforeRun,
+ clearScreen,
});
watcher.on("ready", async () => {
@@ -511,11 +519,12 @@ const createWatcher = (
* @param {FSWatcher} watcher - Chokidar `FSWatcher` instance
* @param {Object} [opts] - Options!
* @param {BeforeWatchRun} [opts.beforeRun] - Function to call before `mocha.run()`
+ * @param {boolean} [opts.clearScreen] - Clear the terminal before each run
* @returns {Rerunner}
* @ignore
* @private
*/
-const createRerunner = (mocha, watcher, { beforeRun } = {}) => {
+const createRerunner = (mocha, watcher, { beforeRun, clearScreen } = {}) => {
// Set to a `Runner` when mocha is running. Set to `null` when mocha is not
// running.
let runner = null;
@@ -525,6 +534,9 @@ const createRerunner = (mocha, watcher, { beforeRun } = {}) => {
const run = () => {
try {
+ if (clearScreen) {
+ clearTerminal();
+ }
mocha = beforeRun ? beforeRun({ mocha, watcher }) || mocha : mocha;
runner = mocha.run(() => {
debug("finished watch run");
@@ -611,6 +623,15 @@ const eraseLine = () => {
process.stdout.write("\u001b[2K");
};
+/**
+ * Clears the terminal and moves the cursor to the top-left corner.
+ * @private
+ */
+const clearTerminal = () => {
+ // "\u001b[2J" clears the screen. "\u001b[H" moves the cursor to the home position
+ process.stdout.write("\u001b[2J\u001b[H");
+};
+
/**
* Blast all of the watched files out of `require.cache`
* @param {FSWatcher} watcher - Chokidar FSWatcher
diff --git a/test/integration/options/watch.spec.cjs b/test/integration/options/watch.spec.cjs
index 121c02b7..65dcc9fe 100644
--- a/test/integration/options/watch.spec.cjs
+++ b/test/integration/options/watch.spec.cjs
@@ -562,5 +562,31 @@ describe("--watch", function () {
},
);
});
+
+ describe("--clear-screen", function () {
+ const CLEAR_SCREEN = String.fromCharCode(27) + "[2J";
+
+ it("clears the terminal before each run when enabled", function () {
+ const testFile = path.join(tempDir, "test.js");
+ copyFixture(DEFAULT_FIXTURE, testFile);
+
+ return runMochaWatchAsync([testFile, "--clear-screen"], tempDir, () => {
+ touchFile(testFile);
+ }).then((result) => {
+ expect(result.output, "to contain", CLEAR_SCREEN);
+ });
+ });
+
+ it("does not clear the terminal when disabled", function () {
+ const testFile = path.join(tempDir, "test.js");
+ copyFixture(DEFAULT_FIXTURE, testFile);
+
+ return runMochaWatchAsync([testFile], tempDir, () => {
+ touchFile(testFile);
+ }).then((result) => {
+ expect(result.output, "not to contain", CLEAR_SCREEN);
+ });
+ });
+ });
});
});