Add more data to promise matchers

[harelmo]

What

When using toReject / toResolve, print more detailed failure reason (e.g. when toResolve gets a rejected promise, the rejection value will be printed for easier troubleshooting (as discussed in #322 and #218)

Why

Often when refactoring code tested using toResolve or toReject, the test fails but it's unclear on why since the resolved or rejection values are not displayed as a part of the test-failure outout.
This PR adds:

1. The rejection value when toResolve receives a rejected promise
2. The resolved value when .not.toResolve receives a resolved promise
3. The resolved value when toReject receives a resolved promise
4. The reject value when .not.toReject receives a rejected promise.

Notes

This does not change the beahvior of toResolve or toReject in any way, but only adds extra info on falitures.

Housekeeping

• Unit tests
• Documentation is up to date
• No additional lint warnings
• Typescript definitions are added/updated where relevant

[harelmo]

I'm not sure why did the coverage drop, the message helpers I've added are still tested by the existing tests... can anyone assist please?

[harelmo]

@SimenB any chance you can take a look? 🙏 I'd really appreciate it

[SimenB]

@harelmo I like these changes! could you rebase and fix CI?

[changeset-bot]

⚠️ No Changeset found

Latest commit: 0ed0bf9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[keeganwitt]

Merged main into this branch and updated the snapshots. It's now failing for coverage reasons.