feat: add an option to hide skipped test lines (#2745)

Co-authored-by: Vladimir <[email protected]>
vitest-dev · May 3, 2023 · 9bdb160 · 9bdb160
1 parent f3c3607
commit 9bdb160
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 13 deletions.
diff --git a/packages/vitest/src/defaults.ts b/packages/vitest/src/defaults.ts
@@ -76,6 +76,7 @@ const config = {
   update: false,
   reporters: [],
   silent: false,
+  hideSkippedTests: false,
   api: false,
   ui: false,
   uiBase: '/__vitest__/',

diff --git a/packages/vitest/src/node/cli.ts b/packages/vitest/src/node/cli.ts
@@ -23,6 +23,7 @@ cli
   .option('--threads', 'Enabled threads (default: true)')
   .option('--single-thread', 'Run tests inside a single thread, requires --threads (default: false)')
   .option('--silent', 'Silent console output from tests')
+  .option('--hideSkippedTests', 'Hide logs for skipped tests')
   .option('--isolate', 'Isolate environment for each test file (default: true)')
   .option('--reporter <name>', 'Specify reporters')
   .option('--outputFile <filename/-s>', 'Write test results to a file when supporter reporter is also specified, use cac\'s dot notation for individual outputs of multiple reporters')

diff --git a/packages/vitest/src/node/reporters/renderers/listRenderer.ts b/packages/vitest/src/node/reporters/renderers/listRenderer.ts
@@ -150,8 +150,15 @@ export function renderTree(tasks: Task[], options: ListRendererOptions, level =
     taskOutput.push(renderHookState(task, 'beforeAll', level + 1))
     taskOutput.push(renderHookState(task, 'beforeEach', level + 1))
     if (task.type === 'suite' && task.tasks.length > 0) {
-      if ((task.result?.state === 'fail' || task.result?.state === 'run' || options.renderSucceed))
-        taskOutput.push(renderTree(task.tasks, options, level + 1, maxRows))
+      if ((task.result?.state === 'fail' || task.result?.state === 'run' || options.renderSucceed)) {
+        if (options.logger.ctx.config.hideSkippedTests) {
+          const filteredTasks = task.tasks.filter(t => t.mode !== 'skip' && t.mode !== 'todo')
+          taskOutput.push(renderTree(filteredTasks, options, level + 1, maxRows))
+        }
+        else {
+          taskOutput.push(renderTree(task.tasks, options, level + 1, maxRows))
+        }
+      }
     }
     taskOutput.push(renderHookState(task, 'afterAll', level + 1))
     taskOutput.push(renderHookState(task, 'afterEach', level + 1))
@@ -175,14 +182,27 @@ export function createListRenderer(_tasks: Task[], options: ListRendererOptions)
   const log = options.logger.logUpdate
 
   function update() {
-    log(renderTree(
-      tasks,
-      options,
-      0,
-      // log-update already limits the amount of printed rows to fit the current terminal
-      // but we can optimize performance by doing it ourselves
-      process.stdout.rows,
-    ))
+    if (options.logger.ctx.config.hideSkippedTests) {
+      const filteredTasks = tasks.filter(t => t.mode !== 'skip' && t.mode !== 'todo')
+      log(renderTree(
+        filteredTasks,
+        options,
+        0,
+        // log-update already limits the amount of printed rows to fit the current terminal
+        // but we can optimize performance by doing it ourselves
+        process.stdout.rows,
+      ))
+    }
+    else {
+      log(renderTree(
+        tasks,
+        options,
+        0,
+        // log-update already limits the amount of printed rows to fit the current terminal
+        // but we can optimize performance by doing it ourselves
+        process.stdout.rows,
+      ))
+    }
   }
 
   return {
@@ -202,9 +222,15 @@ export function createListRenderer(_tasks: Task[], options: ListRendererOptions)
         timer = undefined
       }
       log.clear()
-
-      // Note that at this point the renderTree should output all tasks
-      options.logger.log(renderTree(tasks, options))
+      if (options.logger.ctx.config.hideSkippedTests) {
+        const filteredTasks = tasks.filter(t => t.mode !== 'skip' && t.mode !== 'todo')
+        // Note that at this point the renderTree should output all tasks
+        options.logger.log(renderTree(filteredTasks, options))
+      }
+      else {
+        // Note that at this point the renderTree should output all tasks
+        options.logger.log(renderTree(tasks, options))
+      }
       return this
     },
     clear() {

diff --git a/packages/vitest/src/types/config.ts b/packages/vitest/src/types/config.ts
@@ -309,6 +309,13 @@ export interface InlineConfig {
    */
   silent?: boolean
 
+  /**
+   * Hide logs for skipped tests
+   *
+   * @default false
+   */
+  hideSkippedTests?: boolean
+
   /**
    * Path to setup files
    */