feat(console): export helper to manually suppress error output

Fixes #564

Author: mpeyper

src/core/console.ts

@@ -1,28 +1,32 @@
 import filterConsole from 'filter-console'
 
+function suppressErrorOutput() {
+  if (process.env.RHTL_DISABLE_ERROR_FILTERING) {
+    return () => {}
+  }
+
+  return filterConsole(
+    [
+      /^The above error occurred in the <TestComponent> component:/, // error boundary output
+      /^Error: Uncaught .+/ // jsdom output
+    ],
+    {
+      methods: ['error']
+    }
+  )
+}
+
 function enableErrorOutputSuppression() {
   // Automatically registers console error suppression and restoration in supported testing frameworks
-  if (
-    typeof beforeEach === 'function' &&
-    typeof afterEach === 'function' &&
-    !process.env.RHTL_DISABLE_ERROR_FILTERING
-  ) {
-    let restoreConsole: () => void
+  if (typeof beforeEach === 'function' && typeof afterEach === 'function') {
+    let restoreConsole!: () => void
 
     beforeEach(() => {
-      restoreConsole = filterConsole(
-        [
-          /^The above error occurred in the <TestComponent> component:/, // error boundary output
-          /^Error: Uncaught .+/ // jsdom output
-        ],
-        {
-          methods: ['error']
-        }
-      )
+      restoreConsole = suppressErrorOutput()
     })
 
-    afterEach(() => restoreConsole?.())
+    afterEach(() => restoreConsole())
   }
 }
 
-export { enableErrorOutputSuppression }
+export { enableErrorOutputSuppression, suppressErrorOutput }

src/core/index.ts

@@ -2,6 +2,7 @@ import { CreateRenderer, Renderer, RenderResult, RenderHookOptions } from '../ty
 
 import { asyncUtils } from './asyncUtils'
 import { cleanup, addCleanup, removeCleanup } from './cleanup'
+import { suppressErrorOutput } from './console'
 
 function resultContainer<TValue>() {
   const results: Array<{ value?: TValue; error?: Error }> = []
@@ -81,4 +82,4 @@ function createRenderHook<
   return renderHook
 }
 
-export { createRenderHook, cleanup, addCleanup, removeCleanup }
+export { createRenderHook, cleanup, addCleanup, removeCleanup, suppressErrorOutput }

src/dom/__tests__/errorSuppression.disabled.test.ts

@@ -5,10 +5,10 @@ describe('error output suppression (disabled) tests', () => {
 
   beforeAll(() => {
     process.env.RHTL_DISABLE_ERROR_FILTERING = 'true'
+    require('..')
   })
 
   test('should not patch console.error', () => {
-    require('..')
     expect(console.error).toBe(originalConsoleError)
   })
 })

src/dom/pure.ts

@@ -37,6 +37,6 @@ const renderHook = createRenderHook(createDomRenderer)
 
 export { renderHook, act }
 
-export { cleanup, addCleanup, removeCleanup } from '../core'
+export { cleanup, addCleanup, removeCleanup, suppressErrorOutput } from '../core'
 
 export * from '../types/react'

src/native/pure.ts

@@ -36,6 +36,6 @@ const renderHook = createRenderHook(createNativeRenderer)
 
 export { renderHook, act }
 
-export { cleanup, addCleanup, removeCleanup } from '../core'
+export { cleanup, addCleanup, removeCleanup, suppressErrorOutput } from '../core'
 
 export * from '../types/react'

src/pure.ts

@@ -32,8 +32,8 @@ function getRenderer() {
   }
 }
 
-const { renderHook, act, cleanup, addCleanup, removeCleanup } = getRenderer()
+const { renderHook, act, cleanup, addCleanup, removeCleanup, suppressErrorOutput } = getRenderer()
 
-export { renderHook, act, cleanup, addCleanup, removeCleanup }
+export { renderHook, act, cleanup, addCleanup, removeCleanup, suppressErrorOutput }
 
 export * from './types/react'

src/server/pure.ts

@@ -61,6 +61,6 @@ const renderHook = createRenderHook(createServerRenderer)
 
 export { renderHook, act }
 
-export { cleanup, addCleanup, removeCleanup } from '../core'
+export { cleanup, addCleanup, removeCleanup, suppressErrorOutput } from '../core'
 
 export * from '../types/react'

src/types/react.ts

@@ -26,6 +26,7 @@ export type ReactHooksRenderer = {
   cleanup: () => void
   addCleanup: (callback: CleanupCallback) => () => void
   removeCleanup: (callback: CleanupCallback) => void
+  suppressErrorOutput: () => void
 }
 
 export * from '.'