tstyche 6.1.0 → 6.2.0

package/dist/tstyche.d.ts

@@ -156,6 +156,7 @@ interface CommandLineOptions {
     target?: Array<string>;
     tsconfig?: string;
     update?: boolean;
+    verbose?: boolean;
     version?: boolean;
     watch?: boolean;
 }
@@ -172,6 +173,7 @@ interface ConfigFileOptions {
     target?: Array<string>;
     testFileMatch?: Array<string>;
     tsconfig?: string;
+    verbose?: boolean;
 }
 
 interface InlineConfig {
@@ -308,6 +310,11 @@ declare abstract class BaseReporter implements Reporter {
     abstract on([event, payload]: ReporterEvent): void;
 }
 
+declare class DotReporter extends BaseReporter {
+    #private;
+    on([event, payload]: ReporterEvent): void;
+}
+
 declare class ListReporter extends BaseReporter {
     #private;
     on([event, payload]: ReporterEvent): void;
@@ -592,7 +599,9 @@ interface TextProps {
 }
 declare function Text({ children, color, indent }: TextProps): ScribblerJsx.Element;
 
-declare function addsPackageText(packageVersion: string, packagePath: string): ScribblerJsx.Element;
+declare function addsPackageText(packageVersion: string, packagePath: string, options?: {
+    short?: boolean;
+}): ScribblerJsx.Element;
 
 declare function describeNameText(name: string, indent?: number): ScribblerJsx.Element;
 
@@ -604,9 +613,9 @@ interface CodeFrameOptions {
 
 declare function diagnosticText(diagnostic: Diagnostic, codeFrameOptions?: CodeFrameOptions): ScribblerJsx.Element;
 
-declare function fileStatusText(status: FileResultStatus, file: FileLocation): ScribblerJsx.Element;
+declare function dotText(status: ResultStatus): ScribblerJsx.Element;
 
-declare function fileViewText(lines: Array<ScribblerJsx.Element>, addEmptyFinalLine: boolean): ScribblerJsx.Element;
+declare function fileStatusText(status: FileResultStatus, file: FileLocation): ScribblerJsx.Element;
 
 declare function formattedText(input: string | Array<string> | Record<string, unknown>): ScribblerJsx.Element;
 
@@ -626,6 +635,7 @@ declare class OutputService {
     static outputStream: StreamController;
     static clearTerminal(): void;
     static eraseLastLine(): void;
+    static writeBlankLine(count?: number): void;
     static writeError(element: ScribblerJsx.Element | Array<ScribblerJsx.Element>): void;
     static writeMessage(element: ScribblerJsx.Element | Array<ScribblerJsx.Element>): void;
     static writeWarning(element: ScribblerJsx.Element | Array<ScribblerJsx.Element>): void;
@@ -646,7 +656,8 @@ declare function summaryText({ targetCounts, fileCounts, testCounts, assertionCo
 declare function testNameText(status: Exclude<TestResultStatus, ResultStatus.Runs>, name: string, indent?: number): ScribblerJsx.Element;
 
 declare function usesCompilerText(compilerVersion: string, projectConfigFilePath: string | undefined, options?: {
-    prependEmptyLine: boolean;
+    prependEmptyLine?: boolean;
+    short?: boolean;
 }): ScribblerJsx.Element;
 
 declare function waitingForFileChangesText(): ScribblerJsx.Element;
@@ -732,5 +743,5 @@ declare class Version {
     static isSatisfiedWith(source: string, target: string): boolean;
 }
 
-export { BaseReporter, CancellationReason, CancellationToken, Cli, Color, Config, ConfigDiagnosticText, DescribeResult, Diagnostic, DiagnosticCategory, DiagnosticOrigin, Directive, EventEmitter, ExpectResult, FileLocation, FileResult, Line, ListReporter, OptionBrand, OptionGroup, Options, OutputService, Path, ProjectResult, Result, ResultStatus, Runner, Scribbler, ScribblerJsx, Select, SelectDiagnosticText, SetupReporter, Store, StreamController, SummaryReporter, SuppressedResult, TargetResult, TestResult, Text, Version, WatchReporter, addsPackageText, defaultOptions, describeNameText, diagnosticBelongsToNode, diagnosticText, environmentOptions, fileStatusText, fileViewText, formattedText, getDiagnosticMessageText, getTextSpanEnd, helpText, isDiagnosticWithLocation, prologueText, summaryText, testNameText, usesCompilerText, waitingForFileChangesText, watchUsageText };
+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, ProjectResult, Result, ResultStatus, Runner, Scribbler, ScribblerJsx, Select, SelectDiagnosticText, SetupReporter, Store, StreamController, SummaryReporter, SuppressedResult, TargetResult, TestResult, Text, Version, WatchReporter, addsPackageText, defaultOptions, describeNameText, diagnosticBelongsToNode, diagnosticText, dotText, environmentOptions, fileStatusText, formattedText, getDiagnosticMessageText, getTextSpanEnd, helpText, isDiagnosticWithLocation, prologueText, summaryText, testNameText, usesCompilerText, waitingForFileChangesText, watchUsageText };
 export type { AssertionCounts, AssertionResultStatus, CodeFrameOptions, CommandLineOptions, ConfigFileOptions, DiagnosticsHandler, DirectiveRange, EnvironmentOptions, Event, EventHandler, FileCounts, FileResultStatus, InlineConfig, ItemDefinition, OptionDefinition, Reporter, ReporterEvent, ResolvedConfig, ResultCounts, ResultTiming, ScribblerOptions, SuppressedCounts, SuppressedResultStatus, TargetCounts, TargetResultStatus, TestCounts, TestResultStatus, TextRange };

package/dist/tstyche.js

@@ -375,7 +375,7 @@ class ConfigDiagnosticText {
     static fileMatchPatternCannotStartWith(optionName, segment) {
         return [
             `A '${optionName}' pattern cannot start with '${segment}'.`,
-            "The files are only collected within the 'rootPath' directory.",
+            "The files are only collected within the root directory.",
         ];
     }
     static inspectSupportedVersions() {
@@ -1179,6 +1179,12 @@ class Options {
             group: 2,
             name: "update",
         },
+        {
+            brand: "boolean",
+            description: "Enable detailed logging.",
+            group: 2 | 4,
+            name: "verbose",
+        },
         {
             brand: "true",
             description: "Print the version number and exit.",
@@ -1205,7 +1211,7 @@ class Options {
         return optionName.startsWith("--") ? optionName.slice(2) : optionName;
     }
     static #isBuiltinReporter(optionValue) {
-        return ["list", "summary"].includes(optionValue);
+        return ["dot", "list", "summary"].includes(optionValue);
     }
     static #isLookupStrategy(optionValue) {
         return ["findup", "ignore"].includes(optionValue);
@@ -1578,6 +1584,7 @@ const defaultOptions = {
     target: ["*"],
     testFileMatch: ["**/*.tst.*", "**/__typetests__/*.test.*", "**/typetests/*.test.*"],
     tsconfig: "findup",
+    verbose: false,
 };
 
 class Config {
@@ -2222,7 +2229,10 @@ class Scribbler {
     }
 }
 
-function addsPackageText(packageVersion, packagePath) {
+function addsPackageText(packageVersion, packagePath, options) {
+    if (options?.short) {
+        return (jsx(Line, { children: jsx(Text, { color: "90", children: packageVersion }) }));
+    }
     return (jsx(Line, { children: [jsx(Text, { color: "90", children: "adds" }), " TypeScript ", packageVersion, jsx(Text, { color: "90", children: [" to ", packagePath] })] }));
 }
 
@@ -2319,6 +2329,16 @@ function diagnosticText(diagnostic, codeFrameOptions = {}) {
     return (jsx(Text, { children: [prefix, jsx(DiagnosticText, { codeFrameOptions: codeFrameOptions, diagnostic: diagnostic })] }));
 }
 
+function dotText(status) {
+    let statusColor;
+    let statusText = "·";
+    if (status === "failed") {
+        statusColor = "31";
+        statusText = "×";
+    }
+    return jsx(Text, { color: statusColor, children: statusText });
+}
+
 function getStatusColor(status) {
     switch (status) {
         case "runs":
@@ -2366,10 +2386,6 @@ function fileStatusText(status, file) {
     return (jsx(Line, { children: [jsx(Text, { color: getStatusColor(status), children: statusText }), " ", jsx(FileNameText, { filePath: file.path })] }));
 }
 
-function fileViewText(lines, addEmptyFinalLine) {
-    return (jsx(Text, { children: [[...lines], addEmptyFinalLine ? jsx(Line, {}) : undefined] }));
-}
-
 function formattedText(input) {
     if (typeof input === "string") {
         return jsx(Line, { children: input });
@@ -2460,7 +2476,8 @@ class OutputService {
     static errorStream = new StreamController(process.stderr);
     static outputStream = new StreamController(process.stdout);
     static #isClear = false;
-    static #scribbler = new Scribbler();
+    static #newLine = "\n";
+    static #scribbler = new Scribbler({ newLine: OutputService.#newLine });
     static clearTerminal() {
         if (!OutputService.#isClear) {
             OutputService.outputStream.write("\u001B[2J\u001B[3J\u001B[H");
@@ -2470,21 +2487,24 @@ class OutputService {
     static eraseLastLine() {
         OutputService.outputStream.write("\u001B[1A\u001B[0K");
     }
-    static #writeTo(stream, element) {
+    static #write(stream, element) {
         const elements = Array.isArray(element) ? element : [element];
         for (const element of elements) {
             stream.write(OutputService.#scribbler.render(element));
         }
         OutputService.#isClear = false;
     }
+    static writeBlankLine(count = 1) {
+        OutputService.outputStream.write(OutputService.#newLine.repeat(count));
+    }
     static writeError(element) {
-        OutputService.#writeTo(OutputService.errorStream, element);
+        OutputService.#write(OutputService.errorStream, element);
     }
     static writeMessage(element) {
-        OutputService.#writeTo(OutputService.outputStream, element);
+        OutputService.#write(OutputService.outputStream, element);
     }
     static writeWarning(element) {
-        OutputService.#writeTo(OutputService.errorStream, element);
+        OutputService.#write(OutputService.errorStream, element);
     }
 }
 
@@ -2544,6 +2564,9 @@ function testNameText(status, name, indent = 0) {
 }
 
 function usesCompilerText(compilerVersion, projectConfigFilePath, options) {
+    if (options?.short) {
+        return jsx(Text, { color: "34", children: compilerVersion });
+    }
     let projectConfigPathText;
     if (projectConfigFilePath != null) {
         projectConfigPathText = (jsx(Text, { color: "90", children: [" with ", Path.relative("", projectConfigFilePath)] }));
@@ -2573,6 +2596,55 @@ class BaseReporter {
     }
 }
 
+class DotReporter extends BaseReporter {
+    #diagnostics = [];
+    #hasReportedAdds = false;
+    on([event, payload]) {
+        switch (event) {
+            case "store:adds":
+                OutputService.writeMessage(addsPackageText(payload.packageVersion, payload.packagePath, { short: true }));
+                this.#hasReportedAdds = true;
+                break;
+            case "store:error":
+                for (const diagnostic of payload.diagnostics) {
+                    OutputService.writeError(diagnosticText(diagnostic));
+                }
+                break;
+            case "project:uses":
+                if (this.#hasReportedAdds) {
+                    if (!environmentOptions.noInteractive) {
+                        OutputService.eraseLastLine();
+                    }
+                    this.#hasReportedAdds = false;
+                }
+                if (this.resolvedConfig.target.length > 1) {
+                    OutputService.writeMessage(usesCompilerText(payload.compilerVersion, payload.projectConfigFilePath, { short: true }));
+                }
+                break;
+            case "target:end":
+                OutputService.writeBlankLine(2);
+                for (const diagnostic of this.#diagnostics) {
+                    OutputService.writeError(diagnosticText(diagnostic));
+                }
+                this.#diagnostics = [];
+                break;
+            case "file:end":
+                OutputService.writeMessage(dotText(payload.result.status));
+                break;
+            case "project:error":
+            case "file:error":
+            case "directive:error":
+            case "collect:error":
+            case "test:error":
+            case "suppressed:error":
+            case "expect:error":
+            case "expect:fail":
+                this.#diagnostics.push(...payload.diagnostics);
+                break;
+        }
+    }
+}
+
 class FileView {
     #indent = 0;
     #lines = [];
@@ -2598,8 +2670,8 @@ class FileView {
     getMessages() {
         return this.#messages;
     }
-    getViewText(options) {
-        return fileViewText(this.#lines, options?.appendEmptyLine || this.hasErrors());
+    getView() {
+        return this.#lines;
     }
     hasErrors() {
         return this.#messages.length > 0;
@@ -2612,14 +2684,12 @@ class ListReporter extends BaseReporter {
     #hasReportedAdds = false;
     #hasReportedError = false;
     #hasReportedUses = false;
-    #isFileViewExpanded = false;
-    #isLastFile() {
-        return this.#fileCount === 0;
-    }
+    #isVerbose = false;
     on([event, payload]) {
         switch (event) {
             case "run:start":
-                this.#isFileViewExpanded = payload.result.files.length === 1 && this.resolvedConfig.watch !== true;
+                this.#isVerbose =
+                    this.resolvedConfig.verbose || (payload.result.files.length === 1 && this.resolvedConfig.watch !== true);
                 break;
             case "store:adds":
                 OutputService.writeMessage(addsPackageText(payload.packageVersion, payload.packagePath));
@@ -2666,7 +2736,10 @@ class ListReporter extends BaseReporter {
                     OutputService.eraseLastLine();
                 }
                 OutputService.writeMessage(fileStatusText(payload.result.status, payload.result.file));
-                OutputService.writeMessage(this.#fileView.getViewText({ appendEmptyLine: this.#isLastFile() }));
+                OutputService.writeMessage(this.#fileView.getView());
+                if (this.#isVerbose || this.#fileCount === 0 || this.#fileView.hasErrors()) {
+                    OutputService.writeBlankLine();
+                }
                 if (this.#fileView.hasErrors()) {
                     OutputService.writeError(this.#fileView.getMessages());
                     this.#hasReportedError = true;
@@ -2674,32 +2747,32 @@ class ListReporter extends BaseReporter {
                 this.#fileView.clear();
                 break;
             case "describe:start":
-                if (this.#isFileViewExpanded) {
+                if (this.#isVerbose) {
                     this.#fileView.beginDescribe(payload.result.describe.name);
                 }
                 break;
             case "describe:end":
-                if (this.#isFileViewExpanded) {
+                if (this.#isVerbose) {
                     this.#fileView.endDescribe();
                 }
                 break;
             case "test:skip":
-                if (this.#isFileViewExpanded) {
+                if (this.#isVerbose) {
                     this.#fileView.addTest("skipped", payload.result.test.name);
                 }
                 break;
             case "test:fixme":
-                if (this.#isFileViewExpanded) {
+                if (this.#isVerbose) {
                     this.#fileView.addTest("fixme", payload.result.test.name);
                 }
                 break;
             case "test:todo":
-                if (this.#isFileViewExpanded) {
+                if (this.#isVerbose) {
                     this.#fileView.addTest("todo", payload.result.test.name);
                 }
                 break;
             case "test:error":
-                if (this.#isFileViewExpanded) {
+                if (this.#isVerbose) {
                     this.#fileView.addTest("failed", payload.result.test.name);
                 }
                 for (const diagnostic of payload.diagnostics) {
@@ -2707,12 +2780,12 @@ class ListReporter extends BaseReporter {
                 }
                 break;
             case "test:fail":
-                if (this.#isFileViewExpanded) {
+                if (this.#isVerbose) {
                     this.#fileView.addTest("failed", payload.result.test.name);
                 }
                 break;
             case "test:pass":
-                if (this.#isFileViewExpanded) {
+                if (this.#isVerbose) {
                     this.#fileView.addTest("passed", payload.result.test.name);
                 }
                 break;
@@ -2995,7 +3068,7 @@ class Glob {
 class SelectDiagnosticText {
     static #pathSelectOptions(resolvedConfig) {
         const text = [
-            `Root path:       ${resolvedConfig.rootPath}`,
+            `Root directory:  ${resolvedConfig.rootPath}`,
             `Test file match: ${resolvedConfig.testFileMatch.join(", ")}`,
         ];
         if (resolvedConfig.pathMatch.length > 0) {
@@ -5955,7 +6028,7 @@ class FileRunner {
 class Runner {
     #eventEmitter = new EventEmitter();
     #resolvedConfig;
-    static version = "6.1.0";
+    static version = "6.2.0";
     constructor(resolvedConfig) {
         this.#resolvedConfig = resolvedConfig;
     }
@@ -5974,14 +6047,16 @@ class Runner {
         }
         for (const reporter of this.#resolvedConfig.reporters) {
             switch (reporter) {
+                case "dot": {
+                    this.#eventEmitter.addReporter(new DotReporter(this.#resolvedConfig));
+                    break;
+                }
                 case "list": {
-                    const listReporter = new ListReporter(this.#resolvedConfig);
-                    this.#eventEmitter.addReporter(listReporter);
+                    this.#eventEmitter.addReporter(new ListReporter(this.#resolvedConfig));
                     break;
                 }
                 case "summary": {
-                    const summaryReporter = new SummaryReporter(this.#resolvedConfig);
-                    this.#eventEmitter.addReporter(summaryReporter);
+                    this.#eventEmitter.addReporter(new SummaryReporter(this.#resolvedConfig));
                     break;
                 }
                 default: {
@@ -6161,4 +6236,4 @@ class Cli {
     }
 }
 
-export { BaseReporter, CancellationReason, CancellationToken, Cli, Color, Config, ConfigDiagnosticText, DescribeResult, Diagnostic, DiagnosticCategory, DiagnosticOrigin, Directive, EventEmitter, ExpectResult, FileLocation, FileResult, Line, ListReporter, OptionBrand, OptionGroup, Options, OutputService, Path, ProjectResult, Result, ResultStatus, Runner, Scribbler, Select, SelectDiagnosticText, SetupReporter, Store, StreamController, SummaryReporter, SuppressedResult, TargetResult, TestResult, Text, Version, WatchReporter, addsPackageText, defaultOptions, describeNameText, diagnosticBelongsToNode, diagnosticText, environmentOptions, fileStatusText, fileViewText, formattedText, getDiagnosticMessageText, getTextSpanEnd, helpText, isDiagnosticWithLocation, prologueText, summaryText, testNameText, usesCompilerText, waitingForFileChangesText, watchUsageText };
+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, ProjectResult, Result, ResultStatus, Runner, Scribbler, Select, SelectDiagnosticText, SetupReporter, Store, StreamController, SummaryReporter, SuppressedResult, TargetResult, TestResult, Text, Version, WatchReporter, addsPackageText, defaultOptions, describeNameText, diagnosticBelongsToNode, diagnosticText, dotText, environmentOptions, fileStatusText, formattedText, getDiagnosticMessageText, getTextSpanEnd, helpText, isDiagnosticWithLocation, prologueText, summaryText, testNameText, usesCompilerText, waitingForFileChangesText, watchUsageText };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tstyche",
-  "version": "6.1.0",
+  "version": "6.2.0",
   "description": "Everything You Need for Type Testing.",
   "keywords": [
     "typescript",