fix(vitest): check color support for intercepted console logging (#4966)

Author: hi-ogawa

packages/vitest/src/runtime/console.ts

@@ -1,7 +1,7 @@
 import { Writable } from 'node:stream'
 import { Console } from 'node:console'
 import { relative } from 'node:path'
-import { getSafeTimers } from '@vitest/utils'
+import { getColors, getSafeTimers } from '@vitest/utils'
 import { RealDate } from '../integrations/mock/date'
 import type { WorkerGlobalState } from '../types'
 
@@ -128,7 +128,7 @@ export function createCustomConsole(state: WorkerGlobalState) {
   return new Console({
     stdout,
     stderr,
-    colorMode: true,
+    colorMode: getColors().isColorSupported,
     groupIndentation: 2,
   })
 }

pnpm-lock.yaml

@@ -0,0 +1,5 @@
+import { test } from 'vitest'
+
+test("console color", () => {
+  console.log(true) // node console highlights primitive
+})

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

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

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

@@ -3,9 +3,10 @@
   "type": "module",
   "private": true,
   "scripts": {
-    "test": "vitest run --typecheck.enabled"
+    "test": "vitest --typecheck.enabled"
   },
   "devDependencies": {
+    "execa": "^8.0.1",
     "vite": "latest",
     "vitest": "workspace:*"
   }

test/config/package.json

@@ -0,0 +1,28 @@
+import { expect, test } from 'vitest'
+import { execa } from 'execa'
+
+// use "execa" directly since "runVitestCli" strips color
+
+test('with color', async () => {
+  const proc = await execa('vitest', ['run', '--root=./fixtures/console-color'], {
+    env: {
+      CI: '1',
+      FORCE_COLOR: '1',
+      NO_COLOR: undefined,
+      GITHUB_ACTIONS: undefined,
+    },
+  })
+  expect(proc.stdout).toContain('\n\x1B[33mtrue\x1B[39m\n')
+})
+
+test('without color', async () => {
+  const proc = await execa('vitest', ['run', '--root=./fixtures/console-color'], {
+    env: {
+      CI: '1',
+      FORCE_COLOR: undefined,
+      NO_COLOR: '1',
+      GITHUB_ACTIONS: undefined,
+    },
+  })
+  expect(proc.stdout).toContain('\ntrue\n')
+})