feat(CLI): --maxRelatedTestsDepth flag to control the depth of related test in --findRelatedTests

[lewibs]

Summary

The company that I work for, has a test suite which is very slow to run. This is because of poorly structured code and long dependency trees. The developer time which is wasted as developers are waiting is approximately $200,000-$300,000 per year and often times, developers end up committing the code without testing it due to how long it takes. I have asked around and seen that this is often a problem that companies have and so know that many would appreciate the time savings that this would provide.

This PR adds the optional --maxRelatedTestsDepth flag to the cli so that, when running jest with --findRelatedTests, the user has the ability to limit the depth of the BFS that is occurring. This is so that, for the local tests, we can limit testing to only the nearby files and stop testing once the dependency tree is deep enough that we are confident it no longer is related.

Test plan

See findRelatedFiles.test.ts to see the tests that were created to validate that this code works as intended.
Path: e2e/tests/findRelatedFiles.test.ts

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: lewibs (da5401a, 8bd6088, 6cdabbf, d9a942e, 70f26ad, 75155c9, 330f88a, 0eae97d, 787ac67, 166d2e3, c81e69a)

[netlify]

✅ Deploy Preview for jestjs ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	0eae97d
🔍 Latest deploy log	https://app.netlify.com/sites/jestjs/deploys/67bf365602667a00081295b7
😎 Deploy Preview	https://deploy-preview-15495--jestjs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[lewibs]

@SimenB Just want to check if this is something that Jest is interested in before putting in more effort to make sure the tests pass.

[cpojer]

I don't think we should add this to Jest. There are many ways to fix issues in your usage of Jest without having to add an option that only your company will be using. I'm happy to help your company save lots of money, reach out at https://nkzw.tech.

[github-actions]

This pull request 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.