Declare matchers for use with expect.not.MATCHER (#385)

[dharkness]

What

Move asymmetric matcher declarations to a new AsymmetricMatchers interface and extend that to add matchers to Expect and InverseAsymmetricMatchers.

Why

This provides autocompletion when using expect.not, for example:

const value = {
  name: 'foobar',
};
expect(value).toEqual({
  name: expect.not.toStartWith('bar')
});

Notes

This may not play nicely with actual TypeScript projects, but I do not have experience with that to verify. I didn't add any unit tests since I didn't change any code. TypeScript tests would be very useful for the project as a whole.

Housekeeping

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

[codecov]

Codecov Report

Merging #386 (2a4ac3a) into main (9d5d236) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##              main      #386   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           71        71           
  Lines          582       582           
  Branches       148       148           
=========================================
  Hits           582       582           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update be7bc8e...2a4ac3a. Read the comment docs.

[rluvaton]

Hey, is there anything blocking here that I can help with? this issue affects me too :)

[keeganwitt]

To give me a little more context on this, what autocompletion was this helping enable? With TypeScript projects in In VS Code?

[rluvaton]

not related to vs code but typescript not compiling as he thinks these matchers can't be negated using .not.*

[keeganwitt]

I believe the reason this is happening is because of https://github.com/DefinitelyTyped/DefinitelyTyped/blob/658b4ded756f0c98e1a22e9592014c3c6bc4323a/types/jest/index.d.ts#L729.

[keeganwitt]

I don't think it's necessary to define this interface, because it's not one that is defined in @types/jest. The AsymmetricMatchers interface that is defined within Jest's native types of Expect, JestExpect, and Jasmine. It is not referenced within any interface itself.

[SimenB]

https://github.com/jest-community/jest-extended/releases/tag/v3.0.2