Added .../pure import for skipping auto cleanup

Author: mpeyper

docs/api-reference.md

@@ -137,5 +137,13 @@ module.exports = {
 }
 ```
 
-Alternatively, setting the `RHTL_SKIP_AUTO_CLEANUP` environment variable to `true` before importing
-`@testing-library/react-hooks` will also disable this feature.
+Alternatively, you can change your test to import from `@testing-library/react-hooks/pure` instead
+of the regular imports.
+
+```diff
+- import { renderHook, cleanup, act } from '@testing-library/react-hooks'
++ import { renderHook, cleanup, act } from '@testing-library/react-hooks/pure'
+```
+
+If neither of these approaches are suitable, setting the `RHTL_SKIP_AUTO_CLEANUP` environment
+variable to `true` before importing `@testing-library/react-hooks` will also disable this feature.

pure.js

@@ -0,0 +1,2 @@
+// makes it so people can import from '@testing-library/react-hooks/pure'
+module.exports = require('./lib/pure')

src/cleanup.js

@@ -16,11 +16,4 @@ function removeCleanup(callback) {
   cleanupCallbacks = cleanupCallbacks.filter((cb) => cb !== callback)
 }
 
-// Automatically registers cleanup in supported testing frameworks
-if (typeof afterEach === 'function' && !process.env.RHTL_SKIP_AUTO_CLEANUP) {
-  afterEach(async () => {
-    await cleanup()
-  })
-}
-
 export { cleanup, addCleanup, removeCleanup }

src/index.js

@@ -1,110 +1,10 @@
-import React, { Suspense } from 'react'
-import { act, create } from 'react-test-renderer'
-import { cleanup, addCleanup, removeCleanup } from './cleanup'
+import { cleanup } from './pure'
 
-function TestHook({ callback, hookProps, onError, children }) {
-  try {
-    children(callback(hookProps))
-  } catch (err) {
-    if (err.then) {
-      throw err
-    } else {
-      onError(err)
-    }
-  }
-  return null
-}
-
-function Fallback() {
-  return null
-}
-
-function resultContainer() {
-  let value = null
-  let error = null
-  const resolvers = []
-
-  const result = {
-    get current() {
-      if (error) {
-        throw error
-      }
-      return value
-    },
-    get error() {
-      return error
-    }
-  }
-
-  const updateResult = (val, err) => {
-    value = val
-    error = err
-    resolvers.splice(0, resolvers.length).forEach((resolve) => resolve())
-  }
-
-  return {
-    result,
-    addResolver: (resolver) => {
-      resolvers.push(resolver)
-    },
-    setValue: (val) => updateResult(val),
-    setError: (err) => updateResult(undefined, err)
-  }
-}
-
-function renderHook(callback, { initialProps, wrapper } = {}) {
-  const { result, setValue, setError, addResolver } = resultContainer()
-  const hookProps = { current: initialProps }
-
-  const wrapUiIfNeeded = (innerElement) =>
-    wrapper ? React.createElement(wrapper, null, innerElement) : innerElement
-
-  const toRender = () =>
-    wrapUiIfNeeded(
-      <Suspense fallback={<Fallback />}>
-        <TestHook callback={callback} hookProps={hookProps.current} onError={setError}>
-          {setValue}
-        </TestHook>
-      </Suspense>
-    )
-
-  let testRenderer
-  act(() => {
-    testRenderer = create(toRender())
+// Automatically registers cleanup in supported testing frameworks
+if (typeof afterEach === 'function' && !process.env.RHTL_SKIP_AUTO_CLEANUP) {
+  afterEach(async () => {
+    await cleanup()
   })
-  const { unmount, update } = testRenderer
-
-  function unmountHook() {
-    act(() => {
-      removeCleanup(unmountHook)
-      unmount()
-    })
-  }
-
-  addCleanup(unmountHook)
-
-  let waitingForNextUpdate = null
-  const resolveOnNextUpdate = (resolve) => {
-    addResolver((...args) => {
-      waitingForNextUpdate = null
-      resolve(...args)
-    })
-  }
-
-  return {
-    result,
-    waitForNextUpdate: () => {
-      waitingForNextUpdate = waitingForNextUpdate || act(() => new Promise(resolveOnNextUpdate))
-      return waitingForNextUpdate
-    },
-    rerender: (newProps = hookProps.current) => {
-      hookProps.current = newProps
-      act(() => {
-        update(toRender())
-      })
-    },
-    unmount: unmountHook
-  }
 }
 
-export { renderHook, cleanup, act }
+export * from './pure'

src/pure.js

@@ -0,0 +1,110 @@
+import React, { Suspense } from 'react'
+import { act, create } from 'react-test-renderer'
+import { cleanup, addCleanup, removeCleanup } from './cleanup'
+
+function TestHook({ callback, hookProps, onError, children }) {
+  try {
+    children(callback(hookProps))
+  } catch (err) {
+    if (err.then) {
+      throw err
+    } else {
+      onError(err)
+    }
+  }
+  return null
+}
+
+function Fallback() {
+  return null
+}
+
+function resultContainer() {
+  let value = null
+  let error = null
+  const resolvers = []
+
+  const result = {
+    get current() {
+      if (error) {
+        throw error
+      }
+      return value
+    },
+    get error() {
+      return error
+    }
+  }
+
+  const updateResult = (val, err) => {
+    value = val
+    error = err
+    resolvers.splice(0, resolvers.length).forEach((resolve) => resolve())
+  }
+
+  return {
+    result,
+    addResolver: (resolver) => {
+      resolvers.push(resolver)
+    },
+    setValue: (val) => updateResult(val),
+    setError: (err) => updateResult(undefined, err)
+  }
+}
+
+function renderHook(callback, { initialProps, wrapper } = {}) {
+  const { result, setValue, setError, addResolver } = resultContainer()
+  const hookProps = { current: initialProps }
+
+  const wrapUiIfNeeded = (innerElement) =>
+    wrapper ? React.createElement(wrapper, null, innerElement) : innerElement
+
+  const toRender = () =>
+    wrapUiIfNeeded(
+      <Suspense fallback={<Fallback />}>
+        <TestHook callback={callback} hookProps={hookProps.current} onError={setError}>
+          {setValue}
+        </TestHook>
+      </Suspense>
+    )
+
+  let testRenderer
+  act(() => {
+    testRenderer = create(toRender())
+  })
+  const { unmount, update } = testRenderer
+
+  function unmountHook() {
+    act(() => {
+      removeCleanup(unmountHook)
+      unmount()
+    })
+  }
+
+  addCleanup(unmountHook)
+
+  let waitingForNextUpdate = null
+  const resolveOnNextUpdate = (resolve) => {
+    addResolver((...args) => {
+      waitingForNextUpdate = null
+      resolve(...args)
+    })
+  }
+
+  return {
+    result,
+    waitForNextUpdate: () => {
+      waitingForNextUpdate = waitingForNextUpdate || act(() => new Promise(resolveOnNextUpdate))
+      return waitingForNextUpdate
+    },
+    rerender: (newProps = hookProps.current) => {
+      hookProps.current = newProps
+      act(() => {
+        update(toRender())
+      })
+    },
+    unmount: unmountHook
+  }
+}
+
+export { renderHook, cleanup, act }