Documentation: guide for using jest.mock

[sargalias]

🚀 Feature Proposal

A guide on basic mocking with jest using jest.mock. The guide would be on the sidebar after "Timer mocks".

It would explain how to use jest.mock properly, what the different parameters do and provide examples for using them.

Motivation

When I was a beginner I didn't understand how to use jest.mockat all, particularly the second parameter of jest.mock. This was even more fiddly because I use ES6 modules, giving the default export another "gotcha" when used in tests.

As this is quite an essential feature for unit testing I think a guide will be beneficial to many users.

Please let me know your thoughts. If it sounds good I can make a PR.

[jeysal]

Hey @sargalias, thanks for your suggestion. This sounds a lot like the "Manual Mocks" guide, maybe it would make sense to extend that guide - I agree that more info on the signature of jest.mock and on default exports would be great!

[sargalias]

Hey @jeysal, that sounds like a good idea. I'll whip something up.

[sargalias]

Hi @jeysal, based on our conversation in #8544 I think it might be a better idea to proceed differently.

As a recap, in #8544 it was suggested that it's fine for potentially missing information to be added to the API docs, but the guides should ideally only show best practices.

If we consider manual mocks to be the preferred practice, then it may be better to add an example to the API docs for jest.mock factory instead. It would show how to use it with ES6 modules and it would be short.

Please let me know if that sounds good. I'm happy to create a PR.

[jeysal]

The second jest.mock argument and mocking default exports don't seem like bad practices though :)
I think both the guide and the API docs are legitimate places to add the information, fine with either or both 😄

[sargalias]

Sounds good, thanks :). I've opened a small PR with just the addition to the jest.mock API docs for now. I wasn't too sure where to place a "Mocking without manual mocks" section in the "Manual Mocks" page 😅. #8550

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.