fix: Fix It docstrings

Hovering over any matcher under `It` should now show its docstring.

Author: NiGhTTraX

src/errors/unexpected-call.spec.ts

@@ -3,8 +3,8 @@ import {
   expectAnsilessEqual,
 } from '../../tests/ansiless';
 import { StrongExpectation } from '../expectation/strong-expectation';
+import { matches } from '../matchers/matcher';
 
-import { It } from '../matchers/it';
 import { printArgsDiff, UnexpectedCall } from './unexpected-call';
 
 describe('UnexpectedCall', () => {
@@ -19,7 +19,7 @@ describe('UnexpectedCall', () => {
     });
 
     it('should print the diff', () => {
-      const matcher = It.matches(() => false, {
+      const matcher = matches(() => false, {
         getDiff: (actual) => ({ actual, expected: 'foo' }),
       });
 
@@ -33,7 +33,7 @@ describe('UnexpectedCall', () => {
     });
 
     it('should print the diff only for expectations for the same property', () => {
-      const matcher = It.matches(() => false, {
+      const matcher = matches(() => false, {
         getDiff: (actual) => ({ actual, expected: 'foo' }),
       });
 
@@ -51,7 +51,7 @@ describe('UnexpectedCall', () => {
     });
 
     it("should contain actual and expected values when there's a single expectation remaining", () => {
-      const matcher = It.matches(() => false, {
+      const matcher = matches(() => false, {
         getDiff: () => ({ actual: 'actual', expected: 'expected' }),
       });
 

src/expectation/strong-expectation.spec.ts

@@ -1,6 +1,6 @@
 import { expectAnsilessEqual } from '../../tests/ansiless';
+import { deepEquals } from '../matchers/deep-equals';
 
-import { It } from '../matchers/it';
 import { StrongExpectation } from './strong-expectation';
 
 describe('StrongExpectation', () => {
@@ -23,7 +23,7 @@ describe('StrongExpectation', () => {
     it('should match missing args against undefined', () => {
       const expectation = new StrongExpectation(
         'bar',
-        [It.deepEquals(undefined)],
+        [deepEquals(undefined)],
         {
           value: 23,
         }
@@ -39,7 +39,7 @@ describe('StrongExpectation', () => {
     });
 
     it('should not match less args', () => {
-      const expectation = new StrongExpectation('bar', [It.deepEquals(23)], {
+      const expectation = new StrongExpectation('bar', [deepEquals(23)], {
         value: 23,
       });
 
@@ -49,7 +49,7 @@ describe('StrongExpectation', () => {
     it('should not match expected undefined verses received defined arg', () => {
       const expectation = new StrongExpectation(
         'bar',
-        [It.deepEquals(undefined)],
+        [deepEquals(undefined)],
         {
           value: 23,
         }
@@ -69,7 +69,7 @@ describe('StrongExpectation', () => {
     it('should not match less args', () => {
       const expectation = new StrongExpectation(
         'bar',
-        [It.deepEquals(23)],
+        [deepEquals(23)],
         {
           value: 23,
         },
@@ -83,7 +83,7 @@ describe('StrongExpectation', () => {
   it('should print when, returns and invocation count', () => {
     const expectation = new StrongExpectation(
       'baz',
-      [It.deepEquals(4), It.deepEquals(5), It.deepEquals(6)],
+      [deepEquals(4), deepEquals(5), deepEquals(6)],
       {
         value: 42,
       }

src/index.ts

@@ -5,9 +5,16 @@ export { mock } from './mock/mock';
 export { when } from './when/when';
 export { reset, resetAll } from './verify/reset';
 export { verify, verifyAll } from './verify/verify';
-export { It } from './matchers/it';
 export { setDefaults } from './mock/defaults';
 
+import * as It from './matchers/it';
+
+/**
+ * Contains argument matchers that can be used to ignore arguments in an
+ * expectation or to match complex arguments.
+ */
+export { It };
+
 export type { Matcher } from './matchers/matcher';
 export type { MockOptions } from './mock/options';
 export { UnexpectedProperty } from './mock/options';