fix: don't toggle cli cursor on non-TTY (#7336)

Author: AriPerkkio

packages/vitest/src/node/core.ts

@@ -509,8 +509,6 @@ export class Vitest {
   }
 
   async collect(filters?: string[]): Promise<TestRunResult> {
-    this._onClose = []
-
     const files = await this.specifications.getRelevantTestSpecifications(filters)
 
     // if run with --changed, don't exit if no tests are found
@@ -543,8 +541,6 @@ export class Vitest {
    * @param filters String filters to match the test files
    */
   async start(filters?: string[]): Promise<TestRunResult> {
-    this._onClose = []
-
     try {
       await this.initCoverageProvider()
       await this.coverageProvider?.clean(this.config.coverage.clean)
@@ -602,8 +598,6 @@ export class Vitest {
    * If the `--watch` flag is provided, Vitest will still run changed tests even if this method was not called.
    */
   async init(): Promise<void> {
-    this._onClose = []
-
     try {
       await this.initCoverageProvider()
       await this.coverageProvider?.clean(this.config.coverage.clean)

packages/vitest/src/node/logger.ts

@@ -50,7 +50,9 @@ export class Logger {
     this.addCleanupListeners()
     this.registerUnhandledRejection()
 
-    ;(this.outputStream as Writable).write(HIDE_CURSOR)
+    if ((this.outputStream as typeof process.stdout).isTTY) {
+      (this.outputStream as Writable).write(HIDE_CURSOR)
+    }
   }
 
   log(...args: any[]) {
@@ -298,7 +300,10 @@ export class Logger {
   private addCleanupListeners() {
     const cleanup = () => {
       this.cleanupListeners.forEach(fn => fn())
-      ;(this.outputStream as Writable).write(SHOW_CURSOR)
+
+      if ((this.outputStream as typeof process.stdout).isTTY) {
+        (this.outputStream as Writable).write(SHOW_CURSOR)
+      }
     }
 
     const onExit = (signal?: string | number, exitCode?: number) => {

test/reporters/tests/logger.test.ts

@@ -0,0 +1,26 @@
+import { expect, test } from 'vitest'
+import { runVitest } from '../../test-utils'
+
+test('cursor is hidden during test run in TTY', async () => {
+  const { stdout } = await runVitest({
+    include: ['b1.test.ts'],
+    root: 'fixtures/default',
+    reporters: 'none',
+    watch: false,
+  }, undefined, undefined, undefined, { tty: true, preserveAnsi: true })
+
+  expect(stdout).toContain('\x1B[?25l')
+  expect(stdout).toContain('\x1B[?25h')
+})
+
+test('cursor is not hidden during test run in non-TTY', async () => {
+  const { stdout } = await runVitest({
+    include: ['b1.test.ts'],
+    root: 'fixtures/default',
+    reporters: 'none',
+    watch: false,
+  }, undefined, undefined, undefined, { preserveAnsi: true })
+
+  expect(stdout).not.toContain('\x1B[?25l')
+  expect(stdout).not.toContain('\x1B[?25h')
+})

test/test-utils/index.ts

@@ -22,6 +22,7 @@ export interface VitestRunnerCLIOptions {
   std?: 'inherit'
   fails?: boolean
   preserveAnsi?: boolean
+  tty?: boolean
 }
 
 export async function runVitest(
@@ -47,6 +48,11 @@ export async function runVitest(
       callback()
     },
   })
+
+  if (runnerOptions?.tty) {
+    (stdout as typeof process.stdout).isTTY = true
+  }
+
   const stderr = new Writable({
     write(chunk, __, callback) {
       if (runnerOptions.std === 'inherit') {