feat(vitest): add --disable-console-intercept option to allow opting-out from automatic console log interception (#4786)

Author: hi-ogawa

docs/guide/cli.md

@@ -102,6 +102,7 @@ Run only [benchmark](https://vitest.dev/guide/features.html#benchmarking-experim
 | `--retry <times>` | Retry the test specific number of times if it fails |
 | `--exclude <glob>` | Additional file globs to be excluded from test |
 | `--expand-snapshot-diff` | Show full diff when snapshot fails |
+| `--disable-console-intercept` | Disable automatic interception of console logging (default: `false`) |
 | `--typecheck [options]` | Custom options for typecheck pool. If passed without options, enables typechecking |
 | `--typecheck.enabled` | Enable typechecking alongside tests (default: `false`) |
 | `--typecheck.only` | Run only typecheck tests. This automatically enables typecheck (default: `false`) |

packages/vitest/src/defaults.ts

@@ -101,6 +101,7 @@ const config = {
     exclude: defaultExclude,
   },
   slowTestThreshold: 300,
+  disableConsoleIntercept: false,
 } satisfies UserConfig
 
 export const configDefaults = Object.freeze(config)

packages/vitest/src/node/cli.ts

@@ -59,6 +59,7 @@ cli
   .option('--diff <path>', 'Path to a diff config that will be used to generate diff interface')
   .option('--exclude <glob>', 'Additional file globs to be excluded from test')
   .option('--expand-snapshot-diff', 'Show full diff when snapshot fails')
+  .option('--disable-console-intercept', 'Disable automatic interception of console logging (default: `false`)')
   .option('--typecheck [options]', 'Custom options for typecheck pool')
   .option('--typecheck.enabled', 'Enable typechecking alongside tests (default: false)')
   .option('--typecheck.only', 'Run only typecheck tests. This automatically enables typecheck (default: false)')

packages/vitest/src/node/core.ts

@@ -282,6 +282,7 @@ export class Vitest {
       'pool',
       'globals',
       'expandSnapshotDiff',
+      'disableConsoleIntercept',
       'retry',
       'testNamePattern',
       'passWithNoTests',

packages/vitest/src/runtime/setup-node.ts

@@ -55,7 +55,8 @@ export async function setupGlobalEnv(config: ResolvedConfig, { environment }: Re
     getSourceMap: source => state.moduleCache.getSourceMap(source),
   })
 
-  await setupConsoleLogSpy(state)
+  if (!config.disableConsoleIntercept)
+    await setupConsoleLogSpy(state)
 }
 
 export async function setupConsoleLogSpy(state: WorkerGlobalState) {

packages/vitest/src/types/config.ts

@@ -668,6 +668,17 @@ export interface InlineConfig {
    * Show full diff when snapshot fails instead of a patch.
    */
   expandSnapshotDiff?: boolean
+
+  /**
+   * By default, Vitest automatically intercepts console logging during tests for extra formatting of test file, test title, etc...
+   * This is also required for console log preview on Vitest UI.
+   * However, disabling such interception might help when you want to debug a code with normal synchronus terminal console logging.
+   *
+   * This option has no effect on browser pool since Vitest preserves original logging on browser devtools.
+   *
+   * @default false
+   */
+  disableConsoleIntercept?: boolean
 }
 
 export interface TypecheckConfig {

test/config/fixtures/console/basic.test.ts

@@ -0,0 +1,5 @@
+import { test } from 'vitest'
+
+test('basic', () => {
+  console.error("__test_console__");
+})

test/config/fixtures/console/vitest.config.ts

@@ -0,0 +1,3 @@
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({})

test/config/test/console.test.ts

@@ -0,0 +1,17 @@
+import { expect, test } from 'vitest'
+import { runVitest } from '../../test-utils'
+
+test('default intercept', async () => {
+  const { stderr } = await runVitest({
+    root: './fixtures/console',
+  })
+  expect(stderr).toBe('stderr | basic.test.ts > basic\n__test_console__\n\n')
+})
+
+test('disable intercept', async () => {
+  const { stderr } = await runVitest({
+    root: './fixtures/console',
+    disableConsoleIntercept: true,
+  })
+  expect(stderr).toBe('__test_console__\n')
+})