tstyche 3.0.0-beta.2 → 3.0.0-beta.3

package/README.md

@@ -56,7 +56,7 @@ test("handles numbers", () => {
 
 Here is the list of all matchers:
 
-- `.toBe()`, `.toBeAssignableTo()`, `.toBeAssignableWith()`, `.toMatch()` compare types or types of expression,
+- `.toBe()`, `.toBeAssignableTo()`, `.toBeAssignableWith()` compare types or types of expression,
 - `.toAcceptProps()` checks types of JSX component's props,
 - `.toHaveProperty()` looks up keys on an object type,
 - `.toRaiseError()` captures the type error message or code,

package/build/index.cjs

@@ -14,4 +14,6 @@ const noopChain = new Proxy(doNothing, {
 exports.describe = noopChain;
 exports.expect = noopChain;
 exports.it = noopChain;
+exports.omit = doNothing;
+exports.pick = doNothing;
 exports.test = noopChain;

package/build/index.d.cts

@@ -97,28 +97,6 @@ interface Matchers {
          */
         (target: unknown): void;
     };
-    /**
-     * 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 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.
      */
@@ -145,42 +123,26 @@ interface Matchers {
          */
         (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.
+     *
+     * @deprecated This matcher will be removed in TSTyche 4. To learn more, visit https://tstyche.org/release-notes/tstyche-3.
      */
     toMatch: {
         /**
          * Checks if the source type matches the target type.
+         *
+         * @deprecated This matcher will be removed in TSTyche 4. To learn more, visit https://tstyche.org/release-notes/tstyche-3.
          */
         <Target>(): void;
         /**
          * Checks if the source type matches type of the target expression.
+         *
+         * @deprecated This matcher will be removed in TSTyche 4. To learn more, visit https://tstyche.org/release-notes/tstyche-3.
          */
         (target: unknown): void;
     };
@@ -340,6 +302,18 @@ interface Expect {
         };
     };
 }
+/**
+ * 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.
  */
@@ -352,9 +326,5 @@ declare const test: Test;
  * Defines a single test.
  */
 declare const it: Test;
-/**
- * Builds an assertion.
- */
-declare const expect: Expect;
 
-export { describe, expect, it, test };
+export { describe, expect, it, omit, pick, test };

package/build/index.d.ts

@@ -97,28 +97,6 @@ interface Matchers {
          */
         (target: unknown): void;
     };
-    /**
-     * 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 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.
      */
@@ -145,42 +123,26 @@ interface Matchers {
          */
         (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.
+     *
+     * @deprecated This matcher will be removed in TSTyche 4. To learn more, visit https://tstyche.org/release-notes/tstyche-3.
      */
     toMatch: {
         /**
          * Checks if the source type matches the target type.
+         *
+         * @deprecated This matcher will be removed in TSTyche 4. To learn more, visit https://tstyche.org/release-notes/tstyche-3.
          */
         <Target>(): void;
         /**
          * Checks if the source type matches type of the target expression.
+         *
+         * @deprecated This matcher will be removed in TSTyche 4. To learn more, visit https://tstyche.org/release-notes/tstyche-3.
          */
         (target: unknown): void;
     };
@@ -340,6 +302,18 @@ interface Expect {
         };
     };
 }
+/**
+ * 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.
  */
@@ -352,9 +326,5 @@ declare const test: Test;
  * Defines a single test.
  */
 declare const it: Test;
-/**
- * Builds an assertion.
- */
-declare const expect: Expect;
 
-export { describe, expect, it, test };
+export { describe, expect, it, omit, pick, test };

package/build/index.js

@@ -9,4 +9,4 @@ const noopChain = new Proxy(doNothing, {
     },
 });
 
-export { noopChain as describe, noopChain as expect, noopChain as it, noopChain as test };
+export { noopChain as describe, noopChain as expect, noopChain as it, doNothing as omit, doNothing as pick, noopChain as test };

package/build/tstyche.d.ts

@@ -539,6 +539,8 @@ declare class Cli {
 
 type Event = ["config:error", {
     diagnostics: Array<Diagnostic>;
+}] | ["deprecation:info", {
+    diagnostics: Array<Diagnostic>;
 }] | ["select:error", {
     diagnostics: Array<Diagnostic>;
 }] | ["run:start", {
@@ -665,6 +667,7 @@ declare class ExpectDiagnosticText {
     static argumentMustBeProvided(argumentNameText: string): string;
     static componentAcceptsProps(isTypeNode: boolean): string;
     static componentDoesNotAcceptProps(isTypeNode: boolean): string;
+    static matcherIsDeprecated(matcherNameText: string): Array<string>;
     static matcherIsNotSupported(matcherNameText: string): string;
     static overloadGaveTheFollowingError(index: number, count: number, signatureText: string): string;
     static raisedTypeError(count?: number): string;

package/build/tstyche.js

@@ -481,11 +481,11 @@ class Path {
         return Path.normalizeSlashes(path.join(...filePaths));
     }
     static relative(from, to) {
-        let relativePath = path.relative(from, to);
-        if (!relativePath.startsWith("./")) {
-            relativePath = `./${relativePath}`;
+        const relativePath = Path.normalizeSlashes(path.relative(from, to));
+        if (/^\.\.?\//.test(relativePath)) {
+            return relativePath;
         }
-        return Path.normalizeSlashes(relativePath);
+        return `./${relativePath}`;
     }
     static resolve(...filePaths) {
         return Path.normalizeSlashes(path.resolve(...filePaths));
@@ -1251,18 +1251,28 @@ class JsonScanner {
     }
     read() {
         this.#skipTrivia();
-        if (/[:\]}]/.test(this.#peekCharacter())) {
+        this.#previousPosition = this.#currentPosition;
+        if (/[\s,:\]}]/.test(this.#peekCharacter())) {
             return new JsonNode(undefined, this.#getOrigin());
         }
-        let quoteCharacter = "";
         let text = "";
-        this.#previousPosition = this.#currentPosition;
-        if (/['"]/.test(this.#peekCharacter())) {
-            quoteCharacter = text += this.#readCharacter();
+        let closingTokenText = "";
+        if (/[[{'"]/.test(this.#peekCharacter())) {
+            text += this.#readCharacter();
+            switch (text) {
+                case "[":
+                    closingTokenText = "]";
+                    break;
+                case "{":
+                    closingTokenText = "}";
+                    break;
+                default:
+                    closingTokenText = text;
+            }
         }
         while (!this.isRead()) {
             text += this.#readCharacter();
-            if (text.slice(-1) === quoteCharacter || (!quoteCharacter && /[\s,:\]}]/.test(this.#peekCharacter()))) {
+            if (text.slice(-1) === closingTokenText || (!closingTokenText && /[\s,:\]}]/.test(this.#peekCharacter()))) {
                 break;
             }
         }
@@ -1280,35 +1290,6 @@ class JsonScanner {
         }
         return new JsonNode(undefined, this.#getOrigin());
     }
-    skip() {
-        this.#skipTrivia();
-        this.#previousPosition = this.#currentPosition;
-        if (/[\s,:\]}]/.test(this.#peekCharacter())) {
-            return new JsonNode(undefined, this.#getOrigin());
-        }
-        let text = "";
-        let closingCharacter = "";
-        if (/[[{'"]/.test(this.#peekCharacter())) {
-            text += this.#readCharacter();
-            switch (text) {
-                case "[":
-                    closingCharacter = "]";
-                    break;
-                case "{":
-                    closingCharacter = "}";
-                    break;
-                default:
-                    closingCharacter = text;
-            }
-        }
-        while (!this.isRead()) {
-            text += this.#readCharacter();
-            if (text.slice(-1) === closingCharacter || (!closingCharacter && /[\s,:\]}]/.test(this.#peekCharacter()))) {
-                break;
-            }
-        }
-        return new JsonNode(text, this.#getOrigin());
-    }
     #skipTrivia() {
         while (!this.isRead()) {
             if (/\s/.test(this.#peekCharacter())) {
@@ -1396,7 +1377,7 @@ class ConfigFileOptionsWorker {
             case "list": {
                 const leftBracketToken = this.#jsonScanner.readToken("[");
                 if (!leftBracketToken.text) {
-                    jsonNode = this.#jsonScanner.skip();
+                    jsonNode = this.#jsonScanner.read();
                     this.#onRequiresValue(optionDefinition, jsonNode, isListItem);
                     break;
                 }
@@ -1454,7 +1435,7 @@ class ConfigFileOptionsWorker {
                 const text = ConfigDiagnosticText.unknownOption(optionName);
                 this.#onDiagnostics(Diagnostic.error(text, optionNameNode.origin));
                 if (this.#jsonScanner.readToken(":")) {
-                    this.#jsonScanner.skip();
+                    this.#jsonScanner.read();
                 }
                 const commaToken = this.#jsonScanner.readToken(",");
                 if (!commaToken.text) {
@@ -1723,6 +1704,7 @@ class RunReporter extends Reporter {
     #hasReportedError = false;
     #isFileViewExpanded = false;
     #resolvedConfig;
+    #seenDeprecations = new Set();
     constructor(resolvedConfig, outputService) {
         super(outputService);
         this.#resolvedConfig = resolvedConfig;
@@ -1732,6 +1714,15 @@ class RunReporter extends Reporter {
     }
     handleEvent([eventName, payload]) {
         switch (eventName) {
+            case "deprecation:info": {
+                for (const diagnostic of payload.diagnostics) {
+                    if (!this.#seenDeprecations.has(diagnostic.text.toString())) {
+                        this.#fileView.addMessage(diagnosticText(diagnostic));
+                        this.#seenDeprecations.add(diagnostic.text.toString());
+                    }
+                }
+                break;
+            }
             case "run:start":
                 this.#isFileViewExpanded = payload.result.tasks.length === 1 && this.#resolvedConfig.watch !== true;
                 break;
@@ -1790,6 +1781,7 @@ class RunReporter extends Reporter {
                     this.#hasReportedError = true;
                 }
                 this.#fileView.clear();
+                this.#seenDeprecations.clear();
                 break;
             case "describe:start":
                 if (this.#isFileViewExpanded) {
@@ -2656,6 +2648,12 @@ class ExpectDiagnosticText {
     static componentDoesNotAcceptProps(isTypeNode) {
         return `${isTypeNode ? "Component type" : "Component"} does not accept props of the given type.`;
     }
+    static matcherIsDeprecated(matcherNameText) {
+        return [
+            `The '.${matcherNameText}()' matcher is deprecated and will be removed in TSTyche 4.`,
+            "To learn more, visit https://tstyche.org/releases/tstyche-3",
+        ];
+    }
     static matcherIsNotSupported(matcherNameText) {
         return `The '.${matcherNameText}()' matcher is not supported.`;
     }
@@ -3270,6 +3268,11 @@ class ExpectService {
     }
     match(assertion, onDiagnostics) {
         const matcherNameText = assertion.matcherName.getText();
+        if (matcherNameText === "toMatch") {
+            const text = ExpectDiagnosticText.matcherIsDeprecated(matcherNameText);
+            const origin = DiagnosticOrigin.fromNode(assertion.matcherName);
+            EventEmitter.dispatch(["deprecation:info", { diagnostics: [Diagnostic.warning(text, origin)] }]);
+        }
         if (!assertion.source[0]) {
             this.#onSourceArgumentOrTypeArgumentMustBeProvided(assertion, onDiagnostics);
             return;
@@ -3615,7 +3618,7 @@ class TSTyche {
     #runner;
     #selectService;
     #storeService;
-    static version = "3.0.0-beta.2";
+    static version = "3.0.0-beta.3";
     constructor(resolvedConfig, outputService, selectService, storeService) {
         this.#resolvedConfig = resolvedConfig;
         this.#outputService = outputService;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tstyche",
-  "version": "3.0.0-beta.2",
+  "version": "3.0.0-beta.3",
   "description": "The Essential Type Testing Tool.",
   "keywords": [
     "typescript",