tstyche 3.3.1 → 3.5.0

package/build/index.d.cts

@@ -216,26 +216,26 @@ interface Expect {
     /**
      * Builds an assertion.
      *
-     * @template Source - The type against which the assertion will be made.
+     * @template Source - The type against which the assertion is made.
      */
     <Source>(): Modifier;
     /**
      * Builds an assertion.
      *
-     * @param source - The expression against which type the assertion will be made.
+     * @param source - The expression against which type the assertion is made.
      */
     (source: unknown): Modifier;
     fail: {
         /**
          * Mark an assertion as supposed to fail.
          *
-         * @template Source - The type against which the assertion will be made.
+         * @template Source - The type against which the assertion is made.
          */
         <Source>(): Modifier;
         /**
          * Mark an assertion as supposed to fail.
          *
-         * @param source - The expression against which type the assertion will be made.
+         * @param source - The expression against which type the assertion is made.
          */
         (source: unknown): Modifier;
     };
@@ -246,26 +246,26 @@ interface Expect {
         /**
          * Marks an assertion as focused.
          *
-         * @template Source - The type against which the assertion will be made.
+         * @template Source - The type against which the assertion is made.
          */
         <Source>(): Modifier;
         /**
          * Marks an assertion as focused.
          *
-         * @param source - The expression against which type the assertion will be made.
+         * @param source - The expression against which type the assertion is made.
          */
         (source: unknown): Modifier;
         fail: {
             /**
              * Mark an assertion as supposed to fail.
              *
-             * @template Source - The type against which the assertion will be made.
+             * @template Source - The type against which the assertion is made.
              */
             <Source>(): Modifier;
             /**
              * Mark an assertion as supposed to fail.
              *
-             * @param source - The expression against which type the assertion will be made.
+             * @param source - The expression against which type the assertion is made.
              */
             (source: unknown): Modifier;
         };
@@ -277,26 +277,26 @@ interface Expect {
         /**
          * Marks an assertion as skipped.
          *
-         * @template Source - The type against which the assertion will be made.
+         * @template Source - The type against which the assertion is made.
          */
         <Source>(): Modifier;
         /**
          * Marks an assertion as skipped.
          *
-         * @param source - The expression against which type the assertion will be made.
+         * @param source - The expression against which type the assertion is made.
          */
         (source: unknown): Modifier;
         fail: {
             /**
              * Marks an assertion as supposed to fail.
              *
-             * @template Source - The type against which the assertion will be made.
+             * @template Source - The type against which the assertion is made.
              */
             <Source>(): Modifier;
             /**
              * Marks an assertion as supposed to fail.
              *
-             * @param source - The expression against which type the assertion will be made.
+             * @param source - The expression against which type the assertion is made.
              */
             (source: unknown): Modifier;
         };

package/build/index.d.ts

@@ -216,26 +216,26 @@ interface Expect {
     /**
      * Builds an assertion.
      *
-     * @template Source - The type against which the assertion will be made.
+     * @template Source - The type against which the assertion is made.
      */
     <Source>(): Modifier;
     /**
      * Builds an assertion.
      *
-     * @param source - The expression against which type the assertion will be made.
+     * @param source - The expression against which type the assertion is made.
      */
     (source: unknown): Modifier;
     fail: {
         /**
          * Mark an assertion as supposed to fail.
          *
-         * @template Source - The type against which the assertion will be made.
+         * @template Source - The type against which the assertion is made.
          */
         <Source>(): Modifier;
         /**
          * Mark an assertion as supposed to fail.
          *
-         * @param source - The expression against which type the assertion will be made.
+         * @param source - The expression against which type the assertion is made.
          */
         (source: unknown): Modifier;
     };
@@ -246,26 +246,26 @@ interface Expect {
         /**
          * Marks an assertion as focused.
          *
-         * @template Source - The type against which the assertion will be made.
+         * @template Source - The type against which the assertion is made.
          */
         <Source>(): Modifier;
         /**
          * Marks an assertion as focused.
          *
-         * @param source - The expression against which type the assertion will be made.
+         * @param source - The expression against which type the assertion is made.
          */
         (source: unknown): Modifier;
         fail: {
             /**
              * Mark an assertion as supposed to fail.
              *
-             * @template Source - The type against which the assertion will be made.
+             * @template Source - The type against which the assertion is made.
              */
             <Source>(): Modifier;
             /**
              * Mark an assertion as supposed to fail.
              *
-             * @param source - The expression against which type the assertion will be made.
+             * @param source - The expression against which type the assertion is made.
              */
             (source: unknown): Modifier;
         };
@@ -277,26 +277,26 @@ interface Expect {
         /**
          * Marks an assertion as skipped.
          *
-         * @template Source - The type against which the assertion will be made.
+         * @template Source - The type against which the assertion is made.
          */
         <Source>(): Modifier;
         /**
          * Marks an assertion as skipped.
          *
-         * @param source - The expression against which type the assertion will be made.
+         * @param source - The expression against which type the assertion is made.
          */
         (source: unknown): Modifier;
         fail: {
             /**
              * Marks an assertion as supposed to fail.
              *
-             * @template Source - The type against which the assertion will be made.
+             * @template Source - The type against which the assertion is made.
              */
             <Source>(): Modifier;
             /**
              * Marks an assertion as supposed to fail.
              *
-             * @param source - The expression against which type the assertion will be made.
+             * @param source - The expression against which type the assertion is made.
              */
             (source: unknown): Modifier;
         };

package/build/tstyche.d.ts

@@ -695,7 +695,13 @@ declare function addsPackageText(packageVersion: string, packagePath: string): S
 
 declare function describeNameText(name: string, indent?: number): ScribblerJsx.Element;
 
-declare function diagnosticText(diagnostic: Diagnostic): ScribblerJsx.Element;
+interface CodeFrameOptions {
+    linesAbove?: number;
+    linesBelow?: number;
+    showBreadcrumbs?: boolean;
+}
+
+declare function diagnosticText(diagnostic: Diagnostic, codeFrameOptions?: CodeFrameOptions): ScribblerJsx.Element;
 
 declare function taskStatusText(status: TaskResultStatus, task: Task): ScribblerJsx.Element;
 
@@ -871,4 +877,4 @@ declare class WatchService {
     watch(cancellationToken: CancellationToken): AsyncIterable<Array<Task>>;
 }
 
-export { Assertion, BaseReporter, CancellationHandler, CancellationReason, CancellationToken, Cli, CollectService, Color, type CommandLineOptions, Config, ConfigDiagnosticText, type ConfigFileOptions, DescribeResult, Diagnostic, DiagnosticCategory, DiagnosticOrigin, type DiagnosticsHandler, type EnvironmentOptions, type Event, EventEmitter, type EventHandler, ExitCodeHandler, ExpectResult, ExpectService, type FileWatchHandler, FileWatcher, type InputHandler, InputService, type ItemDefinition, Line, ListReporter, type MatchResult, OptionBrand, type OptionDefinition, OptionGroup, Options, OutputService, Path, type Plugin, PluginService, ProjectResult, ProjectService, type Reporter, type ReporterEvent, type ResolvedConfig, Result, ResultCount, ResultHandler, ResultStatus, ResultTiming, Runner, Scribbler, ScribblerJsx, type ScribblerOptions, Select, SelectDiagnosticText, type SelectHookContext, SetupReporter, SourceFile, Store, SummaryReporter, TargetResult, type TargetResultStatus, Task, TaskResult, type TaskResultStatus, TestMember, TestMemberBrand, TestMemberFlags, TestResult, TestTree, Text, type TypeChecker, Version, type WatchHandler, WatchReporter, WatchService, Watcher, type WatcherOptions, addsPackageText, defaultOptions, describeNameText, diagnosticText, environmentOptions, fileViewText, formattedText, helpText, summaryText, taskStatusText, testNameText, usesCompilerText, waitingForFileChangesText, watchUsageText };
+export { Assertion, BaseReporter, CancellationHandler, CancellationReason, CancellationToken, Cli, type CodeFrameOptions, CollectService, Color, type CommandLineOptions, Config, ConfigDiagnosticText, type ConfigFileOptions, DescribeResult, Diagnostic, DiagnosticCategory, DiagnosticOrigin, type DiagnosticsHandler, type EnvironmentOptions, type Event, EventEmitter, type EventHandler, ExitCodeHandler, ExpectResult, ExpectService, type FileWatchHandler, FileWatcher, type InputHandler, InputService, type ItemDefinition, Line, ListReporter, type MatchResult, OptionBrand, type OptionDefinition, OptionGroup, Options, OutputService, Path, type Plugin, PluginService, ProjectResult, ProjectService, type Reporter, type ReporterEvent, type ResolvedConfig, Result, ResultCount, ResultHandler, ResultStatus, ResultTiming, Runner, Scribbler, ScribblerJsx, type ScribblerOptions, Select, SelectDiagnosticText, type SelectHookContext, SetupReporter, SourceFile, Store, SummaryReporter, TargetResult, type TargetResultStatus, Task, TaskResult, type TaskResultStatus, TestMember, TestMemberBrand, TestMemberFlags, TestResult, TestTree, Text, type TypeChecker, Version, type WatchHandler, WatchReporter, WatchService, Watcher, type WatcherOptions, addsPackageText, defaultOptions, describeNameText, diagnosticText, environmentOptions, fileViewText, formattedText, helpText, summaryText, taskStatusText, testNameText, usesCompilerText, waitingForFileChangesText, watchUsageText };

package/build/tstyche.js

@@ -1157,11 +1157,11 @@ class CommandLineParser {
         this.#onDiagnostics = onDiagnostics;
         this.#options = Options.for(OptionGroup.CommandLine);
     }
-    async #onExpectsValue(optionName, optionBrand) {
+    #onExpectsValue(optionName, optionBrand) {
         const text = [
             ConfigDiagnosticText.expectsValue(optionName),
-            await ConfigDiagnosticText.usage(optionName, optionBrand),
-        ].flat();
+            ...ConfigDiagnosticText.usage(optionName, optionBrand),
+        ];
         this.#onDiagnostics(Diagnostic.error(text));
     }
     async parse(commandLineArgs) {
@@ -1215,7 +1215,7 @@ class CommandLineParser {
                     index++;
                     break;
                 }
-                await this.#onExpectsValue(optionName, optionDefinition.brand);
+                this.#onExpectsValue(optionName, optionDefinition.brand);
                 break;
             case OptionBrand.String:
                 if (optionValue !== "") {
@@ -1225,7 +1225,7 @@ class CommandLineParser {
                     index++;
                     break;
                 }
-                await this.#onExpectsValue(optionName, optionDefinition.brand);
+                this.#onExpectsValue(optionName, optionDefinition.brand);
                 break;
         }
         return index;
@@ -2013,12 +2013,15 @@ function CodeLineText({ gutterWidth, lineNumber, lineNumberColor = Color.Gray, l
 function SquiggleLineText({ gutterWidth, indentWidth = 0, squiggleColor, squiggleWidth }) {
     return (jsx(Line, { children: [" ".repeat(gutterWidth), jsx(Text, { color: Color.Gray, children: " | " }), " ".repeat(indentWidth), jsx(Text, { color: squiggleColor, children: "~".repeat(squiggleWidth === 0 ? 1 : squiggleWidth) })] }));
 }
-function CodeSpanText({ diagnosticCategory, diagnosticOrigin }) {
+function CodeFrameText({ diagnosticCategory, diagnosticOrigin, options }) {
+    const linesAbove = options?.linesAbove ?? 2;
+    const linesBelow = options?.linesBelow ?? 3;
+    const showBreadcrumbs = options?.showBreadcrumbs ?? true;
     const lineMap = diagnosticOrigin.sourceFile.getLineStarts();
     const { character: firstMarkedLineCharacter, line: firstMarkedLine } = diagnosticOrigin.sourceFile.getLineAndCharacterOfPosition(diagnosticOrigin.start);
     const { character: lastMarkedLineCharacter, line: lastMarkedLine } = diagnosticOrigin.sourceFile.getLineAndCharacterOfPosition(diagnosticOrigin.end);
-    const firstLine = Math.max(firstMarkedLine - 2, 0);
-    const lastLine = Math.min(firstLine + 5, lineMap.length - 1);
+    const firstLine = Math.max(firstMarkedLine - linesAbove, 0);
+    const lastLine = Math.min(lastMarkedLine + linesBelow, lineMap.length - 1);
     const gutterWidth = (lastLine + 1).toString().length + 2;
     let highlightColor;
     switch (diagnosticCategory) {
@@ -2029,43 +2032,47 @@ function CodeSpanText({ diagnosticCategory, diagnosticOrigin }) {
             highlightColor = Color.Yellow;
             break;
     }
-    const codeSpan = [];
+    const codeFrame = [];
     for (let index = firstLine; index <= lastLine; index++) {
         const lineStart = lineMap[index];
         const lineEnd = index === lineMap.length - 1 ? diagnosticOrigin.sourceFile.text.length : lineMap[index + 1];
         const lineText = diagnosticOrigin.sourceFile.text.slice(lineStart, lineEnd).trimEnd().replace(/\t/g, " ");
         if (index >= firstMarkedLine && index <= lastMarkedLine) {
-            codeSpan.push(jsx(CodeLineText, { gutterWidth: gutterWidth, lineNumber: index + 1, lineNumberColor: highlightColor, lineText: lineText }));
+            codeFrame.push(jsx(CodeLineText, { gutterWidth: gutterWidth, lineNumber: index + 1, lineNumberColor: highlightColor, lineText: lineText }));
             if (index === firstMarkedLine) {
                 const squiggleLength = index === lastMarkedLine
                     ? lastMarkedLineCharacter - firstMarkedLineCharacter
                     : lineText.length - firstMarkedLineCharacter;
-                codeSpan.push(jsx(SquiggleLineText, { gutterWidth: gutterWidth, indentWidth: firstMarkedLineCharacter, squiggleColor: highlightColor, squiggleWidth: squiggleLength }));
+                codeFrame.push(jsx(SquiggleLineText, { gutterWidth: gutterWidth, indentWidth: firstMarkedLineCharacter, squiggleColor: highlightColor, squiggleWidth: squiggleLength }));
             }
             else if (index === lastMarkedLine) {
-                codeSpan.push(jsx(SquiggleLineText, { gutterWidth: gutterWidth, squiggleColor: highlightColor, squiggleWidth: lastMarkedLineCharacter }));
+                codeFrame.push(jsx(SquiggleLineText, { gutterWidth: gutterWidth, squiggleColor: highlightColor, squiggleWidth: lastMarkedLineCharacter }));
             }
             else {
-                codeSpan.push(jsx(SquiggleLineText, { gutterWidth: gutterWidth, squiggleColor: highlightColor, squiggleWidth: lineText.length }));
+                codeFrame.push(jsx(SquiggleLineText, { gutterWidth: gutterWidth, squiggleColor: highlightColor, squiggleWidth: lineText.length }));
             }
         }
         else {
-            codeSpan.push(jsx(CodeLineText, { gutterWidth: gutterWidth, lineNumber: index + 1, lineText: lineText }));
+            codeFrame.push(jsx(CodeLineText, { gutterWidth: gutterWidth, lineNumber: index + 1, lineText: lineText }));
         }
     }
-    const location = (jsx(Line, { children: [" ".repeat(gutterWidth + 2), jsx(Text, { color: Color.Gray, children: " at " }), jsx(Text, { color: Color.Cyan, children: Path.relative("", diagnosticOrigin.sourceFile.fileName) }), jsx(Text, { color: Color.Gray, children: `:${firstMarkedLine + 1}:${firstMarkedLineCharacter + 1}` }), diagnosticOrigin.assertion && jsx(BreadcrumbsText, { ancestor: diagnosticOrigin.assertion.parent })] }));
-    return (jsx(Text, { children: [codeSpan, jsx(Line, {}), location] }));
+    let breadcrumbs;
+    if (showBreadcrumbs && diagnosticOrigin.assertion != null) {
+        breadcrumbs = jsx(BreadcrumbsText, { ancestor: diagnosticOrigin.assertion.parent });
+    }
+    const location = (jsx(Line, { children: [" ".repeat(gutterWidth + 2), jsx(Text, { color: Color.Gray, children: " at " }), jsx(Text, { color: Color.Cyan, children: Path.relative("", diagnosticOrigin.sourceFile.fileName) }), jsx(Text, { color: Color.Gray, children: `:${firstMarkedLine + 1}:${firstMarkedLineCharacter + 1}` }), breadcrumbs] }));
+    return (jsx(Text, { children: [codeFrame, jsx(Line, {}), location] }));
 }
 
-function DiagnosticText({ diagnostic }) {
+function DiagnosticText({ codeFrameOptions, diagnostic }) {
     const code = diagnostic.code ? jsx(Text, { color: Color.Gray, children: [" ", diagnostic.code] }) : undefined;
     const text = Array.isArray(diagnostic.text) ? diagnostic.text : [diagnostic.text];
     const message = text.map((text, index) => (jsx(Text, { children: [index === 1 ? jsx(Line, {}) : undefined, jsx(Line, { children: [text, index === 0 ? code : undefined] })] })));
     const related = diagnostic.related?.map((relatedDiagnostic) => jsx(DiagnosticText, { diagnostic: relatedDiagnostic }));
-    const codeSpan = diagnostic.origin ? (jsx(Text, { children: [jsx(Line, {}), jsx(CodeSpanText, { diagnosticCategory: diagnostic.category, diagnosticOrigin: diagnostic.origin })] })) : undefined;
-    return (jsx(Text, { children: [message, codeSpan, jsx(Line, {}), jsx(Text, { indent: 2, children: related })] }));
+    const codeFrame = diagnostic.origin ? (jsx(Text, { children: [jsx(Line, {}), jsx(CodeFrameText, { diagnosticCategory: diagnostic.category, diagnosticOrigin: diagnostic.origin, options: codeFrameOptions })] })) : undefined;
+    return (jsx(Text, { children: [message, codeFrame, jsx(Line, {}), jsx(Text, { indent: 2, children: related })] }));
 }
-function diagnosticText(diagnostic) {
+function diagnosticText(diagnostic, codeFrameOptions = {}) {
     let prefix;
     switch (diagnostic.category) {
         case DiagnosticCategory.Error:
@@ -2075,7 +2082,7 @@ function diagnosticText(diagnostic) {
             prefix = jsx(Text, { color: Color.Yellow, children: "Warning: " });
             break;
     }
-    return (jsx(Text, { children: [prefix, jsx(DiagnosticText, { diagnostic: diagnostic })] }));
+    return (jsx(Text, { children: [prefix, jsx(DiagnosticText, { codeFrameOptions: codeFrameOptions, diagnostic: diagnostic })] }));
 }
 
 function FileNameText({ filePath }) {
@@ -2841,26 +2848,28 @@ class WatchService {
             cancellationToken.cancel(reason);
             debounce.resolveWith([]);
         };
-        const onInput = (chunk) => {
-            switch (chunk.toLowerCase()) {
-                case "\u0003":
-                case "\u0004":
-                case "\u001B":
-                case "q":
-                case "x":
-                    onClose(CancellationReason.WatchClose);
-                    break;
-                case "\u000D":
-                case "\u0020":
-                case "a":
-                    debounce.clearTimeout();
-                    if (this.#watchedTestFiles.size > 0) {
-                        debounce.resolveWith([...this.#watchedTestFiles.values()]);
-                    }
-                    break;
-            }
-        };
-        this.#inputService = new InputService(onInput);
+        if (!environmentOptions.noInteractive) {
+            const onInput = (chunk) => {
+                switch (chunk.toLowerCase()) {
+                    case "\u0003":
+                    case "\u0004":
+                    case "\u001B":
+                    case "q":
+                    case "x":
+                        onClose(CancellationReason.WatchClose);
+                        break;
+                    case "\u000D":
+                    case "\u0020":
+                    case "a":
+                        debounce.clearTimeout();
+                        if (this.#watchedTestFiles.size > 0) {
+                            debounce.resolveWith([...this.#watchedTestFiles.values()]);
+                        }
+                        break;
+                }
+            };
+            this.#inputService = new InputService(onInput);
+        }
         const onChangedFile = (filePath) => {
             debounce.refreshTimeout();
             let task = this.#watchedTestFiles.get(filePath);
@@ -3475,10 +3484,10 @@ class MatchWorker {
     }
     #checkIsRelatedTo(sourceNode, targetNode, relation) {
         const sourceType = relation === this.#typeChecker.relation.identity
-            ? this.#trySimplifyType(this.getType(sourceNode))
+            ? this.#simplifyType(this.getType(sourceNode))
             : this.getType(sourceNode);
         const targetType = relation === this.#typeChecker.relation.identity
-            ? this.#trySimplifyType(this.getType(targetNode))
+            ? this.#simplifyType(this.getType(targetNode))
             : this.getType(targetNode);
         return this.#typeChecker.isTypeRelatedTo(sourceType, targetType, relation);
     }
@@ -3509,7 +3518,7 @@ class MatchWorker {
         return this.#typeChecker.typeToString(type);
     }
     getType(node) {
-        return this.#compiler.isExpression(node) ? this.#getTypeOfNode(node) : this.#getTypeOfTypeNode(node);
+        return this.#compiler.isTypeNode(node) ? this.#getTypeOfTypeNode(node) : this.#getTypeOfNode(node);
     }
     #getTypeOfNode(node) {
         let type = this.#typeCache.get(node);
@@ -3548,10 +3557,10 @@ class MatchWorker {
         }
         return DiagnosticOrigin.fromNode(enclosingNode, this.assertion);
     }
-    #trySimplifyType(type) {
-        if (type.isIntersection() || type.isUnion()) {
-            const candidateType = type.types[0];
-            if (type.types.every((type) => this.#typeChecker.isTypeRelatedTo(type, candidateType, this.#typeChecker.relation.identity))) {
+    #simplifyType(type) {
+        if (type.isUnionOrIntersection()) {
+            const candidateType = this.#simplifyType(type.types[0]);
+            if (type.types.every((type) => this.#typeChecker.isTypeRelatedTo(this.#simplifyType(type), candidateType, this.#typeChecker.relation.identity))) {
                 return candidateType;
             }
         }
@@ -4334,11 +4343,15 @@ class TaskRunner {
 class Runner {
     #eventEmitter = new EventEmitter();
     #resolvedConfig;
-    static version = "3.3.1";
+    static version = "3.5.0";
     constructor(resolvedConfig) {
         this.#resolvedConfig = resolvedConfig;
     }
     async #addReporters() {
+        if (this.#resolvedConfig.watch && !environmentOptions.noInteractive) {
+            const watchReporter = new WatchReporter(this.#resolvedConfig);
+            this.#eventEmitter.addReporter(watchReporter);
+        }
         for (const reporter of this.#resolvedConfig.reporters) {
             switch (reporter) {
                 case "list": {
@@ -4358,10 +4371,6 @@ class Runner {
                 }
             }
         }
-        if (this.#resolvedConfig.watch) {
-            const watchReporter = new WatchReporter(this.#resolvedConfig);
-            this.#eventEmitter.addReporter(watchReporter);
-        }
     }
     async run(testFiles, cancellationToken = new CancellationToken()) {
         const tasks = testFiles.map((testFile) => (testFile instanceof Task ? testFile : new Task(testFile)));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tstyche",
-  "version": "3.3.1",
+  "version": "3.5.0",
   "description": "The Essential Type Testing Tool.",
   "keywords": [
     "typescript",
@@ -63,17 +63,17 @@
   "devDependencies": {
     "@biomejs/biome": "1.9.4",
     "@rollup/plugin-typescript": "12.1.2",
-    "@types/node": "22.10.2",
-    "@types/react": "19.0.2",
+    "@types/node": "22.10.6",
+    "@types/react": "19.0.6",
     "ajv": "8.17.1",
-    "cspell": "8.17.1",
+    "cspell": "8.17.2",
     "magic-string": "0.30.17",
-    "monocart-coverage-reports": "2.11.5",
+    "monocart-coverage-reports": "2.11.6",
     "pretty-ansi": "3.0.0",
-    "rollup": "4.29.1",
+    "rollup": "4.30.1",
     "rollup-plugin-dts": "6.1.1",
     "tslib": "2.8.1",
-    "typescript": "5.7.2"
+    "typescript": "5.7.3"
   },
   "peerDependencies": {
     "typescript": "4.x || 5.x"