Current setup instructions for Vitest don't work for asymmetric matchers' typings about jest-extended HOT 9 CLOSED

I added these instructions in #610, but I'm not a Vitest user and wasn't sure they were complete, so thank you for chiming in about where they need more work. Thank you also for the reproduction examples! It really helps someone like me that's kinda stumbling my way through Vitest stuff. I will take a look this weekend and see what I can come up with.

from jest-extended.

PR to allow declaration merging: #653

from jest-extended.

@keeganwitt That worked for me!

Here's the updated stackblitz that shows it working: https://stackblitz.com/edit/vitest-dev-vitest-whsqfe?file=test%2Fextended.test.ts

import 'jest-extended';
import 'vitest';

interface MyCustomMatchers {
  toBeFoo(): any;
}
declare module 'vitest' {
  interface Assertion<T = any> extends CustomMatchers<T>, MyCustomMatchers {}
  interface AsymmetricMatchersContaining<T = any>
    extends CustomMatchers<T>,
      MyCustomMatchers {}
  interface ExpectStatic extends CustomMatchers, MyCustomMatchers {}
}

from jest-extended.

Related issue I've just submitted: #652

I think the issue is that the CustomMatcher interface is not exported.

from jest-extended.

@acidoxee I was able to get this working without the above PR.

Here is your updated reproduction. https://stackblitz.com/edit/vitest-dev-vitest-whsqfe?file=jest-extended.d.ts

Here's the jest-extended.d.ts file I'm currently using

import "jest-extended";
import "vitest";

declare module "vitest" {
  interface Assertion<T = any> extends CustomMatchers<T> {}
  interface AsymmetricMatchersContaining<T = any> extends CustomMatchers<T> {}
  interface ExpectStatic extends CustomMatchers {}
}

from jest-extended.

@keeganwitt Here's vitest's docs if they are useful, though I get errors following those steps.

from jest-extended.

That's a good start @cdierkens, thanks! Although I can't seem to make this work as soon as I add my own custom matchers (following the docs you've linked, which is exactly what I had followed on my own). This was kinda always the problem: the setup for my own matchers (exclusively) works perfectly, and so does the setup you're suggesting with only jest-extended's matchers. But how to make it work with both? I have a toMatchJSON and a toBeUUID custom matchers, for which I need to define types, and add jest-extended's ones also. That, I couldn't figure out for now.

from jest-extended.

That's a good start @cdierkens, thanks! Although I can't seem to make this work as soon as I add my own custom matchers (following the docs you've linked, which is exactly what I had followed on my own). This was kinda always the problem: the setup for my own matchers (exclusively) works perfectly, and so does the setup you're suggesting with only jest-extended's matchers. But how to make it work with both? I have a toMatchJSON and a toBeUUID custom matchers, for which I need to define types, and add jest-extended's ones also. That, I couldn't figure out for now.

Would it work to define an interface for your custom matchers and extend that interface in addition to jest-extended's? Shooting a bit from the hip here, since I don't have a test project with this setup.

from jest-extended.

OK yeah this time it seems to work nicely, well done @keeganwitt @cdierkens 👏 thanks a bunch for the help!

from jest-extended.