vitest-fail-on-console: Stop Ignoring console.error in Your Tests

npm install -D vitest-fail-on-console

// tests/setup.ts
import failOnConsole from 'vitest-fail-on-console'

failOnConsole()

import { defineConfig from 'vitest/config'

export default defineConfig({
  test: {
    setupFiles: ['tests/setup.ts'],
  },
})

l.

Configuration Options

failOnConsole() accepts an options object to control which console methods trigger failures:

failOnConsole({
  shouldFailOnError: true,   // default true
  shouldFailOnWarn: true,    // default true
  shouldFailOnLog: false,    // default false
  shouldFailOnInfo: false,   // default false
  shouldFailOnDebug: false,  // default false
  shouldFailOnAssert: false, // default false
})

error and warn are usually enough. Whether to include log / info / debug depends on your project's conventions.

allowMessage

Allow specific messages through without failing — useful for known third-party issues you can't fix right now:

failOnConsole({
  allowMessage: (message) => {
    return /ResizeObserver loop limit exceeded/.test(message)
  },
})

silenceMessage

Like allowMessage, but also suppresses the console output entirely:

failOnConsole({
  silenceMessage: (message) => {
    return /Not implemented: navigation/.test(message)
  },
})

skipTest

Skip specific test files or test names entirely:

failOnConsole({
  skipTest: ({ testPath, testName }) => {
    return testPath.includes('/legacy/')
  },
})

afterEachDelay

Sometimes async operations call console methods after a test ends. This option adds a delay before checking:

failOnConsole({
  afterEachDelay: 100, // wait 100ms, default is 0
})

Handling Expected console.error Calls

After installing vitest-fail-on-console, if a test is specifically verifying that console.error gets called, letting it fire naturally will cause the test to fail.

The correct approach is to mock it with vi.spyOn:

it('logs an error when request fails', () => {
  // mock it so the message doesn't actually reach the console
  vi.spyOn(console, 'error').mockImplementation(() => {})

  triggerSomethingThatLogsError()

  // assert it was called with the expected message
  expect(console.error).toHaveBeenCalledWith('Request failed')
})

This does two things: the test explicitly declares "I know an error will be logged here," and it asserts the exact message. Much stricter than silently letting console.error through.

Pair It with a Clean Test Environment

vitest-fail-on-console handles the console output side. If your tests also have I/O boundaries to replace — filesystem, file watchers — you can pair it with memfs using the same philosophy: every aspect of the test environment should be under your control.

See Testing a Filesystem Service with memfs + FakeWatchService for that approach.

Pitfall Guide

1. Ignoring Expected Console Calls: Tests that intentionally verify error logging will fail immediately upon plugin activation. Always wrap expected console calls with vi.spyOn().mockImplementation() and assert against the mock.
2. Async Console Timing Mismatches: Promises or microtasks that resolve after test teardown can trigger console methods outside the test boundary, causing false negatives or missed failures. Use afterEachDelay to allow async cleanup to complete before the plugin evaluates console state.
3. Overly Broad allowMessage Regex: Creating catch-all patterns like /error/i or /warn/ masks legitimate regressions. Keep allowlists narrowly scoped to specific known issues and document the rationale in code comments.
4. Enforcing shouldFailOnDebug/shouldFailOnInfo in CI: Third-party SDKs and framework internals frequently emit debug/info logs. Enabling these flags globally breaks CI with false positives. Stick to error/warn defaults unless your project enforces strict logging policies.
5. Permanent skipTest Usage: Using skipTest to bypass legacy test suites creates technical debt blind spots. Treat it as a migration bridge: gradually refactor skipped tests to handle console output properly, then remove the skip rule.
6. Missing setupFiles Registration: The plugin only intercepts console methods if initialized before tests run. Forgetting to register tests/setup.ts in vitest.config.ts results in silent failure. Verify the setup file path and execution order in CI pipelines.

Deliverables

• Blueprint: A phased integration guide for adopting vitest-fail-on-console in existing projects, including baseline noise assessment, gradual rule enforcement, and CI migration steps.
• Checklist: Pre-flight validation for test environment isolation, console interception verification, async timing configuration, and expected-call mocking patterns.
• Configuration Templates: Production-ready vitest.config.ts and tests/setup.ts snippets featuring common patterns: third-party allowlists, async delay tuning, legacy test isolation, and vi.spyOn assertion templates for error logging verification.