renamed testHook to renderHook with testHook deprecation warning

Author: mpeyper

src/index.js

@@ -6,7 +6,7 @@ function TestHook({ callback, hookProps, children }) {
   return null
 }
 
-function testHook(callback, options = {}) {
+function renderHook(callback, options = {}) {
   const result = { current: null }
   const hookProps = { current: options.initialProps }
 
@@ -34,4 +34,11 @@ function testHook(callback, options = {}) {
   }
 }
 
-export { testHook, cleanup, act }
+function testHook(...args) {
+  console.warn(
+    '`testHook` has been deprecated and will be removed in a future release.  Please use `renderHook` instead.'
+  )
+  return renderHook(...args)
+}
+
+export { renderHook, cleanup, act, testHook }

test/customHook.test.js

@@ -1,6 +1,6 @@
 import React from 'react'
 import { useState, createContext, useContext, useMemo } from 'react'
-import { testHook, cleanup, act } from 'src'
+import { renderHook, cleanup, act } from 'src'
 
 describe('custom hook tests', () => {
   const themes = {
@@ -22,7 +22,7 @@ describe('custom hook tests', () => {
   afterEach(cleanup)
 
   test('should use theme', () => {
-    const { result } = testHook(() => useTheme('light'))
+    const { result } = renderHook(() => useTheme('light'))
 
     const theme = result.current
 
@@ -31,7 +31,7 @@ describe('custom hook tests', () => {
   })
 
   test('should update theme', () => {
-    const { result } = testHook(() => useTheme('light'))
+    const { result } = renderHook(() => useTheme('light'))
 
     const { toggleTheme } = result.current
 
@@ -53,7 +53,7 @@ describe('custom hook tests', () => {
       <ThemesContext.Provider value={customThemes}>{children}</ThemesContext.Provider>
     )
 
-    const { result } = testHook(() => useTheme('light'), { wrapper })
+    const { result } = renderHook(() => useTheme('light'), { wrapper })
 
     const theme = result.current
 

test/useContext.test.js

@@ -1,14 +1,14 @@
 import React from 'react'
 import { createContext, useContext } from 'react'
-import { testHook, cleanup } from 'src'
+import { renderHook, cleanup } from 'src'
 
 describe('useContext tests', () => {
   afterEach(cleanup)
 
   test('should get default value from context', () => {
     const TestContext = createContext('foo')
 
-    const { result } = testHook(() => useContext(TestContext))
+    const { result } = renderHook(() => useContext(TestContext))
 
     const value = result.current
 
@@ -18,7 +18,7 @@ describe('useContext tests', () => {
   test('should get default value from context provider', () => {
     const TestContext = createContext('foo')
 
-    const { result } = testHook(() => useContext(TestContext))
+    const { result } = renderHook(() => useContext(TestContext))
 
     const value = result.current
 
@@ -32,7 +32,7 @@ describe('useContext tests', () => {
       <TestContext.Provider value="bar">{children}</TestContext.Provider>
     )
 
-    const { result } = testHook(() => useContext(TestContext), { wrapper })
+    const { result } = renderHook(() => useContext(TestContext), { wrapper })
 
     const value = result.current
 
@@ -46,7 +46,7 @@ describe('useContext tests', () => {
       <TestContext.Provider value="bar">{children}</TestContext.Provider>
     )
 
-    const { result } = testHook(() => useContext(TestContext), { wrapper })
+    const { result } = renderHook(() => useContext(TestContext), { wrapper })
 
     expect(result.current).toBe('bar')
   })
@@ -60,7 +60,7 @@ describe('useContext tests', () => {
       <TestContext.Provider value={value.current}>{children}</TestContext.Provider>
     )
 
-    const { result, rerender } = testHook(() => useContext(TestContext), { wrapper })
+    const { result, rerender } = renderHook(() => useContext(TestContext), { wrapper })
 
     value.current = 'baz'
 

test/useEffect.test.js

@@ -1,13 +1,13 @@
 import { useEffect, useLayoutEffect } from 'react'
-import { testHook, cleanup } from 'src'
+import { renderHook, cleanup } from 'src'
 
 describe('useEffect tests', () => {
   afterEach(cleanup)
 
   test('should handle useEffect hook', () => {
     const sideEffect = { [1]: false, [2]: false }
 
-    const { rerender, unmount } = testHook(
+    const { rerender, unmount } = renderHook(
       ({ id }) => {
         useEffect(() => {
           sideEffect[id] = true
@@ -36,9 +36,9 @@ describe('useEffect tests', () => {
   test('should handle useLayoutEffect hook', () => {
     const sideEffect = { [1]: false, [2]: false }
 
-    const { rerender, unmount } = testHook(
+    const { rerender, unmount } = renderHook(
       ({ id }) => {
-        useEffect(() => {
+        useLayoutEffect(() => {
           sideEffect[id] = true
           return () => {
             sideEffect[id] = false

test/useMemo.test.js

@@ -1,11 +1,11 @@
 import { useMemo, useCallback } from 'react'
-import { testHook, cleanup } from 'src'
+import { renderHook, cleanup } from 'src'
 
 describe('useCallback tests', () => {
   afterEach(cleanup)
 
   test('should handle useMemo hook', () => {
-    const { result, rerender } = testHook(({ value }) => useMemo(() => ({ value }), [value]), {
+    const { result, rerender } = renderHook(({ value }) => useMemo(() => ({ value }), [value]), {
       initialProps: { value: 1 }
     })
 
@@ -31,7 +31,7 @@ describe('useCallback tests', () => {
   })
 
   test('should handle useCallback hook', () => {
-    const { result, rerender } = testHook(
+    const { result, rerender } = renderHook(
       ({ value }) => {
         const callback = () => ({ value })
         return useCallback(callback, [value])

test/useReducer.test.js

@@ -1,12 +1,12 @@
 import { useReducer } from 'react'
-import { testHook, cleanup, act } from 'src'
+import { renderHook, cleanup, act } from 'src'
 
 describe('useReducer tests', () => {
   afterEach(cleanup)
 
   test('should handle useReducer hook', () => {
     const reducer = (state, action) => (action.type === 'inc' ? state + 1 : state)
-    const { result } = testHook(() => useReducer(reducer, 0))
+    const { result } = renderHook(() => useReducer(reducer, 0))
 
     const [initialState, dispatch] = result.current
 

test/useRef.test.js

@@ -1,11 +1,11 @@
 import { useRef, useImperativeHandle } from 'react'
-import { testHook, cleanup } from 'src'
+import { renderHook, cleanup } from 'src'
 
 describe('useHook tests', () => {
   afterEach(cleanup)
 
   test('should handle useRef hook', () => {
-    const { result } = testHook(() => useRef())
+    const { result } = renderHook(() => useRef())
 
     const refContainer = result.current
 
@@ -14,7 +14,7 @@ describe('useHook tests', () => {
   })
 
   test('should handle useImperativeHandle hook', () => {
-    const { result } = testHook(() => {
+    const { result } = renderHook(() => {
       const ref = useRef()
       useImperativeHandle(ref, () => ({
         fakeImperativeMethod: () => true

test/useState.test.js

@@ -1,19 +1,19 @@
 import { useState } from 'react'
-import { testHook, cleanup, act } from 'src'
+import { renderHook, cleanup, act } from 'src'
 
 describe('useState tests', () => {
   afterEach(cleanup)
 
   test('should use setState value', () => {
-    const { result } = testHook(() => useState('foo'))
+    const { result } = renderHook(() => useState('foo'))
 
     const [value] = result.current
 
     expect(value).toBe('foo')
   })
 
   test('should update setState value using setter', () => {
-    const { result } = testHook(() => useState('foo'))
+    const { result } = renderHook(() => useState('foo'))
 
     const [_, setValue] = result.current