tstyche 3.0.0-rc.0 → 3.0.0-rc.2

package/build/index.d.cts

@@ -149,7 +149,7 @@ interface Matchers {
     /**
      * Checks if the source type raises an error.
      */
-    toRaiseError: (...target: Array<string | number>) => void;
+    toRaiseError: (...target: Array<string | number | RegExp>) => void;
 }
 interface Matchers {
     /**

package/build/index.d.ts

@@ -149,7 +149,7 @@ interface Matchers {
     /**
      * Checks if the source type raises an error.
      */
-    toRaiseError: (...target: Array<string | number>) => void;
+    toRaiseError: (...target: Array<string | number | RegExp>) => void;
 }
 interface Matchers {
     /**

package/build/tstyche.d.ts

@@ -558,6 +558,7 @@ interface MatchResult {
 }
 type Relation = Map<string, unknown>;
 interface TypeChecker extends ts.TypeChecker {
+    isApplicableIndexType: (source: ts.Type, target: ts.Type) => boolean;
     isTypeRelatedTo: (source: ts.Type, target: ts.Type, relation: Relation) => boolean;
     relation: {
         assignable: Relation;

package/build/tstyche.js

@@ -701,22 +701,23 @@ class Store {
     static async #loadModule(modulePath) {
         const exports = {};
         const module = { exports };
-        const candidatePaths = [Path.join(Path.dirname(modulePath), "tsserverlibrary.js"), modulePath];
-        for (const candidatePath of candidatePaths) {
-            const sourceText = await fs.readFile(candidatePath, { encoding: "utf8" });
-            if (!sourceText.includes("isTypeRelatedTo")) {
-                continue;
-            }
-            const toExpose = [
-                "getTypeOfSymbol",
-                "isTypeRelatedTo",
-                "relation: { assignable: assignableRelation, identity: identityRelation, subtype: strictSubtypeRelation }",
-            ];
-            const modifiedSourceText = sourceText.replace("return checker;", `return { ...checker, ${toExpose.join(", ")} };`);
-            const compiledWrapper = vm.compileFunction(modifiedSourceText, ["exports", "require", "module", "__filename", "__dirname"], { filename: candidatePath });
-            compiledWrapper(exports, createRequire(candidatePath), module, candidatePath, Path.dirname(candidatePath));
-            break;
-        }
+        const packageConfigText = await fs.readFile(Path.resolve(modulePath, "../../package.json"), { encoding: "utf8" });
+        const { version: packageVersion } = JSON.parse(packageConfigText);
+        if (!Version.isSatisfiedWith(packageVersion, "5.3")) {
+            modulePath = Path.resolve(modulePath, "../tsserverlibrary.js");
+        }
+        const sourceText = await fs.readFile(modulePath, { encoding: "utf8" });
+        const toExpose = [];
+        if (Version.isSatisfiedWith(packageVersion, "4.4")) {
+            toExpose.push("isApplicableIndexType");
+        }
+        if (!Version.isSatisfiedWith(packageVersion, "4.6")) {
+            toExpose.push("getTypeOfSymbol");
+        }
+        toExpose.push("isTypeRelatedTo", "relation: { assignable: assignableRelation, identity: identityRelation, subtype: strictSubtypeRelation }");
+        const modifiedSourceText = sourceText.replace("return checker;", `return { ...checker, ${toExpose.join(", ")} };`);
+        const compiledWrapper = vm.compileFunction(modifiedSourceText, ["exports", "require", "module", "__filename", "__dirname"], { filename: modulePath });
+        compiledWrapper(exports, createRequire(modulePath), module, modulePath, Path.dirname(modulePath));
         return module.exports;
     }
     static #onDiagnostics(diagnostic) {
@@ -961,19 +962,29 @@ class Options {
         }
         return definitionMap;
     }
+    static #getCanonicalOptionName(optionName) {
+        return optionName.startsWith("--") ? optionName.slice(2) : optionName;
+    }
+    static #isBuiltinReporter(optionValue) {
+        return ["list", "summary"].includes(optionValue);
+    }
+    static #isLookupStrategy(optionValue) {
+        return ["findup", "ignore"].includes(optionValue);
+    }
     static resolve(optionName, optionValue, rootPath = ".") {
-        switch (optionName.startsWith("--") ? optionName.slice(2) : optionName) {
+        const canonicalOptionName = Options.#getCanonicalOptionName(optionName);
+        switch (canonicalOptionName) {
             case "config":
             case "rootPath":
             case "tsconfig":
-                if (optionName.endsWith("tsconfig") && ["findup", "ignore"].includes(optionValue)) {
+                if (canonicalOptionName === "tsconfig" && Options.#isLookupStrategy(optionValue)) {
                     break;
                 }
                 optionValue = Path.resolve(rootPath, optionValue);
                 break;
             case "plugins":
             case "reporters":
-                if (optionName.endsWith("reporters") && ["list", "summary"].includes(optionValue)) {
+                if (canonicalOptionName === "reporters" && Options.#isBuiltinReporter(optionValue)) {
                     break;
                 }
                 try {
@@ -991,11 +1002,12 @@ class Options {
         return optionValue;
     }
     static async validate(optionName, optionValue, optionBrand, onDiagnostics, origin) {
-        switch (optionName.startsWith("--") ? optionName.slice(2) : optionName) {
+        const canonicalOptionName = Options.#getCanonicalOptionName(optionName);
+        switch (canonicalOptionName) {
             case "config":
             case "rootPath":
             case "tsconfig":
-                if (optionName.endsWith("tsconfig") && ["findup", "ignore"].includes(optionValue)) {
+                if (canonicalOptionName === "tsconfig" && Options.#isLookupStrategy(optionValue)) {
                     break;
                 }
                 if (existsSync(optionValue)) {
@@ -1005,7 +1017,7 @@ class Options {
                 break;
             case "plugins":
             case "reporters":
-                if (optionName.endsWith("reporters") && ["list", "summary"].includes(optionValue)) {
+                if (canonicalOptionName === "reporters" && Options.#isBuiltinReporter(optionValue)) {
                     break;
                 }
                 if (optionValue.startsWith("file:") && existsSync(new URL(optionValue))) {
@@ -3271,6 +3283,28 @@ class MatchWorker {
         this.#typeChecker = typeChecker;
         this.assertion = assertion;
     }
+    checkHasApplicableIndexType(sourceNode, targetNode) {
+        const sourceType = this.getType(sourceNode);
+        const targetType = this.getType(targetNode);
+        if (Version.isSatisfiedWith(this.#compiler.version, "4.4")) {
+            return this.#typeChecker
+                .getIndexInfosOfType(sourceType)
+                .some(({ keyType }) => this.#typeChecker.isApplicableIndexType(targetType, keyType));
+        }
+        if (targetType.flags & this.#compiler.TypeFlags.StringLiteral) {
+            return sourceType.getStringIndexType() != null;
+        }
+        if (targetType.flags & this.#compiler.TypeFlags.NumberLiteral) {
+            return (sourceType.getStringIndexType() ?? sourceType.getNumberIndexType()) != null;
+        }
+        return false;
+    }
+    checkHasProperty(sourceNode, propertyNameText) {
+        const sourceType = this.getType(sourceNode);
+        return sourceType
+            .getProperties()
+            .some((property) => this.#compiler.unescapeLeadingUnderscores(property.escapedName) === propertyNameText);
+    }
     checkIsAssignableTo(sourceNode, targetNode) {
         const relation = this.#typeChecker.relation.assignable;
         return this.#checkIsRelatedTo(sourceNode, targetNode, relation);
@@ -3281,7 +3315,9 @@ class MatchWorker {
     }
     checkIsIdenticalTo(sourceNode, targetNode) {
         const relation = this.#typeChecker.relation.identity;
-        return this.#checkIsRelatedTo(sourceNode, targetNode, relation);
+        return (this.#checkIsRelatedTo(sourceNode, targetNode, relation) &&
+            this.checkIsAssignableTo(sourceNode, targetNode) &&
+            this.checkIsAssignableWith(sourceNode, targetNode));
     }
     checkIsSubtype(sourceNode, targetNode) {
         const relation = this.#typeChecker.relation.subtype;
@@ -3643,7 +3679,7 @@ class ToHaveProperty {
             diagnostics.push(Diagnostic.error(text, origin));
         }
         const targetType = matchWorker.getType(targetNode);
-        let propertyNameText;
+        let propertyNameText = "";
         if (matchWorker.isStringOrNumberLiteralType(targetType)) {
             propertyNameText = targetType.value.toString();
         }
@@ -3660,9 +3696,8 @@ class ToHaveProperty {
             onDiagnostics(diagnostics);
             return;
         }
-        const isMatch = sourceType.getProperties().some((property) => {
-            return this.#compiler.unescapeLeadingUnderscores(property.escapedName) === propertyNameText;
-        });
+        const isMatch = matchWorker.checkHasProperty(sourceNode, propertyNameText) ||
+            matchWorker.checkHasApplicableIndexType(sourceNode, targetNode);
         return {
             explain: () => this.#explain(matchWorker, sourceNode, targetNode),
             isMatch,
@@ -3722,8 +3757,10 @@ class ToRaiseError {
     match(matchWorker, sourceNode, targetNodes, onDiagnostics) {
         const diagnostics = [];
         for (const targetNode of targetNodes) {
-            if (!(this.#compiler.isStringLiteralLike(targetNode) || this.#compiler.isNumericLiteral(targetNode))) {
-                const expectedText = "a string or number literal";
+            if (!(this.#compiler.isStringLiteralLike(targetNode) ||
+                this.#compiler.isNumericLiteral(targetNode) ||
+                this.#compiler.isRegularExpressionLiteral(targetNode))) {
+                const expectedText = "a string, number or regular expression literal";
                 const text = ExpectDiagnosticText.argumentMustBe("target", expectedText);
                 const origin = DiagnosticOrigin.fromNode(targetNode);
                 diagnostics.push(Diagnostic.error(text, origin));
@@ -3748,6 +3785,10 @@ class ToRaiseError {
         };
     }
     #matchExpectedError(diagnostic, targetNode) {
+        if (this.#compiler.isRegularExpressionLiteral(targetNode)) {
+            const targetRegex = new RegExp(...targetNode.text.slice(1).split("/"));
+            return targetRegex.test(this.#compiler.flattenDiagnosticMessageText(diagnostic.messageText, " ", 0));
+        }
         if (this.#compiler.isStringLiteralLike(targetNode)) {
             return this.#compiler.flattenDiagnosticMessageText(diagnostic.messageText, " ", 0).includes(targetNode.text);
         }
@@ -4096,7 +4137,7 @@ class TaskRunner {
 class Runner {
     #eventEmitter = new EventEmitter();
     #resolvedConfig;
-    static version = "3.0.0-rc.0";
+    static version = "3.0.0-rc.2";
     constructor(resolvedConfig) {
         this.#resolvedConfig = resolvedConfig;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tstyche",
-  "version": "3.0.0-rc.0",
+  "version": "3.0.0-rc.2",
   "description": "The Essential Type Testing Tool.",
   "keywords": [
     "typescript",
@@ -63,16 +63,16 @@
   "devDependencies": {
     "@biomejs/biome": "1.9.4",
     "@rollup/plugin-typescript": "12.1.1",
-    "@types/node": "22.8.4",
+    "@types/node": "22.8.6",
     "@types/react": "18.3.12",
     "ajv": "8.17.1",
-    "cspell": "8.15.4",
+    "cspell": "8.15.5",
     "magic-string": "0.30.12",
     "monocart-coverage-reports": "2.11.1",
     "pretty-ansi": "2.0.0",
     "rollup": "4.24.3",
     "rollup-plugin-dts": "6.1.1",
-    "tslib": "2.8.0",
+    "tslib": "2.8.1",
     "typescript": "5.6.3"
   },
   "peerDependencies": {