diff --git a/.all-contributorsrc b/.all-contributorsrc
index 53aaac86..46813049 100644
--- a/.all-contributorsrc
+++ b/.all-contributorsrc
@@ -111,6 +111,16 @@
"bug",
"code"
]
+ },
+ {
+ "login": "apostolidhs",
+ "name": "John Apostolidis",
+ "avatar_url": "https://avatars3.githubusercontent.com/u/2164902?v=4",
+ "profile": "http://apostolidis.me",
+ "contributions": [
+ "code",
+ "doc"
+ ]
}
],
"commitConvention": "none"
diff --git a/README.md b/README.md
index be2d6204..e942d2c0 100644
--- a/README.md
+++ b/README.md
@@ -27,7 +27,7 @@
[](http://www.npmtrends.com/@testing-library/react-hooks)
[](https://github.com/testing-library/react-hooks-testing-library/blob/master/LICENSE.md)
-[](#contributors)
+[](#contributors)
[](http://makeapullrequest.com)
[](https://github.com/testing-library/react-hooks-testing-library/blob/master/CODE_OF_CONDUCT.md)
[](https://app.netlify.com/sites/react-hooks-testing-library/deploys)
@@ -126,6 +126,17 @@ npm install --save-dev react-test-renderer@^x.y.z
Both of these dependecies must be installed as at least version `16.8.0` to be compatible with
`react-hooks-testing-library`.
+### `cleanup()`
+
+Unmounts any of the Hooks that were mounted with `renderHook`.
+
+Optionally, it is possible to import `cleanup` in a global test file. Using that way, it isn't
+necessary to run `afterEach(cleanup)` on every test script.
+
+```js
+import 'react-hooks-testing-library/cleanup-after-each'
+```
+
## Documentation
There are some [work-in-progress docs here](https://react-hooks-testing-library.com/). Please leave
@@ -143,7 +154,23 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
-
+
diff --git a/cleanup-after-each.js b/cleanup-after-each.js
new file mode 100644
index 00000000..bdf5f768
--- /dev/null
+++ b/cleanup-after-each.js
@@ -0,0 +1 @@
+afterEach(require('./src').cleanup)
diff --git a/src/index.js b/src/index.js
index 0245a6c3..dfffb221 100644
--- a/src/index.js
+++ b/src/index.js
@@ -1,6 +1,8 @@
import React, { Suspense } from 'react'
import { act, create } from 'react-test-renderer'
+const unmounts = []
+
function TestHook({ callback, hookProps, onError, children }) {
try {
children(callback(hookProps))
@@ -51,6 +53,11 @@ function resultContainer() {
}
}
+function cleanup() {
+ unmounts.forEach((unmount) => unmount())
+ unmounts.length = 0
+}
+
function renderHook(callback, { initialProps, wrapper } = {}) {
const { result, setValue, setError, addResolver } = resultContainer()
const hookProps = { current: initialProps }
@@ -73,6 +80,14 @@ function renderHook(callback, { initialProps, wrapper } = {}) {
})
const { unmount, update } = testRenderer
+ function unmountHook() {
+ act(() => {
+ unmount()
+ })
+ }
+
+ unmounts.push(unmountHook)
+
return {
result,
waitForNextUpdate: () => new Promise((resolve) => addResolver(resolve)),
@@ -82,12 +97,8 @@ function renderHook(callback, { initialProps, wrapper } = {}) {
update(toRender())
})
},
- unmount: () => {
- act(() => {
- unmount()
- })
- }
+ unmount: unmountHook
}
}
-export { renderHook, act }
+export { renderHook, cleanup, act }
diff --git a/test/cleanup.test.js b/test/cleanup.test.js
new file mode 100644
index 00000000..872b5585
--- /dev/null
+++ b/test/cleanup.test.js
@@ -0,0 +1,50 @@
+import { useEffect } from 'react'
+import { renderHook, cleanup } from 'src'
+
+describe('cleanup tests', () => {
+ let sideEffect = {}
+
+ function useEffectsCounter({ initialProps }) {
+ return renderHook(
+ ({ id }) => {
+ useEffect(() => {
+ sideEffect[id] = 0
+ return () => {
+ sideEffect[id] = sideEffect[id] + 1
+ }
+ }, [id])
+ },
+ { initialProps }
+ )
+ }
+
+ afterEach(() => (sideEffect = {}))
+
+ test('should unmount the tests', () => {
+ useEffectsCounter({ initialProps: { id: 1 } })
+ useEffectsCounter({ initialProps: { id: 10 } })
+ useEffectsCounter({ initialProps: { id: 100 } })
+
+ cleanup()
+
+ expect(sideEffect).toEqual({ 1: 1, 10: 1, 100: 1 })
+ })
+
+ test('should not cleanup a hook that have already unmounted', () => {
+ const { unmount } = useEffectsCounter({ initialProps: { id: 1 } })
+
+ unmount()
+ cleanup()
+
+ expect(sideEffect).toEqual({ 1: 1 })
+ })
+
+ test('should not unmount a hook that have already cleaned up', () => {
+ const { unmount } = useEffectsCounter({ initialProps: { id: 1 } })
+
+ cleanup()
+ unmount()
+
+ expect(sideEffect).toEqual({ 1: 1 })
+ })
+})
diff --git a/typings/index.d.ts b/typings/index.d.ts
index de113325..319e07d1 100644
--- a/typings/index.d.ts
+++ b/typings/index.d.ts
@@ -22,3 +22,5 @@ export function renderHook(
callback: (props: P) => R,
options?: RenderHookOptions
): RenderHookResult
+
+export function cleanup(): void
