tstyche 1.0.0-beta.0 → 1.0.0-beta.2

package/README.md

@@ -1,6 +1,9 @@
 # TSTyche
 
+[![version][version-src]][version-href]
 [![license][license-src]][license-href]
+[![checks][checks-src]][checks-href]
+[![coverage][coverage-src]][coverage-href]
 
 The Essential Type Testing Tool.
 
@@ -69,12 +72,17 @@ This simple!
 
 ## Documentation
 
-Visit [https://tstyche.org][documentation-href] to view the full documentation.
+Visit [https://tstyche.org](https://tstyche.org) to view the full documentation.
 
 ## License
 
 [MIT][license-href] © TSTyche
 
-[documentation-href]: https://tstyche.org
+[version-src]: https://badgen.net/npm/v/tstyche
+[version-href]: https://npmjs.com/package/tstyche
 [license-src]: https://badgen.net/github/license/tstyche/tstyche
 [license-href]: https://github.com/tstyche/tstyche/blob/main/LICENSE.md
+[checks-src]: https://badgen.net/github/checks/tstyche/tstyche
+[checks-href]: https://github.com/tstyche/tstyche/actions/workflows/checks.yml
+[coverage-src]: https://badgen.net/codecov/c/github/tstyche/tstyche
+[coverage-href]: https://app.codecov.io/gh/tstyche/tstyche

package/build/index-cjs.d.ts

@@ -0,0 +1,276 @@
+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 source type is `any`.
+     */
+    toBeAny: () => void;
+    /**
+     * Checks if the target type is assignable to the source type.
+     */
+    toBeAssignable: {
+        /**
+         * Checks if the target type is assignable to the source type.
+         */
+        <Target>(): void;
+        /**
+         * Checks if type of the target expression is assignable to the source type.
+         */
+        (target: unknown): void;
+    };
+    /**
+     * Checks if the source type is `bigint`.
+     */
+    toBeBigInt: () => void;
+    /**
+     * Checks if the source type is `boolean`.
+     */
+    toBeBoolean: () => void;
+    /**
+     * Checks if the source type is `never`.
+     */
+    toBeNever: () => void;
+    /**
+     * Checks if the source type is `null`.
+     */
+    toBeNull: () => void;
+    /**
+     * Checks if the source type is `number`.
+     */
+    toBeNumber: () => void;
+    /**
+     * Checks if the source type is `string`.
+     */
+    toBeString: () => void;
+    /**
+     * Checks if the source type is `symbol`.
+     */
+    toBeSymbol: () => void;
+    /**
+     * Checks if the source type is `undefined`.
+     */
+    toBeUndefined: () => void;
+    /**
+     * Checks if the source type is `unique symbol`.
+     */
+    toBeUniqueSymbol: () => void;
+    /**
+     * Checks if the source type is `unknown`.
+     */
+    toBeUnknown: () => void;
+    /**
+     * 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 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 {
+    /**
+     * Passes the source type to the matcher.
+     */
+    type: Matchers & {
+        /**
+         * Negates the assertion.
+         */
+        not: Matchers;
+    };
+}
+interface Expect {
+    /**
+     * Builds an assertion.
+     *
+     * @typeParam Source - The type against which the assertion will be made.
+     */
+    <Source>(): Modifier;
+    /**
+     * Builds an assertion.
+     *
+     * @param source - The expression against which type the assertion will be made.
+     */
+    (source: unknown): Modifier;
+    fail: {
+        /**
+         * Mark an assertion as supposed to fail.
+         *
+         * @typeParam Source - The type against which the assertion will be made.
+         */
+        <Source>(): Modifier;
+        /**
+         * Mark an assertion as supposed to fail.
+         *
+         * @param source - The expression against which type the assertion will be made.
+         */
+        (source: unknown): Modifier;
+    };
+    /**
+     * Marks an assertion as focused.
+     */
+    only: {
+        /**
+         * Marks an assertion as focused.
+         *
+         * @typeParam Source - The type against which the assertion will be made.
+         */
+        <Source>(): Modifier;
+        /**
+         * Marks an assertion as focused.
+         *
+         * @param source - The expression against which type the assertion will be made.
+         */
+        (source: unknown): Modifier;
+        fail: {
+            /**
+             * Mark an assertion as supposed to fail.
+             *
+             * @typeParam Source - The type against which the assertion will be made.
+             */
+            <Source>(): Modifier;
+            /**
+             * Mark an assertion as supposed to fail.
+             *
+             * @param source - The expression against which type the assertion will be made.
+             */
+            (source: unknown): Modifier;
+        };
+    };
+    /**
+     * Marks an assertion as skipped.
+     */
+    skip: {
+        /**
+         * Marks an assertion as skipped.
+         *
+         * @typeParam Source - The type against which the assertion will be made.
+         */
+        <Source>(): Modifier;
+        /**
+         * Marks an assertion as skipped.
+         *
+         * @param source - The expression against which type the assertion will be made.
+         */
+        (source: unknown): Modifier;
+        fail: {
+            /**
+             * Marks an assertion as supposed to fail.
+             *
+             * @typeParam Source - The type against which the assertion will be made.
+             */
+            <Source>(): Modifier;
+            /**
+             * Marks an assertion as supposed to fail.
+             *
+             * @param source - The expression against which type the assertion will be made.
+             */
+            (source: unknown): Modifier;
+        };
+    };
+}
+/**
+ * Defines a test group.
+ */
+declare const describe: Describe;
+/**
+ * Defines a test group.
+ */
+declare const context: Describe;
+/**
+ * Defines a single test.
+ */
+declare const test: Test;
+/**
+ * Defines a single test.
+ */
+declare const it: Test;
+/**
+ * Builds an assertion.
+ */
+declare const expect: Expect;
+
+export { context, describe, expect, it, test };

package/build/index-cjs.js

@@ -0,0 +1,18 @@
+'use strict';
+
+function doNothing() {
+}
+const noopChain = new Proxy(doNothing, {
+    apply() {
+        return noopChain;
+    },
+    get() {
+        return noopChain;
+    },
+});
+
+exports.context = noopChain;
+exports.describe = noopChain;
+exports.expect = noopChain;
+exports.it = noopChain;
+exports.test = noopChain;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tstyche",
-  "version": "1.0.0-beta.0",
+  "version": "1.0.0-beta.2",
   "description": "The Essential Type Testing Tool.",
   "keywords": [
     "typescript",
@@ -21,17 +21,16 @@
   "exports": {
     ".": {
       "import": "./build/index.js",
-      "require": "./build/index.cjs"
+      "require": "./build/index-cjs.js"
     },
     "./package.json": "./package.json",
     "./tstyche": "./build/tstyche.js"
   },
-  "main": "./build/index.cjs",
-  "types": "./build/index.d.cts",
+  "main": "./build/index-cjs.js",
+  "types": "./build/index-cjs.d.ts",
   "bin": "build/bin.js",
   "files": [
-    "build/**/*.d.ts",
-    "build/**/*.js",
+    "build/*",
     "lib/*.json"
   ],
   "scripts": {
@@ -76,7 +75,7 @@
     "jest-serializer-ansi-escapes": "2.0.1",
     "magic-string": "0.30.5",
     "prettier": "3.0.3",
-    "rollup": "4.3.0",
+    "rollup": "4.3.1",
     "rollup-plugin-dts": "6.1.0",
     "rollup-plugin-tsconfig-paths": "1.5.2",
     "ts-node": "10.9.1",