docs: add a note on when not to use renderHook #1093
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MatanBobi
reviewed
May 11, 2023
| libraries publishing hooks. You should prefer `render` since a custom test | ||
| libraries publishing hooks. | ||
|
|
||
| Do not use `renderHook` when your hook is easy to test by just testing the components using it. |
There was a problem hiding this comment.
Suggested change
| Do not use `renderHook` when your hook is easy to test by just testing the components using it. | |
| Do not use `renderHook` when your hook can be easily tested by testing the components using it. |
There was a problem hiding this comment.
Thanks @zaicevas!
A minor suggestion here.
MatanBobi
reviewed
May 11, 2023
| libraries publishing hooks. | ||
|
|
||
| Do not use `renderHook` when your hook is easy to test by just testing the components using it. | ||
| Alternatively, you should prefer `render` since a custom test |
There was a problem hiding this comment.
Is "alternatively" really needed here? I think we can remove it :)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In https://github.com/testing-library/react-hooks-testing-library/blob/main/README.md there are two reasons when not to use react-hooks-testing-library:
I think it still holds true and it would make sense to add this into
renderHookdocs. I've omitted the first point because it seems like the second point covers it. We could add both, though.