chore(docs): Adds clearMocks to unit-testing #26802
Closed
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.
Description
Updates
unit-testing.md
to include theclearMocks
property injest.config.js
.The instructions in step #3 suggest setting up a globally mocked gatsby object in the
__mocks__
directory at the root of the project. However, if anyone were to utilize these mocks, such as mocking the return value in a test, the state of the mocks would persist between tests, leading to unexpected outcomes. This change attempts to address this by adding theclearMocks
configuration to the jest config so that developers following this tutorial will not need to manually reset the mocks on each test.Documentation
Jest clearMocks documentation
Related Issues
Issue #26795 - Mocking gatsby in mocks not cleaning up after tests