Fixes bug #13222

[brunocabral88]

Summary

This PR is supposed to fix bug #13222 (--filter option not working as per documentation suggests)

Currently, the --filter option expected an object with shape { filtered: { test: Array<string> } }, even though the documentation suggests it expects { filtered: Array<string> }, so this commit fixes this inconsistency by making the code behave as the documentation suggests.
Please note this may be a breaking change for users using this feature as the expected output object shape changed.

Test plan

Create a filter.js file, which exports a function as per the --filter documentation, then use it with jest --filter=filter.js and see if jest properly filtered the test files as it should.

Also, a unit test has been added to packages/jest-core/src/__tests__/SearchSource.test.ts.

[mrazauskas]

Good to see a PR to fix this issue.

Keep I mind that merging it as suggested would introduce a breaking change for the current users. This can only happen with the next major release, which is months away. It is a good idea to simply the API, but this will take time.

I would say, at the moment a better idea would be to edit the documentation so that it would reflect the actual behaviour.

[brunocabral88]

@mrazauskas yeah, I believe this PR should go in the next major (I can create another one for adjusting the docs).
Should I just leave this one here to be picked up for the next major? First time contributing here so not sure..

[SimenB]

Thanks for the PR! However, I think it makes more sense to align the docs with the implementation than the other way around, like you discuss.

Should I just leave this one here to be picked up for the next major?

Yep, I'll add it to a milestone 🙂

[brunocabral88]

Thanks for adding it to the milestone @SimenB :)
As suggested, I've created another PR to update the docs accordingly.

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: brunocabral88 / name: Bruno Farias (1a864f2, 2f4ee48, a75ba48, c45193c)
• ✅ login: SimenB / name: Simen Bekkhus (f8a70c7, 3e25b21, 6b8741b, e32d042)

[netlify]

✅ Deploy Preview for jestjs ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	e32d042
🔍 Latest deploy log	https://app.netlify.com/sites/jestjs/deploys/6555ecce294c4100089bc921
😎 Deploy Preview	https://deploy-preview-13319--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.

[SimenB]

I've resolved the conflicts 🙂

can you update the docs to be reference being a string again, and add a changelog entry?

[brunocabral88]

Done @SimenB. If any other change is needed, just let me know. 😃

[legobeat]

lint:fix should show how to satisfy prettier

[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.