tstyche 1.0.0-rc → 1.0.0-rc.2

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## [1.0.0-rc.2] - 2024-02-14
+
+### Fixed
+
+- Use the `isTypeRelatedTo()` method directly, to make strict subtype checks possible ([#127](https://github.com/tstyche/tstyche/pull/127), [#126](https://github.com/tstyche/tstyche/pull/126))
+
+## [1.0.0-rc.1] - 2024-02-10
+
+### Changed
+
+- **Breaking!** Remove the `disableTestFileLookup` option in favor of `testFileMatch: []` ([#121](https://github.com/tstyche/tstyche/pull/121))
+
+### Added
+
+- **New!** Set `module: "preserve"` in the default compiler options for inferred project that are using TypeScript 5.4 and up ([#111](https://github.com/tstyche/tstyche/pull/111))
+
+### Fixed
+
+- Do not select test files, if `testFileMatch` is an empty list ([#120](https://github.com/tstyche/tstyche/pull/120))
+
 ## [1.0.0-rc] - 2024-01-28
 
 ### Changed
@@ -116,6 +136,8 @@
 
 _First pre-release._
 
+[1.0.0-rc.2]: https://github.com/tstyche/tstyche/releases/tag/v1.0.0-rc.2
+[1.0.0-rc.1]: https://github.com/tstyche/tstyche/releases/tag/v1.0.0-rc.1
 [1.0.0-rc]: https://github.com/tstyche/tstyche/releases/tag/v1.0.0-rc
 [1.0.0-beta.9]: https://github.com/tstyche/tstyche/releases/tag/v1.0.0-beta.9
 [1.0.0-beta.8]: https://github.com/tstyche/tstyche/releases/tag/v1.0.0-beta.8

package/README.md

@@ -4,6 +4,7 @@
 [![license][license-badge]][license-url]
 [![packagephobia][packagephobia-badge]][packagephobia-url]
 [![coverage][coverage-badge]][coverage-url]
+[![discord][discord-badge]][discord-url]
 
 The Essential Type Testing Tool.
 
@@ -75,6 +76,10 @@ This simple!
 
 Visit [https://tstyche.org](https://tstyche.org) to view the full documentation.
 
+## Feedback
+
+If you have any questions or suggestions, [start a discussion](https://github.com/tstyche/tstyche/discussions/new/choose) or [open an issue](https://github.com/tstyche/tstyche/issues/new/choose) on GitHub. Preferring a chat? Join our [Discord server][discord-url].
+
 ## License
 
 [MIT][license-url] © TSTyche
@@ -85,5 +90,7 @@ Visit [https://tstyche.org](https://tstyche.org) to view the full documentation.
 [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
-[coverage-badge]: https://badgen.net/codecov/c/github/tstyche/tstyche
-[coverage-url]: https://app.codecov.io/gh/tstyche/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
+[discord-url]: https://discord.gg/gCSasd3QJq

package/build/tstyche.d.ts

@@ -139,10 +139,6 @@ interface CommandLineOptions {
  * Options loaded from the configuration file.
  */
 interface ConfigFileOptions {
-    /**
-     * Do not search for the test files.
-     */
-    disableTestFileLookup?: boolean;
     /**
      * Stop running tests after the first failed assertion.
      */
@@ -183,7 +179,7 @@ declare class ConfigService {
 declare class TSTyche {
     #private;
     readonly resolvedConfig: ResolvedConfig;
-    static readonly version = "__version__";
+    static readonly version = "1.0.0-rc.2";
     constructor(resolvedConfig: ResolvedConfig, storeService: StoreService);
     run(testFiles: Array<string | URL>): Promise<void>;
 }
@@ -445,10 +441,14 @@ interface MatchResult {
     explain: () => Array<Diagnostic>;
     isMatch: boolean;
 }
+type Relation = Map<string, unknown>;
 interface TypeChecker extends ts.TypeChecker {
-    isTypeAssignableTo: (source: ts.Type, target: ts.Type) => boolean;
-    isTypeIdenticalTo: (source: ts.Type, target: ts.Type) => boolean;
-    isTypeSubtypeOf: (source: ts.Type, target: ts.Type) => boolean;
+    isTypeRelatedTo: (source: ts.Type, target: ts.Type, relation: Relation) => boolean;
+    relation: {
+        assignable: Relation;
+        identity: Relation;
+        subtype: Relation;
+    };
 }
 
 declare class PrimitiveTypeMatcher {

package/build/tstyche.js

@@ -1742,7 +1742,7 @@ class ToBeAssignable {
             : [Diagnostic.error(`Type '${targetTypeText}' is not assignable to type '${sourceTypeText}'.`)];
     }
     match(sourceType, targetType, isNot) {
-        const isMatch = this.typeChecker.isTypeAssignableTo(targetType, sourceType);
+        const isMatch = this.typeChecker.isTypeRelatedTo(targetType, sourceType, this.typeChecker.relation.assignable);
         return {
             explain: () => this.#explain(sourceType, targetType, isNot),
             isMatch,
@@ -1763,7 +1763,7 @@ class ToEqual {
             : [Diagnostic.error(`Type '${targetTypeText}' is not identical to type '${sourceTypeText}'.`)];
     }
     match(sourceType, targetType, isNot) {
-        const isMatch = this.typeChecker.isTypeIdenticalTo(sourceType, targetType);
+        const isMatch = this.typeChecker.isTypeRelatedTo(sourceType, targetType, this.typeChecker.relation.identity);
         return {
             explain: () => this.#explain(sourceType, targetType, isNot),
             isMatch,
@@ -1825,7 +1825,7 @@ class ToMatch {
             : [Diagnostic.error(`Type '${targetTypeText}' is not a subtype of type '${sourceTypeText}'.`)];
     }
     match(sourceType, targetType, isNot) {
-        const isMatch = this.typeChecker.isTypeSubtypeOf(sourceType, targetType);
+        const isMatch = this.typeChecker.isTypeRelatedTo(sourceType, targetType, this.typeChecker.relation.subtype);
         return {
             explain: () => this.#explain(sourceType, targetType, isNot),
             isMatch,
@@ -1971,7 +1971,7 @@ class Expect {
         this.toRaiseError = new ToRaiseError(this.compiler, this.typeChecker);
     }
     static assertTypeChecker(typeChecker) {
-        return ("isTypeAssignableTo" in typeChecker && "isTypeIdenticalTo" in typeChecker && "isTypeSubtypeOf" in typeChecker);
+        return ("isTypeRelatedTo" in typeChecker && "relation" in typeChecker);
     }
     #getType(node) {
         return this.compiler.isExpression(node)
@@ -2030,7 +2030,7 @@ class Expect {
                 const sourceType = this.#getType(assertion.source[0]);
                 const nonPrimitiveType = { flags: this.compiler.TypeFlags.NonPrimitive };
                 if (sourceType.flags & (this.compiler.TypeFlags.Any | this.compiler.TypeFlags.Never)
-                    || !this.typeChecker.isTypeAssignableTo(sourceType, nonPrimitiveType)) {
+                    || !this.typeChecker.isTypeRelatedTo(sourceType, nonPrimitiveType, this.typeChecker.relation.assignable)) {
                     this.#onSourceArgumentMustBeObjectType(assertion.source[0], expectResult);
                     return;
                 }
@@ -2254,7 +2254,10 @@ class ProjectService {
             strictNullChecks: true,
             target: "esnext",
         };
-        if (Version.isSatisfiedWith(this.compiler.version, "5")) {
+        if (Version.isSatisfiedWith(this.compiler.version, "5.4")) {
+            defaultCompilerOptions.module = "preserve";
+        }
+        if (Version.isSatisfiedWith(this.compiler.version, "5.0")) {
             defaultCompilerOptions["allowImportingTsExtensions"] = true;
             defaultCompilerOptions.moduleResolution = "bundler";
         }
@@ -2525,7 +2528,7 @@ class TestFileRunner {
         }
         const typeChecker = program.getTypeChecker();
         if (!Expect.assertTypeChecker(typeChecker)) {
-            const text = "The required 'isTypeAssignableTo()', 'isTypeIdenticalTo()' and 'isTypeSubtypeOf()' methods are missing in the provided type checker.";
+            const text = "The required 'isTypeRelatedTo()' method is missing in the provided type checker.";
             EventEmitter.dispatch(["file:error", { diagnostics: [Diagnostic.error(text)], result: fileResult }]);
             return;
         }
@@ -2577,7 +2580,7 @@ class TSTyche {
     #abortController = new AbortController();
     #storeService;
     #taskRunner;
-    static version = "1.0.0-rc";
+    static version = "1.0.0-rc.2";
     constructor(resolvedConfig, storeService) {
         this.resolvedConfig = resolvedConfig;
         this.#storeService = storeService;
@@ -2588,12 +2591,11 @@ class TSTyche {
         EventEmitter.addHandler(([eventName, payload]) => {
             if (eventName.includes("error") || eventName.includes("fail")) {
                 if ("diagnostics" in payload
-                    && !payload.diagnostics.some(({ category }) => category === "error")) {
-                    return;
-                }
-                process.exitCode = 1;
-                if (this.resolvedConfig.failFast) {
-                    this.#abortController.abort();
+                    && payload.diagnostics.some((diagnostic) => diagnostic.category === "error")) {
+                    process.exitCode = 1;
+                    if (this.resolvedConfig.failFast) {
+                        this.#abortController.abort();
+                    }
                 }
             }
         });
@@ -2628,12 +2630,6 @@ class OptionDefinitionsMap {
             group: 2,
             name: "config",
         },
-        {
-            brand: "boolean",
-            description: "Do not search for the test files.",
-            group: 4,
-            name: "disableTestFileLookup",
-        },
         {
             brand: "boolean",
             description: "Stop running tests after the first failed assertion.",
@@ -3114,7 +3110,6 @@ class ConfigService {
     #commandLineOptions = {};
     #configFileOptions = {};
     static #defaultOptions = {
-        disableTestFileLookup: false,
         failFast: false,
         rootPath: Path.resolve("./"),
         target: [Environment.typescriptPath == null ? "latest" : "current"],
@@ -3535,10 +3530,14 @@ class StoreService {
         const candidatePaths = [Path.join(Path.dirname(modulePath), "tsserverlibrary.js"), modulePath];
         for (const candidatePath of candidatePaths) {
             const sourceText = await fs.readFile(candidatePath, { encoding: "utf8" });
-            const modifiedSourceText = sourceText.replace("return checker;", "return { ...checker, isTypeIdenticalTo, isTypeSubtypeOf };");
-            if (modifiedSourceText.length === sourceText.length) {
+            if (!sourceText.includes("isTypeRelatedTo")) {
                 continue;
             }
+            const toExpose = [
+                "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;
@@ -3595,7 +3594,6 @@ class StoreService {
 }
 
 class Cli {
-    #abortController = new AbortController();
     #logger;
     #storeService;
     constructor() {
@@ -3612,7 +3610,6 @@ class Cli {
                 for (const diagnostic of payload.diagnostics) {
                     switch (diagnostic.category) {
                         case "error":
-                            this.#abortController.abort();
                             process.exitCode = 1;
                             this.#logger.writeError(diagnosticText(diagnostic));
                             break;
@@ -3640,10 +3637,10 @@ class Cli {
             return;
         }
         if (commandLineArguments.includes("--update")) {
-            await this.#storeService.update(this.#abortController.signal);
+            await this.#storeService.update();
             return;
         }
-        const compiler = await this.#storeService.load(Environment.typescriptPath == null ? "latest" : "current", this.#abortController.signal);
+        const compiler = await this.#storeService.load(Environment.typescriptPath == null ? "latest" : "current");
         if (!compiler) {
             return;
         }
@@ -3670,12 +3667,12 @@ class Cli {
         }
         if (configService.commandLineOptions.install === true) {
             for (const tag of resolvedConfig.target) {
-                await this.#storeService.install(tag, this.#abortController.signal);
+                await this.#storeService.install(tag);
             }
             return;
         }
         let testFiles = [];
-        if (!resolvedConfig.disableTestFileLookup) {
+        if (resolvedConfig.testFileMatch.length !== 0) {
             testFiles = configService.selectTestFiles();
             if (testFiles.length === 0) {
                 return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tstyche",
-  "version": "1.0.0-rc",
+  "version": "1.0.0-rc.2",
   "description": "The Essential Type Testing Tool.",
   "keywords": [
     "typescript",
@@ -17,6 +17,7 @@
     "type": "git",
     "url": "git+https://github.com/tstyche/tstyche.git"
   },
+  "funding": "https://github.com/tstyche/tstyche?sponsor=1",
   "license": "MIT",
   "type": "module",
   "exports": {
@@ -37,15 +38,15 @@
     "bench": "./benchmarks/tstyche.bench.sh",
     "build": "rollup --config rollup.config.js",
     "build:watch": "yarn build --sourcemap --watch",
-    "clean": "rm -rf build",
-    "generate": "yarn generate:schema && yarn generate:types",
-    "generate:schema": "node ./models/__scripts__/generate-schema.js",
-    "generate:types": "node ./models/__scripts__/generate-types.js",
     "check": "yarn check:spelling && yarn check:formatting",
-    "check:spelling": "cspell --config cspell.config.json --quiet",
     "check:formatting": "dprint check",
+    "check:spelling": "cspell --config cspell.config.json --quiet",
     "check:types": "tsc --noEmit --project tsconfig.json",
+    "clean": "rm -rf build",
     "format": "dprint fmt",
+    "generate": "yarn generate:schema && yarn generate:types",
+    "generate:schema": "node ./models/__scripts__/generate-schema.js",
+    "generate:types": "node ./models/__scripts__/generate-types.js",
     "lint": "eslint ./ --config eslint.config.json --ext .js,.cts,.ts,.tsx",
     "prepack": "yarn clean && yarn build",
     "prepublish": "yarn test",
@@ -59,9 +60,9 @@
   "devDependencies": {
     "@jest/globals": "29.7.0",
     "@rollup/plugin-typescript": "11.1.6",
-    "@types/node": "20.11.8",
-    "@typescript-eslint/eslint-plugin": "6.19.1",
-    "@typescript-eslint/parser": "6.19.1",
+    "@types/node": "20.11.17",
+    "@typescript-eslint/eslint-plugin": "7.0.1",
+    "@typescript-eslint/parser": "7.0.1",
     "ajv": "8.12.0",
     "c8": "9.1.0",
     "cspell": "8.3.2",
@@ -69,13 +70,13 @@
     "eslint": "8.56.0",
     "eslint-import-resolver-typescript": "3.6.1",
     "eslint-plugin-import": "2.29.1",
-    "eslint-plugin-jest": "27.6.3",
+    "eslint-plugin-jest": "27.8.0",
     "eslint-plugin-jest-formatting": "3.1.0",
-    "eslint-plugin-simple-import-sort": "10.0.0",
+    "eslint-plugin-simple-import-sort": "12.0.0",
     "jest": "29.7.0",
     "jest-serializer-ansi-escapes": "2.0.1",
-    "magic-string": "0.30.5",
-    "rollup": "4.9.6",
+    "magic-string": "0.30.7",
+    "rollup": "4.10.0",
     "rollup-plugin-dts": "6.1.0",
     "ts-node": "10.9.2",
     "tslib": "2.6.2",
@@ -89,7 +90,7 @@
       "optional": true
     }
   },
-  "packageManager": "yarn@3.7.0",
+  "packageManager": "yarn@3.8.0",
   "engines": {
     "node": "^16.14 || 18.x || >=20.x"
   }