tstyche 4.3.0 → 5.0.0-beta.1

package/README.md

@@ -65,7 +65,7 @@ test("toMilliseconds", () => {
 
 Here is the list of all matchers:
 
-- `.toBe()`, `.toBeAssignableTo()`, `.toBeAssignableWith()` compare types or types of expression,
+- `.toBe()`, `.toBeAssignableTo()`, `.toBeAssignableFrom()` compare types or types of expression,
 - `.toAcceptProps()` checks the type of JSX component props,
 - `.toBeApplicable` ensures that the decorator function can be applied,
 - `.toBeCallableWith()` checks whether a function is callable with the given arguments,
@@ -74,7 +74,7 @@ Here is the list of all matchers:
 
 ## Runner
 
-The `tstyche` command is the heart of TSTyche. For example, it can select test files by path, filter tests by name and pass them through a range of TypeScript versions:
+The `tstyche` command is the heart of TSTyche. For example, it can select test files by path, filter tests by name and to run the tests against specific versions of TypeScript:
 
 ```shell
 tstyche query-params --only multiple --target '>=5.0 <5.3'

package/build/4.x/index.d.cts

@@ -0,0 +1,251 @@
+interface Describe {
+    /**
+     * Defines a group of tests.
+     *
+     * @param name - The name of the group.
+     * @param callback - The function to create a scope for a group of tests.
+     */
+    (name: string, callback: () => void | Promise<void>): void;
+    /**
+     * Marks a group of tests as focused.
+     *
+     * @param name - The name of the group.
+     * @param callback - The function to create a scope for a group of tests.
+     */
+    only: (name: string, callback: () => void | Promise<void>) => void;
+    /**
+     * Marks a group of tests as skipped.
+     *
+     * @param name - The name of the group.
+     * @param callback - The function to create a scope for a group of tests.
+     */
+    skip: (name: string, callback: () => void | Promise<void>) => void;
+    /**
+     * Marks a group of tests as yet to be implemented.
+     *
+     * @param name - The name of the group.
+     * @param callback - The function to create a scope for a group of tests.
+     */
+    todo: (name: string, callback?: () => void | Promise<void>) => void;
+}
+interface Test {
+    /**
+     * Defines a single test.
+     *
+     * @param name - The name of the test.
+     * @param callback - The function with a code snippet and assertions.
+     */
+    (name: string, callback: () => void | Promise<void>): void;
+    /**
+     * Marks a test as focused.
+     *
+     * @param name - The name of the test.
+     * @param callback - The function with a code snippet and assertions.
+     */
+    only: (name: string, callback: () => void | Promise<void>) => void;
+    /**
+     * Marks a test as skipped.
+     *
+     * @param name - The name of the test.
+     * @param callback - The function with a code snippet and assertions.
+     */
+    skip: (name: string, callback: () => void | Promise<void>) => void;
+    /**
+     * Marks a test as yet to be implemented.
+     *
+     * @param name - The name of the test.
+     * @param callback - The function with a code snippet and assertions.
+     */
+    todo: (name: string, callback?: () => void | Promise<void>) => void;
+}
+interface Matchers {
+    /**
+     * Checks if the JSX component accepts props of the given type.
+     *
+     * @remarks
+     *
+     * This is a work in progress feature. Generic components are not yet supported.
+     */
+    toAcceptProps: {
+        /**
+         * Checks if the JSX component accepts props of the given type.
+         *
+         * @remarks
+         *
+         * This is a work in progress feature. Generic components are not yet supported.
+         */
+        <Target>(): void;
+        /**
+         * Checks if the JSX component accepts the given props.
+         *
+         * @remarks
+         *
+         * This is a work in progress feature. Generic components are not yet supported.
+         */
+        (target: unknown): void;
+    };
+    /**
+     * Checks if the source type is the same as the target type.
+     */
+    toBe: {
+        /**
+         * Checks if the source type is the same as the target type.
+         */
+        <Target>(): void;
+        /**
+         * Checks if the source type is the same as type of the target expression.
+         */
+        (target: unknown): void;
+    };
+    /**
+     * Checks if the source type is assignable from the target type.
+     */
+    toBeAssignableFrom: {
+        /**
+         * Checks if the source type is assignable from the target type.
+         */
+        <Target>(): void;
+        /**
+         * Checks if the source type is assignable from type of the target expression.
+         */
+        (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 the source type is assignable to type of the target expression.
+         */
+        (target: unknown): void;
+    };
+    /**
+     * Checks if the source type is callable with the given arguments.
+     */
+    toBeCallableWith: (...args: Array<unknown>) => void;
+    /**
+     * Checks if the source type is constructable with the given arguments.
+     */
+    toBeConstructableWith: (...args: Array<unknown>) => void;
+    /**
+     * Checks if a property key exists on the source type.
+     */
+    toHaveProperty: (key: string | number | symbol) => void;
+    /**
+     * Checks if the source type raises an error.
+     */
+    toRaiseError: (...target: Array<string | number | RegExp>) => void;
+}
+interface Modifier {
+    /**
+     * Passes the source type to the matcher.
+     */
+    type: Matchers & {
+        /**
+         * Negates the assertion.
+         */
+        not: Matchers;
+    };
+}
+interface Expect {
+    /**
+     * Builds an assertion.
+     *
+     * @template Source - The type which is checked.
+     */
+    <Source>(): Modifier;
+    /**
+     * Builds an assertion.
+     *
+     * @param source - The expression whose type is checked.
+     */
+    (source: unknown): Modifier;
+    /**
+     * Marks an assertion as focused.
+     */
+    only: {
+        /**
+         * Marks an assertion as focused.
+         *
+         * @template Source - The type which is checked.
+         */
+        <Source>(): Modifier;
+        /**
+         * Marks an assertion as focused.
+         *
+         * @param source - The expression whose type is checked.
+         */
+        (source: unknown): Modifier;
+    };
+    /**
+     * Marks an assertion as skipped.
+     */
+    skip: {
+        /**
+         * Marks an assertion as skipped.
+         *
+         * @template Source - The type which is checked.
+         */
+        <Source>(): Modifier;
+        /**
+         * Marks an assertion as skipped.
+         *
+         * @param source - The expression whose type is checked.
+         */
+        (source: unknown): Modifier;
+    };
+}
+/**
+ * Builds an assertion.
+ */
+declare const expect: Expect;
+/**
+ * Reshapes type of the given object by removing the specified keys.
+ */
+declare function omit<T, K extends PropertyKey>(object: T, ...keys: [K, ...Array<K>]): Omit<T, K>;
+/**
+ * Reshapes type of the given object by keeping only the specified keys.
+ */
+declare function pick<T, K extends keyof T>(object: T, ...keys: [K, ...Array<K>]): Pick<T, K>;
+/**
+ * Defines a test group.
+ */
+declare const describe: Describe;
+/**
+ * Defines a single test.
+ */
+declare const test: Test;
+/**
+ * Defines a single test.
+ */
+declare const it: Test;
+interface Actions {
+    /**
+     * Calls the given function with the provided arguments.
+     */
+    isCalledWith: (...args: Array<unknown>) => void;
+}
+interface When {
+    /**
+     * Creates a test plan.
+     *
+     * @template Target - The type upon which an action is performed.
+     */
+    <Target>(): Actions;
+    /**
+     * Creates a test plan.
+     *
+     * @param target - The expression upon which an action is performed.
+     */
+    (target: unknown): Actions;
+}
+/**
+ * Creates a test plan.
+ */
+declare const when: When;
+
+export { describe, expect, it, omit, pick, test, when };

package/build/4.x/index.d.ts

@@ -0,0 +1,251 @@
+interface Describe {
+    /**
+     * Defines a group of tests.
+     *
+     * @param name - The name of the group.
+     * @param callback - The function to create a scope for a group of tests.
+     */
+    (name: string, callback: () => void | Promise<void>): void;
+    /**
+     * Marks a group of tests as focused.
+     *
+     * @param name - The name of the group.
+     * @param callback - The function to create a scope for a group of tests.
+     */
+    only: (name: string, callback: () => void | Promise<void>) => void;
+    /**
+     * Marks a group of tests as skipped.
+     *
+     * @param name - The name of the group.
+     * @param callback - The function to create a scope for a group of tests.
+     */
+    skip: (name: string, callback: () => void | Promise<void>) => void;
+    /**
+     * Marks a group of tests as yet to be implemented.
+     *
+     * @param name - The name of the group.
+     * @param callback - The function to create a scope for a group of tests.
+     */
+    todo: (name: string, callback?: () => void | Promise<void>) => void;
+}
+interface Test {
+    /**
+     * Defines a single test.
+     *
+     * @param name - The name of the test.
+     * @param callback - The function with a code snippet and assertions.
+     */
+    (name: string, callback: () => void | Promise<void>): void;
+    /**
+     * Marks a test as focused.
+     *
+     * @param name - The name of the test.
+     * @param callback - The function with a code snippet and assertions.
+     */
+    only: (name: string, callback: () => void | Promise<void>) => void;
+    /**
+     * Marks a test as skipped.
+     *
+     * @param name - The name of the test.
+     * @param callback - The function with a code snippet and assertions.
+     */
+    skip: (name: string, callback: () => void | Promise<void>) => void;
+    /**
+     * Marks a test as yet to be implemented.
+     *
+     * @param name - The name of the test.
+     * @param callback - The function with a code snippet and assertions.
+     */
+    todo: (name: string, callback?: () => void | Promise<void>) => void;
+}
+interface Matchers {
+    /**
+     * Checks if the JSX component accepts props of the given type.
+     *
+     * @remarks
+     *
+     * This is a work in progress feature. Generic components are not yet supported.
+     */
+    toAcceptProps: {
+        /**
+         * Checks if the JSX component accepts props of the given type.
+         *
+         * @remarks
+         *
+         * This is a work in progress feature. Generic components are not yet supported.
+         */
+        <Target>(): void;
+        /**
+         * Checks if the JSX component accepts the given props.
+         *
+         * @remarks
+         *
+         * This is a work in progress feature. Generic components are not yet supported.
+         */
+        (target: unknown): void;
+    };
+    /**
+     * Checks if the source type is the same as the target type.
+     */
+    toBe: {
+        /**
+         * Checks if the source type is the same as the target type.
+         */
+        <Target>(): void;
+        /**
+         * Checks if the source type is the same as type of the target expression.
+         */
+        (target: unknown): void;
+    };
+    /**
+     * Checks if the source type is assignable from the target type.
+     */
+    toBeAssignableFrom: {
+        /**
+         * Checks if the source type is assignable from the target type.
+         */
+        <Target>(): void;
+        /**
+         * Checks if the source type is assignable from type of the target expression.
+         */
+        (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 the source type is assignable to type of the target expression.
+         */
+        (target: unknown): void;
+    };
+    /**
+     * Checks if the source type is callable with the given arguments.
+     */
+    toBeCallableWith: (...args: Array<unknown>) => void;
+    /**
+     * Checks if the source type is constructable with the given arguments.
+     */
+    toBeConstructableWith: (...args: Array<unknown>) => void;
+    /**
+     * Checks if a property key exists on the source type.
+     */
+    toHaveProperty: (key: string | number | symbol) => void;
+    /**
+     * Checks if the source type raises an error.
+     */
+    toRaiseError: (...target: Array<string | number | RegExp>) => void;
+}
+interface Modifier {
+    /**
+     * Passes the source type to the matcher.
+     */
+    type: Matchers & {
+        /**
+         * Negates the assertion.
+         */
+        not: Matchers;
+    };
+}
+interface Expect {
+    /**
+     * Builds an assertion.
+     *
+     * @template Source - The type which is checked.
+     */
+    <Source>(): Modifier;
+    /**
+     * Builds an assertion.
+     *
+     * @param source - The expression whose type is checked.
+     */
+    (source: unknown): Modifier;
+    /**
+     * Marks an assertion as focused.
+     */
+    only: {
+        /**
+         * Marks an assertion as focused.
+         *
+         * @template Source - The type which is checked.
+         */
+        <Source>(): Modifier;
+        /**
+         * Marks an assertion as focused.
+         *
+         * @param source - The expression whose type is checked.
+         */
+        (source: unknown): Modifier;
+    };
+    /**
+     * Marks an assertion as skipped.
+     */
+    skip: {
+        /**
+         * Marks an assertion as skipped.
+         *
+         * @template Source - The type which is checked.
+         */
+        <Source>(): Modifier;
+        /**
+         * Marks an assertion as skipped.
+         *
+         * @param source - The expression whose type is checked.
+         */
+        (source: unknown): Modifier;
+    };
+}
+/**
+ * Builds an assertion.
+ */
+declare const expect: Expect;
+/**
+ * Reshapes type of the given object by removing the specified keys.
+ */
+declare function omit<T, K extends PropertyKey>(object: T, ...keys: [K, ...Array<K>]): Omit<T, K>;
+/**
+ * Reshapes type of the given object by keeping only the specified keys.
+ */
+declare function pick<T, K extends keyof T>(object: T, ...keys: [K, ...Array<K>]): Pick<T, K>;
+/**
+ * Defines a test group.
+ */
+declare const describe: Describe;
+/**
+ * Defines a single test.
+ */
+declare const test: Test;
+/**
+ * Defines a single test.
+ */
+declare const it: Test;
+interface Actions {
+    /**
+     * Calls the given function with the provided arguments.
+     */
+    isCalledWith: (...args: Array<unknown>) => void;
+}
+interface When {
+    /**
+     * Creates a test plan.
+     *
+     * @template Target - The type upon which an action is performed.
+     */
+    <Target>(): Actions;
+    /**
+     * Creates a test plan.
+     *
+     * @param target - The expression upon which an action is performed.
+     */
+    (target: unknown): Actions;
+}
+/**
+ * Creates a test plan.
+ */
+declare const when: When;
+
+export { describe, expect, it, omit, pick, test, when };

package/build/index.d.cts

@@ -102,39 +102,39 @@ interface Matchers {
      */
     toBeApplicable: (target: unknown, context: DecoratorContext) => void;
     /**
-     * Checks if the source type is assignable to the target type.
+     * Checks if the source type is assignable from the target type.
      */
-    toBeAssignableTo: {
+    toBeAssignableFrom: {
         /**
-         * Checks if the source type is assignable to the target type.
+         * Checks if the source type is assignable from the target type.
          */
         <Target>(): void;
         /**
-         * Checks if the source type is assignable to type of the target expression.
+         * Checks if the source type is assignable from type of the target expression.
          */
         (target: unknown): void;
     };
     /**
-     * Checks if the source type is assignable with the target type.
+     * Checks if the source type is assignable to the target type.
      */
-    toBeAssignableWith: {
+    toBeAssignableTo: {
         /**
-         * Checks if the source type is assignable with the target type.
+         * Checks if the source type is assignable to the target type.
          */
         <Target>(): void;
         /**
-         * Checks if the source type is assignable with type of the target expression.
+         * Checks if the source type is assignable to type of the target expression.
          */
         (target: unknown): void;
     };
     /**
      * Checks if the source type is callable with the given arguments.
      */
-    toBeCallableWith: (...target: Array<unknown>) => void;
+    toBeCallableWith: (...args: Array<unknown>) => void;
     /**
      * Checks if the source type is constructable with the given arguments.
      */
-    toBeConstructableWith: (...target: Array<unknown>) => void;
+    toBeConstructableWith: (...args: Array<unknown>) => void;
     /**
      * Checks if a property key exists on the source type.
      */
@@ -159,29 +159,15 @@ interface Expect {
     /**
      * Builds an assertion.
      *
-     * @template Source - The type against which the assertion is made.
+     * @template Source - The type which is checked.
      */
     <Source>(): Modifier;
     /**
      * Builds an assertion.
      *
-     * @param source - The expression against which type the assertion is made.
+     * @param source - The expression whose type is checked.
      */
     (source: unknown): Modifier;
-    fail: {
-        /**
-         * Mark an assertion as supposed to fail.
-         *
-         * @template Source - The type against which the assertion is made.
-         */
-        <Source>(): Modifier;
-        /**
-         * Mark an assertion as supposed to fail.
-         *
-         * @param source - The expression against which type the assertion is made.
-         */
-        (source: unknown): Modifier;
-    };
     /**
      * Marks an assertion as focused.
      */
@@ -189,29 +175,15 @@ interface Expect {
         /**
          * Marks an assertion as focused.
          *
-         * @template Source - The type against which the assertion is made.
+         * @template Source - The type which is checked.
          */
         <Source>(): Modifier;
         /**
          * Marks an assertion as focused.
          *
-         * @param source - The expression against which type the assertion is made.
+         * @param source - The expression whose type is checked.
          */
         (source: unknown): Modifier;
-        fail: {
-            /**
-             * Mark an assertion as supposed to fail.
-             *
-             * @template Source - The type against which the assertion is made.
-             */
-            <Source>(): Modifier;
-            /**
-             * Mark an assertion as supposed to fail.
-             *
-             * @param source - The expression against which type the assertion is made.
-             */
-            (source: unknown): Modifier;
-        };
     };
     /**
      * Marks an assertion as skipped.
@@ -220,29 +192,15 @@ interface Expect {
         /**
          * Marks an assertion as skipped.
          *
-         * @template Source - The type against which the assertion is made.
+         * @template Source - The type which is checked.
          */
         <Source>(): Modifier;
         /**
          * Marks an assertion as skipped.
          *
-         * @param source - The expression against which type the assertion is made.
+         * @param source - The expression whose type is checked.
          */
         (source: unknown): Modifier;
-        fail: {
-            /**
-             * Marks an assertion as supposed to fail.
-             *
-             * @template Source - The type against which the assertion is made.
-             */
-            <Source>(): Modifier;
-            /**
-             * Marks an assertion as supposed to fail.
-             *
-             * @param source - The expression against which type the assertion is made.
-             */
-            (source: unknown): Modifier;
-        };
     };
 }
 /**