tstyche 7.0.0-beta.3 → 7.0.0-beta.5

package/dist/api.d.ts

@@ -15,13 +15,9 @@ declare class CancellationToken {
     reset(): void;
 }
 
-interface CliOptions {
-    noErrorExitCode?: boolean;
-}
 declare class Cli {
     #private;
-    constructor(options?: CliOptions);
-    run(commandLine: ReadonlyArray<string>, cancellationToken?: CancellationToken): Promise<void>;
+    run(commandLine: ReadonlyArray<string>, cancellationToken?: CancellationToken): Promise<number>;
 }
 
 declare enum DiagnosticCategory {
@@ -755,4 +751,4 @@ declare class Version {
 }
 
 export { BaseReporter, CancellationReason, CancellationToken, Cli, Color, Config, ConfigDiagnosticText, DescribeResult, Diagnostic, DiagnosticCategory, DiagnosticOrigin, Directive, DotReporter, EventEmitter, ExpectResult, FileLocation, FileResult, Line, ListReporter, OptionBrand, OptionGroup, Options, OutputService, Path, ProjectConfigKind, ProjectResult, Result, ResultStatus, Runner, Scribbler, ScribblerJsx, Select, SelectDiagnosticText, SetupReporter, Store, StreamController, SummaryReporter, SuppressedResult, TargetResult, TestResult, Text, Version, WatchReporter, addsText, defaultOptions, describeNameText, diagnosticBelongsToNode, diagnosticText, dotText, environmentOptions, fileStatusText, formattedText, getDiagnosticMessageText, getTextSpanEnd, helpText, isDiagnosticWithLocation, prologueText, summaryText, testNameText, usesText, waitingForFileChangesText, watchUsageText };
-export type { AssertionCounts, AssertionResultStatus, CliOptions, CodeFrameOptions, CommandLineOptions, ConfigFileOptions, DiagnosticsHandler, DirectiveRange, EnvironmentOptions, Event, EventHandler, FileCounts, FileResultStatus, InlineConfig, ItemDefinition, OptionDefinition, ProjectConfig, Reporter, ReporterEvent, ResolvedConfig, ResultCounts, ResultTiming, ScribblerOptions, SuppressedCounts, SuppressedResultStatus, TargetCounts, TargetResultStatus, TestCounts, TestResultStatus, TextRange, WriteStream };
+export type { AssertionCounts, AssertionResultStatus, CodeFrameOptions, CommandLineOptions, ConfigFileOptions, DiagnosticsHandler, DirectiveRange, EnvironmentOptions, Event, EventHandler, FileCounts, FileResultStatus, InlineConfig, ItemDefinition, OptionDefinition, ProjectConfig, Reporter, ReporterEvent, ResolvedConfig, ResultCounts, ResultTiming, ScribblerOptions, SuppressedCounts, SuppressedResultStatus, TargetCounts, TargetResultStatus, TestCounts, TestResultStatus, TextRange, WriteStream };

package/dist/api.js

@@ -56,25 +56,24 @@ class JsonNode {
         this.text = text;
     }
     getValue(options) {
-        if (this.text == null) {
-            return undefined;
-        }
-        if (/^['"]/.test(this.text)) {
-            return this.text.slice(1, -1).replaceAll("\\", "");
-        }
-        if (options?.expectsIdentifier) {
-            return this.text;
-        }
-        if (this.text === "true") {
-            return true;
-        }
-        if (this.text === "false") {
-            return false;
-        }
-        if (/^\d/.test(this.text)) {
-            return Number.parseFloat(this.text);
+        if (this.text != null) {
+            if (/^['"]/.test(this.text)) {
+                return this.text.slice(1, -1).replaceAll("\\", "");
+            }
+            if (options?.expectsIdentifier) {
+                return this.text;
+            }
+            if (this.text === "true") {
+                return true;
+            }
+            if (this.text === "false") {
+                return false;
+            }
+            if (/^\d/.test(this.text)) {
+                return Number.parseFloat(this.text);
+            }
         }
-        return undefined;
+        return;
     }
 }
 
@@ -730,7 +729,9 @@ class ManifestService {
         const versions = [];
         const packageMetadata = (await response.json());
         for (const [tag, meta] of Object.entries(packageMetadata.versions)) {
-            if (!tag.includes("-") && Version.isSatisfiedWith(tag, "5.4.2")) {
+            if (!tag.includes("-") &&
+                Version.isSatisfiedWith(tag, "5.4") &&
+                !Version.isSatisfiedWith(tag, "7.0")) {
                 versions.push(tag);
                 packages[tag] = { integrity: meta.dist.integrity, tarball: meta.dist.tarball };
             }
@@ -752,6 +753,7 @@ class ManifestService {
                 }
             }
         }
+        resolutions["latest"] = versions.findLast((version) => version.startsWith("6"));
         return new Manifest({ minorVersions, npmRegistry: this.#npmRegistry, packages, resolutions, versions });
     }
     async open(options) {
@@ -1795,22 +1797,23 @@ class CancellationHandler {
 }
 
 class ExitCodeHandler {
+    #exitCode = 0;
+    getExitCode() {
+        return this.#exitCode;
+    }
     on([event, payload]) {
         if (event === "run:start") {
-            this.resetCode();
+            this.#exitCode = 0;
             return;
         }
         if ("diagnostics" in payload) {
             if (payload.diagnostics.some((diagnostic) => diagnostic.category === "error")) {
-                this.#setCode(1);
+                this.#exitCode = 1;
             }
         }
     }
-    resetCode() {
-        this.#setCode(0);
-    }
-    #setCode(exitCode) {
-        process.exitCode = exitCode;
+    reset() {
+        this.#exitCode = 0;
     }
 }
 
@@ -4517,12 +4520,12 @@ class MatchWorker {
         this.typeChecker = program.getTypeChecker();
         this.assertionNode = assertionNode;
     }
+    checkIsAssignableFrom(sourceNode, targetNode) {
+        return this.#checkIsRelatedTo(targetNode, sourceNode);
+    }
     checkIsAssignableTo(sourceNode, targetNode) {
         return this.#checkIsRelatedTo(sourceNode, targetNode);
     }
-    checkIsAssignableWith(sourceNode, targetNode) {
-        return this.#checkIsRelatedTo(targetNode, sourceNode);
-    }
     #checkIsRelatedTo(sourceNode, targetNode) {
         const sourceType = this.getType(sourceNode);
         const targetType = this.getType(targetNode);
@@ -4623,9 +4626,6 @@ class ToAcceptProps {
                 if (!sourceProperty) {
                     return false;
                 }
-                if (this.#isOptionalProperty(targetProperty) && !this.#isOptionalProperty(sourceProperty)) {
-                    return false;
-                }
                 const targetPropertyType = this.#typeChecker.getTypeOfSymbol(targetProperty);
                 const sourcePropertyType = this.#typeChecker.getTypeOfSymbol(sourceProperty);
                 if (!this.#typeChecker.isTypeAssignableTo(targetPropertyType, sourcePropertyType)) {
@@ -4668,15 +4668,6 @@ class ToAcceptProps {
                     diagnostics.push(diagnostic.extendWith(text, origin));
                     continue;
                 }
-                if (this.#isOptionalProperty(targetProperty) && !this.#isOptionalProperty(sourceProperty)) {
-                    const text = [
-                        ExpectDiagnosticText.isNotAssignableFrom(sourceTypeText, targetTypeText),
-                        ExpectDiagnosticText.requiresProperty(sourceTypeText, targetPropertyName),
-                    ];
-                    const origin = matchWorker.resolveDiagnosticOrigin(targetProperty, targetNode);
-                    diagnostics.push(diagnostic.extendWith(text, origin));
-                    continue;
-                }
                 const targetPropertyType = this.#typeChecker.getTypeOfSymbol(targetProperty);
                 const sourcePropertyType = this.#typeChecker.getTypeOfSymbol(sourceProperty);
                 if (!this.#typeChecker.isTypeAssignableTo(targetPropertyType, sourcePropertyType)) {
@@ -4744,9 +4735,7 @@ class ToAcceptProps {
         const targetType = matchWorker.getType(targetNode);
         if (!(targetType.flags & this.#compiler.TypeFlags.Object)) {
             const expectedText = "of an object type";
-            const text = nodeBelongsToArgumentList(this.#compiler, targetNode)
-                ? ExpectDiagnosticText.argumentMustBe("target", expectedText)
-                : ExpectDiagnosticText.typeArgumentMustBe("Target", expectedText);
+            const text = ExpectDiagnosticText.argumentMustBe("props", expectedText);
             const origin = DiagnosticOrigin.fromNode(targetNode);
             diagnostics.push(Diagnostic.error(text, origin));
         }
@@ -5378,7 +5367,7 @@ class ToBeAssignableFrom extends RelationMatcherBase {
     match(matchWorker, sourceNode, targetNode) {
         return {
             explain: () => this.explain(matchWorker, sourceNode, targetNode),
-            isMatch: matchWorker.checkIsAssignableWith(sourceNode, targetNode),
+            isMatch: matchWorker.checkIsAssignableFrom(sourceNode, targetNode),
         };
     }
 }
@@ -6176,7 +6165,7 @@ class FileRunner {
 class Runner {
     #eventEmitter = new EventEmitter();
     #resolvedConfig;
-    static version = "7.0.0-beta.3";
+    static version = "7.0.0-beta.5";
     constructor(resolvedConfig) {
         this.#resolvedConfig = resolvedConfig;
     }
@@ -6275,15 +6264,20 @@ class CliDiagnosticText {
 class Cli {
     #deferredDiagnostics;
     #eventEmitter = new EventEmitter();
-    #noErrorExitCode;
-    constructor(options) {
-        this.#noErrorExitCode = options?.noErrorExitCode ?? false;
-    }
     async run(commandLine, cancellationToken = new CancellationToken()) {
+        const exitCodeHandler = new ExitCodeHandler();
+        this.#eventEmitter.addHandler(exitCodeHandler);
+        await this.#run(commandLine, exitCodeHandler, cancellationToken);
+        if (this.#deferredDiagnostics != null) {
+            OutputService.writeBlankLine();
+            OutputService.writeWarning(diagnosticText(this.#deferredDiagnostics));
+        }
+        this.#eventEmitter.removeHandlers();
+        return exitCodeHandler.getExitCode();
+    }
+    async #run(commandLine, exitCodeHandler, cancellationToken) {
         const cancellationHandler = new CancellationHandler(cancellationToken, "configError");
         this.#eventEmitter.addHandler(cancellationHandler);
-        const exitCodeHandler = new ExitCodeHandler();
-        !this.#noErrorExitCode && this.#eventEmitter.addHandler(exitCodeHandler);
         const setupReporter = new SetupReporter();
         this.#eventEmitter.addReporter(setupReporter);
         if (commandLine.includes("--help")) {
@@ -6325,7 +6319,7 @@ class Cli {
         do {
             if (cancellationToken.getReason() === "configChange") {
                 cancellationToken.reset();
-                exitCodeHandler.resetCode();
+                exitCodeHandler.reset();
                 OutputService.clearTerminal();
                 this.#eventEmitter.addHandler(cancellationHandler);
                 this.#eventEmitter.addReporter(setupReporter);
@@ -6367,11 +6361,6 @@ class Cli {
             const runner = new Runner(resolvedConfig);
             await runner.run(testFiles, cancellationToken);
         } while (cancellationToken.getReason() === "configChange");
-        if (this.#deferredDiagnostics != null) {
-            OutputService.writeBlankLine();
-            OutputService.writeWarning(diagnosticText(this.#deferredDiagnostics));
-        }
-        this.#eventEmitter.removeHandlers();
     }
     #waitForChangedFiles(resolvedConfig, cancellationToken) {
         return new Promise((resolve) => {

package/dist/bin.js

@@ -3,4 +3,5 @@ import process from 'node:process';
 import { Cli } from './api.js';
 
 const cli = new Cli();
-await cli.run(process.argv.slice(2));
+const commandLine = process.argv.slice(2);
+process.exitCode = await cli.run(commandLine);

package/dist/index.d.cts

@@ -74,16 +74,7 @@ interface Matchers {
     /**
      * Checks if the JSX component accepts the given props.
      */
-    toAcceptProps: {
-        /**
-         * Checks if the JSX component accepts props of the given type.
-         */
-        <Target>(): void;
-        /**
-         * Checks if the JSX component accepts the given props.
-         */
-        (target: unknown): void;
-    };
+    toAcceptProps: (props: Record<string, unknown>) => void;
     /**
      * Checks if the decorator is applicable to the given class or class member.
      */
@@ -104,8 +95,12 @@ interface Matchers {
      * Checks if the type has the given property.
      */
     toHaveProperty: (key: string | number | symbol) => void;
+}
+interface Matchers {
     /**
      * Checks if the type raises an error.
+     *
+     * @deprecated This matcher is planned to be removed. For a replacement, see https://tstyche.org/guides/expect-errors.
      */
     toRaiseError: (...target: Array<string | number | RegExp>) => void;
 }

package/dist/index.d.ts

@@ -74,16 +74,7 @@ interface Matchers {
     /**
      * Checks if the JSX component accepts the given props.
      */
-    toAcceptProps: {
-        /**
-         * Checks if the JSX component accepts props of the given type.
-         */
-        <Target>(): void;
-        /**
-         * Checks if the JSX component accepts the given props.
-         */
-        (target: unknown): void;
-    };
+    toAcceptProps: (props: Record<string, unknown>) => void;
     /**
      * Checks if the decorator is applicable to the given class or class member.
      */
@@ -104,8 +95,12 @@ interface Matchers {
      * Checks if the type has the given property.
      */
     toHaveProperty: (key: string | number | symbol) => void;
+}
+interface Matchers {
     /**
      * Checks if the type raises an error.
+     *
+     * @deprecated This matcher is planned to be removed. For a replacement, see https://tstyche.org/guides/expect-errors.
      */
     toRaiseError: (...target: Array<string | number | RegExp>) => void;
 }

package/dist/tag.js

@@ -1,31 +1,10 @@
-import { Cli, EventEmitter, CancellationToken } from './api.js';
+import { Cli } from './api.js';
 
-class StatusHandler {
-    #hasError = false;
-    hasError() {
-        return this.#hasError;
-    }
-    on([event, payload]) {
-        if (event === "run:start") {
-            this.#hasError = false;
-            return;
-        }
-        if ("diagnostics" in payload) {
-            if (payload.diagnostics.some((diagnostic) => diagnostic.category === "error")) {
-                this.#hasError = true;
-            }
-        }
-    }
-}
 async function tstyche(template, ...substitutions) {
-    const cli = new Cli({ noErrorExitCode: true });
+    const cli = new Cli();
     const commandLine = String.raw(template, ...substitutions).split(/\s+/);
-    const eventEmitter = new EventEmitter();
-    const statusHandler = new StatusHandler();
-    eventEmitter.addHandler(statusHandler);
-    await cli.run(commandLine, new CancellationToken());
-    eventEmitter.removeHandler(statusHandler);
-    if (statusHandler.hasError()) {
+    const exitCode = await cli.run(commandLine);
+    if (exitCode > 0) {
         throw new Error("TSTyche test run failed. Check the output above for details.");
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tstyche",
-  "version": "7.0.0-beta.3",
+  "version": "7.0.0-beta.5",
   "description": "Everything You Need for Type Testing.",
   "keywords": [
     "typescript",

package/schemas/config.json

@@ -0,0 +1,88 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "checkDeclarationFiles": {
+      "description": "Check declaration files for type errors.",
+      "default": true,
+      "type": "boolean"
+    },
+    "checkSuppressedErrors": {
+      "description": "Check errors silenced by '@ts-expect-error' directives.",
+      "default": true,
+      "type": "boolean"
+    },
+    "failFast": {
+      "description": "Stop running tests after the first failed assertion.",
+      "default": false,
+      "type": "boolean"
+    },
+    "fixtureFileMatch": {
+      "description": "The list of glob patterns matching the fixture files.",
+      "default": [
+        "**/__fixtures__/*.{ts,tsx}",
+        "**/fixtures/*.{ts,tsx}"
+      ],
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "type": "string"
+      }
+    },
+    "quiet": {
+      "description": "Silence all test runner output except errors and warnings.",
+      "default": false,
+      "type": "boolean"
+    },
+    "rejectAnyType": {
+      "description": "Reject the 'any' type passed as an argument to the 'expect()' function or a matcher.",
+      "default": true,
+      "type": "boolean"
+    },
+    "rejectNeverType": {
+      "description": "Reject the 'never' type passed as an argument to the 'expect()' function or a matcher.",
+      "default": true,
+      "type": "boolean"
+    },
+    "reporters": {
+      "description": "The list of reporters to use.",
+      "default": [
+        "list",
+        "summary"
+      ],
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "type": "string"
+      }
+    },
+    "target": {
+      "description": "The range of TypeScript versions to test against.",
+      "default": "*",
+      "type": "string"
+    },
+    "testFileMatch": {
+      "description": "The list of glob patterns matching the test files.",
+      "default": [
+        "**/*.tst.*",
+        "**/__typetests__/*.test.*",
+        "**/typetests/*.test.*"
+      ],
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "type": "string"
+      }
+    },
+    "tsconfig": {
+      "description": "The TSConfig to load.",
+      "default": "findup",
+      "type": "string"
+    },
+    "verbose": {
+      "description": "Enable detailed logging.",
+      "default": false,
+      "type": "boolean"
+    }
+  }
+}