BREAKING CHANGE: Move testHook to its own pacakge

README.md

@@ -55,6 +55,7 @@ practices.</p>
 - [Example](#example)
 - [Installation](#installation)
 - [Examples](#examples)
+- [Hooks](#hooks)
 - [Other Solutions](#other-solutions)
 - [Guiding Principles](#guiding-principles)
 - [Contributors](#contributors)
@@ -162,12 +163,15 @@ Some included are:
 - [`react-redux`](https://github.com/kentcdodds/react-testing-library/blob/master/examples/__tests__/react-redux.js)
 - [`react-router`](https://github.com/kentcdodds/react-testing-library/blob/master/examples/__tests__/react-router.js)
 - [`react-context`](https://github.com/kentcdodds/react-testing-library/blob/master/examples/__tests__/react-context.js)
-- [`react-hooks`](https://github.com/kentcdodds/react-testing-library/blob/master/examples/__tests__/react-hooks.js) -
-  Use react-testing-library to test a custom React Hook.
 
 You can also find react-testing-library examples at
 [react-testing-examples.com](https://react-testing-examples.com/jest-rtl/).
 
+## Hooks
+
+If you are interested in testing a custom hook, check out
+[react-hooks-testing-library][react-hooks-testing-library]
+
 ## Other Solutions
 
 In preparing this project,
@@ -296,5 +300,6 @@ Links:
 [good-first-issue]: https://github.com/kentcdodds/react-testing-library/issues?utf8=✓&q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3A"good+first+issue"+
 [reactiflux]: https://www.reactiflux.com/
 [stackoverflow]: https://stackoverflow.com/questions/tagged/react-testing-library
+[react-hooks-testing-library]: https://github.com/mpeyper/react-hooks-testing-library
 
 <!-- prettier-ignore-end -->

src/index.js

@@ -31,7 +31,6 @@ function render(
   // they're passing us a custom container or not.
   mountedContainers.add(container)
 
-
   const wrapUiIfNeeded = innerElement =>
     WrapperComponent
       ? React.createElement(WrapperComponent, null, innerElement)
@@ -72,33 +71,6 @@ function render(
   }
 }
 
-function TestHook({callback, children}) {
-  children(callback())
-  return null
-}
-
-function testHook(callback, options = {}) {
-  const result = {
-    current: null,
-  }
-  const toRender = () => (
-    <TestHook callback={callback}>
-      {res => {
-        result.current = res
-      }}
-    </TestHook>
-  )
-
-  const {unmount, rerender: rerenderComponent} = render(toRender(), options)
-  return {
-    result,
-    unmount,
-    rerender: () => {
-      rerenderComponent(toRender(), options)
-    },
-  }
-}
-
 function cleanup() {
   mountedContainers.forEach(cleanupAtContainer)
 }
@@ -159,6 +131,6 @@ fireEvent.select = (node, init) => {
 
 // just re-export everything from dom-testing-library
 export * from 'dom-testing-library'
-export {render, testHook, cleanup, fireEvent, act}
+export {render, cleanup, fireEvent, act}
 
 /* eslint func-name-matching:0 */

typings/index.d.ts

@@ -19,12 +19,6 @@ export type RenderResult<Q extends Queries = typeof queries> = {
   asFragment: () => DocumentFragment
 } & {[P in keyof Q]: BoundFunction<Q[P]>}
 
-export type HookResult<TResult> = {
-  result: React.MutableRefObject<TResult>
-  rerender: () => void
-  unmount: () => boolean
-}
-
 export interface RenderOptions<Q extends Queries = typeof queries> {
   container?: HTMLElement
   baseElement?: HTMLElement
@@ -33,8 +27,6 @@ export interface RenderOptions<Q extends Queries = typeof queries> {
   wrapper?: React.ComponentType
 }
 
-export type HookOptions = RenderOptions
-
 type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>
 
 /**
@@ -49,14 +41,6 @@ export function render<Q extends Queries>(
   options: RenderOptions<Q>,
 ): RenderResult<Q>
 
-/**
- * Renders a test component that calls back to the test.
- */
-export function testHook<T>(
-  callback: () => T,
-  options?: Partial<HookOptions>,
-): HookResult<T>
-
 /**
  * Unmounts React trees that were mounted with render.
  */