Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: testing-library/react-hooks-testing-library
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: v7.0.2
Choose a base ref
...
head repository: testing-library/react-hooks-testing-library
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: v8.0.0
Choose a head ref
Loading
Showing with 55 additions and 19 deletions.
  1. +9 −0 .all-contributorsrc
  2. +1 −1 .github/workflows/validate.yml
  3. +15 −3 README.md
  4. +11 −0 docs/introduction.md
  5. +2 −2 docs/usage/ssr.md
  6. +17 −13 package.json
9 changes: 9 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -593,6 +593,15 @@
"contributions": [
"doc"
]
},
{
"login": "Laishuxin",
"name": "Laishuxin",
"avatar_url": "https://avatars.githubusercontent.com/u/56504759?v=4",
"profile": "https://github.com/Laishuxin",
"contributions": [
"doc"
]
}
],
"skipCi": true,
2 changes: 1 addition & 1 deletion .github/workflows/validate.yml
Original file line number Diff line number Diff line change
@@ -45,7 +45,7 @@ jobs:
run: npm run validate

- name: ⬆️ Upload coverage report
uses: codecov/codecov-action@v2.0.3
uses: codecov/codecov-action@v2.1.0

release:
needs: main
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -37,6 +37,17 @@
[![Tweet](https://img.shields.io/twitter/url/https/github.com/testing-library/react-hooks-testing-library.svg?style=social)](https://twitter.com/intent/tweet?text=Check%20out%20react-hooks-testing-library%20by%20%40testing-library%20https%3A%2F%2Fgithub.com%2Ftesting-library%2Freact-hooks-testing-library%20%F0%9F%91%8D)
<!-- prettier-ignore-end -->

## A Note about React 18 Support

As part of the changes for React 18, it has been decided that the `renderHook` API provided by this
library will instead be included as official additions to both `react-testing-library`
([PR](https://github.com/testing-library/react-testing-library/pull/991)) and
`react-native-testing-library`
([PR](https://github.com/callstack/react-native-testing-library/pull/923)) with the intention being
to provide a more cohesive and consistent implementation for our users.

Please be patient as we finalise these changes in the respective testing libraries.

## Table of Contents

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
@@ -146,9 +157,9 @@ to test against. It also does not come installed with a specific renderer, we cu
[`react-test-renderer`](https://www.npmjs.com/package/react-test-renderer) and
[`react-dom`](https://www.npmjs.com/package/react-dom). You only need to install one of them,
however, if you do have both installed, we will use `react-test-renderer` as the default. For more
information see the [installation docs](https://react-hooks-testing-library.com/#installation).
Generally, the installed versions for `react` and the selected renderer should have matching
versions:
information see the
[installation docs](https://react-hooks-testing-library.com/installation#renderer). Generally, the
installed versions for `react` and the selected renderer should have matching versions:

```sh
npm install react@^16.9.0
@@ -249,6 +260,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
<td align="center"><a href="https://github.com/snowystinger"><img src="https://avatars.githubusercontent.com/u/698229?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Robert Snow</b></sub></a><br /><a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=snowystinger" title="Tests">⚠️</a></td>
<td align="center"><a href="https://github.com/chris110408"><img src="https://avatars.githubusercontent.com/u/10645051?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Chris Chen</b></sub></a><br /><a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=chris110408" title="Tests">⚠️</a></td>
<td align="center"><a href="https://www.facebook.com/masoud.bonabi"><img src="https://avatars.githubusercontent.com/u/6429009?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Masious</b></sub></a><br /><a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=masious" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/Laishuxin"><img src="https://avatars.githubusercontent.com/u/56504759?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Laishuxin</b></sub></a><br /><a href="https://github.com/testing-library/react-hooks-testing-library/commits?author=Laishuxin" title="Documentation">📖</a></td>
</tr>
</table>

11 changes: 11 additions & 0 deletions docs/introduction.md
Original file line number Diff line number Diff line change
@@ -23,6 +23,17 @@ route: '/'

<hr />

## A Note about React 18 Support

As part of the changes for React 18, it has been decided that the `renderHook` API provided by this
library will instead be included as official additions to both `react-testing-library`
([PR](https://github.com/testing-library/react-testing-library/pull/991)) and
`react-native-testing-library`
([PR](https://github.com/callstack/react-native-testing-library/pull/923)) with the intention being
to provide a more cohesive and consistent implementation for our users.

Please be patient as we finalise these changes in the respective testing libraries.

## The problem

You're writing an awesome custom hook and you want to test it, but as soon as you call it you see
4 changes: 2 additions & 2 deletions docs/usage/ssr.md
Original file line number Diff line number Diff line change
@@ -46,7 +46,7 @@ import { renderHook, act } from '@testing-library/react-hooks/server'
import useCounter from './useCounter'

test('should increment counter', () => {
const { result } = renderHook(() => useCounter(0))
const { result } = renderHook(() => useCounter())

act(() => {
result.current.increment()
@@ -64,7 +64,7 @@ import { renderHook, act } from '@testing-library/react-hooks/server'
import useCounter from './useCounter'

test('should increment counter', () => {
const { result, hydrate } = renderHook(() => useCounter(0))
const { result, hydrate } = renderHook(() => useCounter())

hydrate()

30 changes: 17 additions & 13 deletions package.json
Original file line number Diff line number Diff line change
@@ -50,36 +50,40 @@
},
"dependencies": {
"@babel/runtime": "^7.12.5",
"@types/react": ">=16.9.0",
"@types/react-dom": ">=16.9.0",
"@types/react-test-renderer": ">=16.9.0",
"react-error-boundary": "^3.1.0"
},
"devDependencies": {
"@typescript-eslint/eslint-plugin": "4.30.0",
"@typescript-eslint/parser": "4.30.0",
"@types/react": "17.0.44",
"@types/react-dom": "17.0.15",
"@types/react-test-renderer": "17.0.1",
"@typescript-eslint/eslint-plugin": "5.11.0",
"@typescript-eslint/parser": "5.11.0",
"all-contributors-cli": "6.20.0",
"codecov": "3.8.3",
"cross-env": "^7.0.3",
"cross-env": "7.0.3",
"docz": "2.3.1",
"docz-theme-default": "1.2.0",
"docz-utils": "2.3.0",
"eslint": "7.32.0",
"get-pkg-repo": "4.1.1",
"kcd-scripts": "11.2.0",
"prettier": "2.3.2",
"kcd-scripts": "11.2.2",
"prettier": "2.5.1",
"react": "17.0.2",
"react-dom": "17.0.2",
"react-test-renderer": "17.0.2",
"ts-node": "10.2.1",
"typescript": "4.4.2"
"ts-node": "10.5.0",
"typescript": "4.5.5"
},
"peerDependencies": {
"react": ">=16.9.0",
"react-dom": ">=16.9.0",
"react-test-renderer": ">=16.9.0"
"@types/react": "^16.9.0 || ^17.0.0",
"react": "^16.9.0 || ^17.0.0",
"react-dom": "^16.9.0 || ^17.0.0",
"react-test-renderer": "^16.9.0 || ^17.0.0"
},
"peerDependenciesMeta": {
"@types/react": {
"optional": true
},
"react-dom": {
"optional": true
},