tstyche 1.0.0 → 2.0.0-beta.0

package/README.md

@@ -2,7 +2,8 @@
 
 [![version][version-badge]][version-url]
 [![license][license-badge]][license-url]
-[![packagephobia][packagephobia-badge]][packagephobia-url]
+[![requirements][requirements-badge]][requirements-url]
+[![install-size][install-size-badge]][install-size-url]
 [![coverage][coverage-badge]][coverage-url]
 [![discord][discord-badge]][discord-url]
 
@@ -24,7 +25,7 @@ function firstItem<T>(target: Array<T>): T | undefined {
 }
 
 test("firstItem", () => {
-  expect(firstItem(["a", "b", "c"])).type.toEqual<string | undefined>();
+  expect(firstItem(["a", "b", "c"])).type.toBe<string | undefined>();
 
   expect(firstItem()).type.toRaiseError("Expected 1 argument");
 });
@@ -51,13 +52,13 @@ function secondItem<T>(target: Array<T>): T | undefined {
 test("handles numbers", () => {
   assert.strictEqual(secondItem([1, 2, 3]), 2);
 
-  tstyche.expect(secondItem([1, 2, 3])).type.toEqual<number | undefined>();
+  tstyche.expect(secondItem([1, 2, 3])).type.toBe<number | undefined>();
 });
 ```
 
 Here is the list of all matchers:
 
-- `.toBeAssignable()`, `.toEqual()`, `.toMatch()` compares types or types of expression,
+- `.toBe()`, `.toBeAssignableTo()`, `.toBeAssignableWith()`, `.toMatch()` compare types or types of expression,
 - `.toHaveProperty()` looks up keys on an object type,
 - `.toRaiseError()` captures the type error message or code,
 - `.toBeString()`, `.toBeNumber()`, `.toBeVoid()` and 9 more shorthand checks for primitive types.
@@ -88,8 +89,10 @@ If you have any questions or suggestions, [start a discussion](https://github.co
 [version-url]: https://npmjs.com/package/tstyche
 [license-badge]: https://badgen.net/github/license/tstyche/tstyche
 [license-url]: https://github.com/tstyche/tstyche/blob/main/LICENSE.md
-[packagephobia-badge]: https://badgen.net/packagephobia/install/tstyche
-[packagephobia-url]: https://packagephobia.com/result?p=tstyche
+[requirements-badge]: https://badgen.net/npm/node/tstyche
+[requirements-url]: https://tstyche.org/reference/requirements
+[install-size-badge]: https://badgen.net/packagephobia/install/tstyche
+[install-size-url]: https://packagephobia.com/result?p=tstyche
 [coverage-badge]: https://badgen.net/codacy/coverage/a581ca5c323a455886b7bdd9623c4ec8
 [coverage-url]: https://app.codacy.com/gh/tstyche/tstyche/coverage/dashboard
 [discord-badge]: https://badgen.net/static/chat/on%20Discord

package/build/index.d.cts

@@ -60,100 +60,159 @@ interface Test {
 }
 interface Matchers {
     /**
-     * Checks if the `any` type is identical to the source type.
+     * Checks if the source type is identical to the target type.
      */
-    toBeAny: () => void;
+    toBe: {
+        /**
+         * Checks if the source type is identical to the target type.
+         */
+        <Target>(): void;
+        /**
+         * Checks if the source type is identical to type of the target expression.
+         */
+        (target: unknown): void;
+    };
     /**
-     * Checks if the target type is assignable to the source type.
+     * Checks if the source type is assignable with the target type.
+     *
+     * @deprecated Use `.toBeAssignableWith()` or `.toBeAssignableTo()` instead. This matcher will be removed in TSTyche 3.
+     * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
      */
     toBeAssignable: {
         /**
-         * Checks if the target type is assignable to the source type.
+         * Checks if the source type is assignable with the target type.
+         *
+         * @deprecated Use `.toBeAssignableWith()` or `.toBeAssignableTo()` instead. This matcher will be removed in TSTyche 3.
+         * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
+         */
+        <Target>(): void;
+        /**
+         * Checks if the source type is assignable with type of the target expression.
+         *
+         * @deprecated Use `.toBeAssignableWith()` or `.toBeAssignableTo()` instead. This matcher will be removed in TSTyche 3.
+         * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
+         */
+        (target: unknown): void;
+    };
+    /**
+     * Checks if the source type is assignable to the target type.
+     */
+    toBeAssignableTo: {
+        /**
+         * Checks if the source type is assignable to the target type.
          */
         <Target>(): void;
         /**
-         * Checks if type of the target expression is assignable to the source type.
+         * Checks if the source type is assignable to type of the target expression.
          */
         (target: unknown): void;
     };
     /**
-     * Checks if the `bigint` type is identical to the source type.
+     * Checks if the source type is assignable with the target type.
+     */
+    toBeAssignableWith: {
+        /**
+         * Checks if the source type is assignable with the target type.
+         */
+        <Target>(): void;
+        /**
+         * Checks if the source type is assignable with type of the target expression.
+         */
+        (target: unknown): void;
+    };
+    /**
+     * Checks if the source type is identical to the target type.
+     *
+     * @deprecated Use `.toBe()` instead. This matcher will be removed in TSTyche 3.
+     * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
+     */
+    toEqual: {
+        /**
+         * Checks if the source type is identical to the target type.
+         *
+         * @deprecated Use `.toBe()` instead. This matcher will be removed in TSTyche 3.
+         * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
+         */
+        <Target>(): void;
+        /**
+         * Checks if the source type is identical to type of the target expression.
+         *
+         * @deprecated This matcher will be removed in TSTyche 3.
+         * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
+         */
+        (target: unknown): void;
+    };
+    /**
+     * Checks if a property key exists on the source type.
+     */
+    toHaveProperty: (key: string | number | symbol) => void;
+    /**
+     * Checks if the source type matches the target type.
+     */
+    toMatch: {
+        /**
+         * Checks if the source type matches the target type.
+         */
+        <Target>(): void;
+        /**
+         * Checks if the source type matches type of the target expression.
+         */
+        (target: unknown): void;
+    };
+    /**
+     * Checks if the source type raises an error.
+     */
+    toRaiseError: (...target: Array<string | number>) => void;
+}
+interface Matchers {
+    /**
+     * Checks if the source type is `any`.
+     */
+    toBeAny: () => void;
+    /**
+     * Checks if the source type is `bigint`.
      */
     toBeBigInt: () => void;
     /**
-     * Checks if the `boolean` type is identical to the source type.
+     * Checks if the source type is `boolean`.
      */
     toBeBoolean: () => void;
     /**
-     * Checks if the `never` type is identical to the source type.
+     * Checks if the source type is `never`.
      */
     toBeNever: () => void;
     /**
-     * Checks if the `null` type is identical to the source type.
+     * Checks if the source type is `null`.
      */
     toBeNull: () => void;
     /**
-     * Checks if the `number` type is identical to the source type.
+     * Checks if the source type is `number`.
      */
     toBeNumber: () => void;
     /**
-     * Checks if the `string` type is identical to the source type.
+     * Checks if the source type is `string`.
      */
     toBeString: () => void;
     /**
-     * Checks if the `symbol` type is identical to the source type.
+     * Checks if the source type is `symbol`.
      */
     toBeSymbol: () => void;
     /**
-     * Checks if the `undefined` type is identical to the source type.
+     * Checks if the source type is `undefined`.
      */
     toBeUndefined: () => void;
     /**
-     * Checks if the `unique symbol` type is identical to the source type.
+     * Checks if the source type is `unique symbol`.
      */
     toBeUniqueSymbol: () => void;
     /**
-     * Checks if the `unknown` type is identical to the source type.
+     * Checks if the source type is `unknown`.
      */
     toBeUnknown: () => void;
     /**
-     * Checks if the `void` type is identical to the source type.
+     * Checks if the source type is `void`.
      */
     toBeVoid: () => void;
-    /**
-     * Check if the target type is identical to the source type.
-     */
-    toEqual: {
-        /**
-         * Checks if the target type is identical to the source type.
-         */
-        <Target>(): void;
-        /**
-         * Checks if type of the target expression is identical to the source type.
-         */
-        (target: unknown): void;
-    };
-    /**
-     * Checks if a property key exists on the source type.
-     */
-    toHaveProperty: (key: string | number | symbol) => void;
-    /**
-     * Checks if the target type is a subtype the source type.
-     */
-    toMatch: {
-        /**
-         * Checks if the target type is a subtype the source type.
-         */
-        <Target>(): void;
-        /**
-         * Checks if type of the target expression is a subtype the source type.
-         */
-        (target: unknown): void;
-    };
-    /**
-     * Checks if the source type raises an error.
-     */
-    toRaiseError: (...target: Array<string | number>) => void;
 }
 interface Modifier {
     /**

package/build/index.d.ts

@@ -60,100 +60,159 @@ interface Test {
 }
 interface Matchers {
     /**
-     * Checks if the `any` type is identical to the source type.
+     * Checks if the source type is identical to the target type.
      */
-    toBeAny: () => void;
+    toBe: {
+        /**
+         * Checks if the source type is identical to the target type.
+         */
+        <Target>(): void;
+        /**
+         * Checks if the source type is identical to type of the target expression.
+         */
+        (target: unknown): void;
+    };
     /**
-     * Checks if the target type is assignable to the source type.
+     * Checks if the source type is assignable with the target type.
+     *
+     * @deprecated Use `.toBeAssignableWith()` or `.toBeAssignableTo()` instead. This matcher will be removed in TSTyche 3.
+     * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
      */
     toBeAssignable: {
         /**
-         * Checks if the target type is assignable to the source type.
+         * Checks if the source type is assignable with the target type.
+         *
+         * @deprecated Use `.toBeAssignableWith()` or `.toBeAssignableTo()` instead. This matcher will be removed in TSTyche 3.
+         * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
+         */
+        <Target>(): void;
+        /**
+         * Checks if the source type is assignable with type of the target expression.
+         *
+         * @deprecated Use `.toBeAssignableWith()` or `.toBeAssignableTo()` instead. This matcher will be removed in TSTyche 3.
+         * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
+         */
+        (target: unknown): void;
+    };
+    /**
+     * Checks if the source type is assignable to the target type.
+     */
+    toBeAssignableTo: {
+        /**
+         * Checks if the source type is assignable to the target type.
          */
         <Target>(): void;
         /**
-         * Checks if type of the target expression is assignable to the source type.
+         * Checks if the source type is assignable to type of the target expression.
          */
         (target: unknown): void;
     };
     /**
-     * Checks if the `bigint` type is identical to the source type.
+     * Checks if the source type is assignable with the target type.
+     */
+    toBeAssignableWith: {
+        /**
+         * Checks if the source type is assignable with the target type.
+         */
+        <Target>(): void;
+        /**
+         * Checks if the source type is assignable with type of the target expression.
+         */
+        (target: unknown): void;
+    };
+    /**
+     * Checks if the source type is identical to the target type.
+     *
+     * @deprecated Use `.toBe()` instead. This matcher will be removed in TSTyche 3.
+     * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
+     */
+    toEqual: {
+        /**
+         * Checks if the source type is identical to the target type.
+         *
+         * @deprecated Use `.toBe()` instead. This matcher will be removed in TSTyche 3.
+         * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
+         */
+        <Target>(): void;
+        /**
+         * Checks if the source type is identical to type of the target expression.
+         *
+         * @deprecated This matcher will be removed in TSTyche 3.
+         * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
+         */
+        (target: unknown): void;
+    };
+    /**
+     * Checks if a property key exists on the source type.
+     */
+    toHaveProperty: (key: string | number | symbol) => void;
+    /**
+     * Checks if the source type matches the target type.
+     */
+    toMatch: {
+        /**
+         * Checks if the source type matches the target type.
+         */
+        <Target>(): void;
+        /**
+         * Checks if the source type matches type of the target expression.
+         */
+        (target: unknown): void;
+    };
+    /**
+     * Checks if the source type raises an error.
+     */
+    toRaiseError: (...target: Array<string | number>) => void;
+}
+interface Matchers {
+    /**
+     * Checks if the source type is `any`.
+     */
+    toBeAny: () => void;
+    /**
+     * Checks if the source type is `bigint`.
      */
     toBeBigInt: () => void;
     /**
-     * Checks if the `boolean` type is identical to the source type.
+     * Checks if the source type is `boolean`.
      */
     toBeBoolean: () => void;
     /**
-     * Checks if the `never` type is identical to the source type.
+     * Checks if the source type is `never`.
      */
     toBeNever: () => void;
     /**
-     * Checks if the `null` type is identical to the source type.
+     * Checks if the source type is `null`.
      */
     toBeNull: () => void;
     /**
-     * Checks if the `number` type is identical to the source type.
+     * Checks if the source type is `number`.
      */
     toBeNumber: () => void;
     /**
-     * Checks if the `string` type is identical to the source type.
+     * Checks if the source type is `string`.
      */
     toBeString: () => void;
     /**
-     * Checks if the `symbol` type is identical to the source type.
+     * Checks if the source type is `symbol`.
      */
     toBeSymbol: () => void;
     /**
-     * Checks if the `undefined` type is identical to the source type.
+     * Checks if the source type is `undefined`.
      */
     toBeUndefined: () => void;
     /**
-     * Checks if the `unique symbol` type is identical to the source type.
+     * Checks if the source type is `unique symbol`.
      */
     toBeUniqueSymbol: () => void;
     /**
-     * Checks if the `unknown` type is identical to the source type.
+     * Checks if the source type is `unknown`.
      */
     toBeUnknown: () => void;
     /**
-     * Checks if the `void` type is identical to the source type.
+     * Checks if the source type is `void`.
      */
     toBeVoid: () => void;
-    /**
-     * Check if the target type is identical to the source type.
-     */
-    toEqual: {
-        /**
-         * Checks if the target type is identical to the source type.
-         */
-        <Target>(): void;
-        /**
-         * Checks if type of the target expression is identical to the source type.
-         */
-        (target: unknown): void;
-    };
-    /**
-     * Checks if a property key exists on the source type.
-     */
-    toHaveProperty: (key: string | number | symbol) => void;
-    /**
-     * Checks if the target type is a subtype the source type.
-     */
-    toMatch: {
-        /**
-         * Checks if the target type is a subtype the source type.
-         */
-        <Target>(): void;
-        /**
-         * Checks if type of the target expression is a subtype the source type.
-         */
-        (target: unknown): void;
-    };
-    /**
-     * Checks if the source type raises an error.
-     */
-    toRaiseError: (...target: Array<string | number>) => void;
 }
 interface Modifier {
     /**