tstyche 3.0.0-beta.0 → 3.0.0-beta.2

package/README.md

@@ -39,8 +39,8 @@ To organize, debug and plan tests TSTyche has:
 The assertions can be used to write type tests (like in the above example) or mixed in your functional tests:
 
 ```ts
-import assert from "node:assert/strict";
-import { test } from "node:test";
+import assert from "node:assert";
+import test from "node:test";
 import * as tstyche from "tstyche";
 
 function secondItem<T>(target: Array<T>): T | undefined {

package/build/tstyche.d.ts

@@ -1,16 +1,5 @@
 import type ts from 'typescript';
 
-declare class StoreService {
-    #private;
-    constructor();
-    getSupportedTags(): Promise<Array<string>>;
-    install(tag: string): Promise<string | undefined>;
-    load(tag: string): Promise<typeof ts | undefined>;
-    open(): Promise<void>;
-    update(): Promise<void>;
-    validateTag(tag: string): Promise<boolean | undefined>;
-}
-
 declare enum OptionBrand {
     String = "string",
     Number = "number",
@@ -18,41 +7,41 @@ declare enum OptionBrand {
     BareTrue = "bareTrue",// a boolean option that does not take a value and when specified is interpreted as 'true'
     List = "list"
 }
+
 declare enum OptionGroup {
     CommandLine = 2,
     ConfigFile = 4
 }
 
-interface ItemDefinition {
-    brand: OptionBrand.String;
-    name: string;
-    pattern?: string;
-}
-type OptionDefinition = PrimitiveTypeOptionDefinition | ListTypeOptionDefinition;
-interface BaseOptionDefinition {
-    brand: OptionBrand;
-    description: string;
-    group: OptionGroup;
-    name: string;
-}
-interface PrimitiveTypeOptionDefinition extends BaseOptionDefinition {
-    brand: OptionBrand.String | OptionBrand.Number | OptionBrand.Boolean | OptionBrand.BareTrue;
-}
-interface ListTypeOptionDefinition extends BaseOptionDefinition {
-    brand: OptionBrand.List;
-    items: ItemDefinition;
+declare class ConfigDiagnosticText {
+    #private;
+    static expected(element: string): string;
+    static expectsListItemType(optionName: string, optionBrand: OptionBrand): string;
+    static expectsValue(optionName: string, optionGroup: OptionGroup): string;
+    static fileDoesNotExist(filePath: string): string;
+    static seen(element: string): string;
+    static testFileMatchCannotStartWith(segment: string): Array<string>;
+    static requiresValueType(optionName: string, optionBrand: OptionBrand, optionGroup: OptionGroup): string;
+    static unknownOption(optionName: string): string;
+    static versionIsNotSupported(value: string): string;
+    static watchCannotBeEnabled(): string;
 }
-declare class OptionDefinitionsMap {
+
+declare class StoreService {
     #private;
-    static for(optionGroup: OptionGroup): Map<string, OptionDefinition>;
+    constructor();
+    getSupportedTags(): Promise<Array<string> | undefined>;
+    install(tag: string): Promise<void>;
+    load(tag: string): Promise<typeof ts | undefined>;
+    open(): Promise<void>;
+    prune(): Promise<void>;
+    update(): Promise<void>;
+    validateTag(tag: string): Promise<boolean | undefined>;
 }
 
-declare class TestTree {
-    diagnostics: Set<ts.Diagnostic>;
-    members: Array<TestMember | Assertion>;
-    sourceFile: ts.SourceFile;
-    constructor(diagnostics: Set<ts.Diagnostic>, sourceFile: ts.SourceFile);
-    get hasOnly(): boolean;
+declare enum DiagnosticCategory {
+    Error = "error",
+    Warning = "warning"
 }
 
 declare enum TestMemberBrand {
@@ -60,6 +49,7 @@ declare enum TestMemberBrand {
     Test = "test",
     Expect = "expect"
 }
+
 declare enum TestMemberFlags {
     None = 0,
     Fail = 1,
@@ -68,6 +58,14 @@ declare enum TestMemberFlags {
     Todo = 8
 }
 
+declare class TestTree {
+    diagnostics: Set<ts.Diagnostic>;
+    members: Array<TestMember | Assertion>;
+    sourceFile: ts.SourceFile;
+    constructor(diagnostics: Set<ts.Diagnostic>, sourceFile: ts.SourceFile);
+    get hasOnly(): boolean;
+}
+
 declare class TestMember {
     #private;
     brand: TestMemberBrand;
@@ -101,22 +99,28 @@ declare class CollectService {
     createTestTree(sourceFile: ts.SourceFile, semanticDiagnostics?: Array<ts.Diagnostic>): TestTree;
 }
 
+declare class SourceFile {
+    #private;
+    fileName: string;
+    text: string;
+    constructor(fileName: string, text: string);
+    getLineStarts(): Array<number>;
+    getLineAndCharacterOfPosition(position: number): {
+        line: number;
+        character: number;
+    };
+}
+
 declare class DiagnosticOrigin {
     assertion: Assertion | undefined;
     end: number;
-    sourceFile: ts.SourceFile;
+    sourceFile: SourceFile | ts.SourceFile;
     start: number;
-    constructor(start: number, end: number, sourceFile: ts.SourceFile, assertion?: Assertion);
+    constructor(start: number, end: number, sourceFile: SourceFile | ts.SourceFile, assertion?: Assertion);
     static fromAssertion(assertion: Assertion): DiagnosticOrigin;
-    static fromJsonNode(node: ts.Node, sourceFile: ts.SourceFile, skipTrivia: (position: number, sourceFile: ts.SourceFile) => number): DiagnosticOrigin;
     static fromNode(node: ts.Node, assertion?: Assertion): DiagnosticOrigin;
 }
 
-declare enum DiagnosticCategory {
-    Error = "error",
-    Warning = "warning"
-}
-
 declare class Diagnostic {
     #private;
     category: DiagnosticCategory;
@@ -135,6 +139,28 @@ declare class Diagnostic {
     static warning(text: string | Array<string>, origin?: DiagnosticOrigin): Diagnostic;
 }
 
+/**
+ * Options loaded from the configuration file.
+ */
+interface ConfigFileOptions {
+    /**
+     * Stop running tests after the first failed assertion.
+     */
+    failFast?: boolean;
+    /**
+     * The path to a directory containing files of a test project.
+     */
+    rootPath?: string;
+    /**
+     * The list of TypeScript versions to be tested on.
+     */
+    target?: Array<string>;
+    /**
+     * The list of glob patterns matching the test files.
+     */
+    testFileMatch?: Array<string>;
+}
+
 /**
  * Options passed through the command line.
  */
@@ -193,42 +219,38 @@ interface CommandLineOptions {
     watch?: boolean;
 }
 
-declare class ConfigDiagnosticText {
-    #private;
-    static doubleQuotesExpected(): string;
-    static expectsListItemType(optionName: string, optionBrand: OptionBrand): string;
-    static expectsValue(optionName: string, optionGroup: OptionGroup): string;
-    static fileDoesNotExist(filePath: string): string;
-    static testFileMatchCannotStartWith(segment: string): Array<string>;
-    static requiresValueType(optionName: string, optionBrand: OptionBrand, optionGroup: OptionGroup): string;
-    static unknownOption(optionName: string): string;
-    static versionIsNotSupported(value: string): string;
-    static watchCannotBeEnabled(): string;
-}
-
-/**
- * Options loaded from the configuration file.
- */
-interface ConfigFileOptions {
+interface EnvironmentOptions {
     /**
-     * Stop running tests after the first failed assertion.
+     * Is `true` if the process is running in a continuous integration environment.
      */
-    failFast?: boolean;
+    isCi: boolean;
     /**
-     * The path to a directory containing files of a test project.
+     * Specifies whether color should be disabled in the output.
      */
-    rootPath?: string;
+    noColor: boolean;
     /**
-     * The list of TypeScript versions to be tested on.
+     * Specifies whether interactive elements should be disabled in the output.
      */
-    target?: Array<string>;
+    noInteractive: boolean;
     /**
-     * The list of glob patterns matching the test files.
+     * The base URL of the 'npm' registry to use.
      */
-    testFileMatch?: Array<string>;
+    npmRegistry: string;
+    /**
+     * The directory where to store the 'typescript' packages.
+     */
+    storePath: string;
+    /**
+     * The number of seconds to wait before giving up stale operations.
+     */
+    timeout: number;
+    /**
+     * The path to the currently installed TypeScript module.
+     */
+    typescriptPath: string | undefined;
 }
 
-interface ResolvedConfig extends Omit<CommandLineOptions, keyof ConfigFileOptions | "config">, Required<ConfigFileOptions> {
+interface ResolvedConfig extends EnvironmentOptions, Omit<CommandLineOptions, keyof ConfigFileOptions | "config">, Required<ConfigFileOptions> {
     /**
      * The path to a TSTyche configuration file.
      */
@@ -238,15 +260,41 @@ interface ResolvedConfig extends Omit<CommandLineOptions, keyof ConfigFileOption
      */
     pathMatch: Array<string>;
 }
-declare const defaultOptions: Required<ConfigFileOptions>;
 declare class ConfigService {
     #private;
-    constructor(compiler: typeof ts, storeService: StoreService);
-    parseCommandLine(commandLineArgs: Array<string>): Promise<void>;
-    readConfigFile(): Promise<void>;
+    parseCommandLine(commandLineArgs: Array<string>, storeService: StoreService): Promise<void>;
+    readConfigFile(storeService: StoreService): Promise<void>;
     resolveConfig(): ResolvedConfig;
 }
 
+interface ItemDefinition {
+    brand: OptionBrand.String;
+    name: string;
+    pattern?: string;
+}
+type OptionDefinition = PrimitiveTypeOptionDefinition | ListTypeOptionDefinition;
+interface BaseOptionDefinition {
+    brand: OptionBrand;
+    description: string;
+    group: OptionGroup;
+    name: string;
+}
+interface PrimitiveTypeOptionDefinition extends BaseOptionDefinition {
+    brand: OptionBrand.String | OptionBrand.Number | OptionBrand.Boolean | OptionBrand.BareTrue;
+}
+interface ListTypeOptionDefinition extends BaseOptionDefinition {
+    brand: OptionBrand.List;
+    items: ItemDefinition;
+}
+declare class OptionDefinitionsMap {
+    #private;
+    static for(optionGroup: OptionGroup): Map<string, OptionDefinition>;
+}
+
+declare const defaultOptions: Required<ConfigFileOptions>;
+
+declare const environmentOptions: EnvironmentOptions;
+
 declare enum Color {
     Reset = "0",
     Red = "31",
@@ -304,19 +352,12 @@ interface TextProps {
 }
 declare function Text({ children, color, indent }: TextProps): ScribblerJsx.Element;
 
-declare function addsPackageStepText(packageVersion: string, packagePath: string): ScribblerJsx.Element;
+declare function addsPackageText(packageVersion: string, packagePath: string): ScribblerJsx.Element;
 
 declare function describeNameText(name: string, indent?: number): ScribblerJsx.Element;
 
 declare function diagnosticText(diagnostic: Diagnostic): ScribblerJsx.Element;
 
-declare class TestFile {
-    #private;
-    path: string;
-    position: number | undefined;
-    constructor(identifier: string | URL, position?: number);
-}
-
 declare class ResultTiming {
     end: number;
     start: number;
@@ -367,23 +408,30 @@ declare class DescribeResult {
     constructor(describe: TestMember, parent?: DescribeResult);
 }
 
-type FileResultStatus = ResultStatus.Runs | ResultStatus.Passed | ResultStatus.Failed;
-declare class FileResult {
+declare class Task {
+    #private;
+    filePath: string;
+    position: number | undefined;
+    constructor(filePath: string | URL, position?: number);
+}
+
+type TaskResultStatus = ResultStatus.Runs | ResultStatus.Passed | ResultStatus.Failed;
+declare class TaskResult {
     diagnostics: Array<Diagnostic>;
     expectCount: ResultCount;
     results: Array<DescribeResult | TestResult | ExpectResult>;
-    status: FileResultStatus;
+    status: TaskResultStatus;
+    task: Task;
     testCount: ResultCount;
-    testFile: TestFile;
     timing: ResultTiming;
-    constructor(testFile: TestFile);
+    constructor(task: Task);
 }
 
 declare class ProjectResult {
     compilerVersion: string;
     diagnostics: Array<Diagnostic>;
     projectConfigFilePath: string | undefined;
-    results: Array<FileResult>;
+    results: Array<TaskResult>;
     constructor(compilerVersion: string, projectConfigFilePath: string | undefined);
 }
 
@@ -391,10 +439,10 @@ type TargetResultStatus = ResultStatus.Runs | ResultStatus.Passed | ResultStatus
 declare class TargetResult {
     results: Map<string | undefined, ProjectResult>;
     status: TargetResultStatus;
-    testFiles: Array<TestFile>;
+    tasks: Array<Task>;
     timing: ResultTiming;
     versionTag: string;
-    constructor(versionTag: string, testFiles: Array<TestFile>);
+    constructor(versionTag: string, tasks: Array<Task>);
 }
 
 declare class Result {
@@ -403,13 +451,13 @@ declare class Result {
     resolvedConfig: ResolvedConfig;
     results: Array<TargetResult>;
     targetCount: ResultCount;
+    tasks: Array<Task>;
     testCount: ResultCount;
-    testFiles: Array<TestFile>;
     timing: ResultTiming;
-    constructor(resolvedConfig: ResolvedConfig, testFiles: Array<TestFile>);
+    constructor(resolvedConfig: ResolvedConfig, tasks: Array<Task>);
 }
 
-declare function fileStatusText(status: FileResultStatus, testFile: TestFile): ScribblerJsx.Element;
+declare function taskStatusText(status: TaskResultStatus, task: Task): ScribblerJsx.Element;
 
 declare function fileViewText(lines: Array<ScribblerJsx.Element>, addEmptyFinalLine: boolean): ScribblerJsx.Element;
 
@@ -417,17 +465,9 @@ declare function formattedText(input: string | Array<string> | Record<string, un
 
 declare function helpText(optionDefinitions: Map<string, OptionDefinition>, tstycheVersion: string): ScribblerJsx.Element;
 
-interface WriteStream {
-    write: (chunk: string) => void;
-}
-interface OutputServiceOptions {
-    noColor?: boolean;
-    stderr?: WriteStream;
-    stdout?: WriteStream;
-}
 declare class OutputService {
     #private;
-    constructor(options?: OutputServiceOptions);
+    constructor();
     clearTerminal(): void;
     eraseLastLine(): void;
     writeError(element: ScribblerJsx.Element | Array<ScribblerJsx.Element>): void;
@@ -448,7 +488,7 @@ declare function summaryText({ duration, expectCount, fileCount, onlyMatch, path
 
 declare function testNameText(status: "fail" | "pass" | "skip" | "todo", name: string, indent?: number): ScribblerJsx.Element;
 
-declare function usesCompilerStepText(compilerVersion: string, tsconfigFilePath: string | undefined, options?: {
+declare function usesCompilerText(compilerVersion: string, projectConfigFilePath: string | undefined, options?: {
     prependEmptyLine: boolean;
 }): ScribblerJsx.Element;
 
@@ -497,49 +537,15 @@ declare class Cli {
     run(commandLineArguments: Array<string>, cancellationToken?: CancellationToken): Promise<void>;
 }
 
-declare class Environment {
-    #private;
-    /**
-     * Is `true` if the process is running in a continuous integration environment.
-     */
-    static get isCi(): boolean;
-    /**
-     * Specifies whether color should be disabled in the output.
-     */
-    static get noColor(): boolean;
-    /**
-     * Specifies whether interactive elements should be disabled in the output.
-     */
-    static get noInteractive(): boolean;
-    /**
-     * The base URL of the 'npm' registry to use.
-     */
-    static get npmRegistry(): string;
-    /**
-     * The directory where to store the 'typescript' packages.
-     */
-    static get storePath(): string;
-    /**
-     * The number of seconds to wait before giving up stale operations.
-     */
-    static get timeout(): number;
-    /**
-     * The path to the currently installed TypeScript module.
-     */
-    static get typescriptPath(): string | undefined;
-}
-
 type Event = ["config:error", {
     diagnostics: Array<Diagnostic>;
-}] | ["deprecation:info", {
-    diagnostics: Array<Diagnostic>;
 }] | ["select:error", {
     diagnostics: Array<Diagnostic>;
 }] | ["run:start", {
     result: Result;
 }] | ["run:end", {
     result: Result;
-}] | ["store:info", {
+}] | ["store:adds", {
     packagePath: string;
     packageVersion: string;
 }] | ["store:error", {
@@ -548,18 +554,18 @@ type Event = ["config:error", {
     result: TargetResult;
 }] | ["target:end", {
     result: TargetResult;
-}] | ["project:info", {
+}] | ["project:uses", {
     compilerVersion: string;
     projectConfigFilePath: string | undefined;
 }] | ["project:error", {
     diagnostics: Array<Diagnostic>;
-}] | ["file:start", {
-    result: FileResult;
-}] | ["file:error", {
+}] | ["task:start", {
+    result: TaskResult;
+}] | ["task:error", {
     diagnostics: Array<Diagnostic>;
-    result: FileResult;
-}] | ["file:end", {
-    result: FileResult;
+    result: TaskResult;
+}] | ["task:end", {
+    result: TaskResult;
 }] | ["describe:start", {
     result: DescribeResult;
 }] | ["describe:end", {
@@ -793,19 +799,9 @@ declare class WatchReporter extends Reporter implements EventHandler {
 }
 
 type InputHandler = (chunk: string) => void;
-interface ReadStream {
-    addListener: (event: "data", handler: InputHandler) => this;
-    removeListener: (event: "data", handler: InputHandler) => this;
-    setEncoding: (encoding: "utf8") => this;
-    setRawMode?: (mode: boolean) => this;
-    unref: () => this;
-}
-interface InputServiceOptions {
-    stdin?: ReadStream;
-}
 declare class InputService {
     #private;
-    constructor(onInput: InputHandler, options?: InputServiceOptions);
+    constructor(onInput: InputHandler);
     close(): void;
 }
 
@@ -826,11 +822,11 @@ declare class ProjectService {
     openFile(filePath: string, sourceText?: string | undefined, projectRootPath?: string | undefined): void;
 }
 
-declare class TaskRunner {
+declare class Runner {
     #private;
     constructor(resolvedConfig: ResolvedConfig, selectService: SelectService, storeService: StoreService);
     close(): void;
-    run(testFiles: Array<TestFile>, cancellationToken?: CancellationToken): Promise<void>;
+    run(tasks: Array<Task>, cancellationToken?: CancellationToken): Promise<void>;
 }
 
 declare class Version {
@@ -858,8 +854,8 @@ declare class FileWatcher extends Watcher {
 
 declare class WatchService {
     #private;
-    constructor(resolvedConfig: ResolvedConfig, selectService: SelectService, testFiles: Array<TestFile>);
-    watch(cancellationToken: CancellationToken): AsyncIterable<Array<TestFile>>;
+    constructor(resolvedConfig: ResolvedConfig, selectService: SelectService, tasks: Array<Task>);
+    watch(cancellationToken: CancellationToken): AsyncIterable<Array<Task>>;
 }
 
-export { Assertion, CancellationHandler, CancellationReason, CancellationToken, Cli, CollectService, Color, type CommandLineOptions, ConfigDiagnosticText, type ConfigFileOptions, ConfigService, DescribeResult, Diagnostic, DiagnosticCategory, DiagnosticOrigin, Environment, type Event, EventEmitter, type EventHandler, ExitCodeHandler, ExpectResult, ExpectService, FileResult, type FileResultStatus, type FileWatchHandler, FileWatcher, type InputHandler, InputService, type InputServiceOptions, type ItemDefinition, Line, type MatchResult, OptionBrand, type OptionDefinition, OptionDefinitionsMap, OptionGroup, OutputService, type OutputServiceOptions, Path, ProjectResult, ProjectService, type ReadStream, type ResolvedConfig, Result, ResultCount, ResultHandler, ResultStatus, ResultTiming, RunReporter, Scribbler, ScribblerJsx, type ScribblerOptions, SelectDiagnosticText, SelectService, SetupReporter, StoreService, SummaryReporter, TSTyche, TargetResult, type TargetResultStatus, TaskRunner, TestFile, TestMember, TestMemberBrand, TestMemberFlags, TestResult, TestTree, Text, type TypeChecker, Version, type WatchHandler, WatchReporter, WatchService, Watcher, type WatcherOptions, type WriteStream, addsPackageStepText, defaultOptions, describeNameText, diagnosticText, fileStatusText, fileViewText, formattedText, helpText, summaryText, testNameText, usesCompilerStepText, waitingForFileChangesText, watchUsageText };
+export { Assertion, CancellationHandler, CancellationReason, CancellationToken, Cli, CollectService, Color, type CommandLineOptions, ConfigDiagnosticText, type ConfigFileOptions, ConfigService, DescribeResult, Diagnostic, DiagnosticCategory, DiagnosticOrigin, type Event, EventEmitter, type EventHandler, ExitCodeHandler, ExpectResult, ExpectService, type FileWatchHandler, FileWatcher, type InputHandler, InputService, type ItemDefinition, Line, type MatchResult, OptionBrand, type OptionDefinition, OptionDefinitionsMap, OptionGroup, OutputService, Path, ProjectResult, ProjectService, type ResolvedConfig, Result, ResultCount, ResultHandler, ResultStatus, ResultTiming, RunReporter, Runner, Scribbler, ScribblerJsx, type ScribblerOptions, SelectDiagnosticText, SelectService, SetupReporter, SourceFile, StoreService, SummaryReporter, TSTyche, 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 };