tstyche 1.0.0 → 2.0.0-beta.0

package/build/tstyche.d.ts

@@ -12,7 +12,6 @@ interface DiagnosticOrigin {
     start: number;
 }
 declare class Diagnostic {
-    #private;
     text: string | Array<string>;
     category: DiagnosticCategory;
     origin?: DiagnosticOrigin | undefined;
@@ -31,17 +30,22 @@ declare class Diagnostic {
     static warning(text: string | Array<string>, origin?: DiagnosticOrigin): Diagnostic;
 }
 
+declare class CancellationToken {
+    #private;
+    get isCancellationRequested(): boolean;
+    cancel(): void;
+}
+
 declare class StoreService {
     #private;
     constructor();
-    getSupportedTags(signal?: AbortSignal): Promise<Array<string>>;
-    install(tag: string, signal?: AbortSignal): Promise<string | undefined>;
-    load(tag: string, signal?: AbortSignal): Promise<typeof ts | undefined>;
-    open(signal?: AbortSignal): Promise<void>;
-    prune: () => Promise<void>;
-    resolveTag(tag: string, signal?: AbortSignal): Promise<string | undefined>;
-    update(signal?: AbortSignal): Promise<void>;
-    validateTag(tag: string, signal?: AbortSignal): Promise<boolean>;
+    getSupportedTags(): Promise<Array<string>>;
+    install(tag: string, cancellationToken?: CancellationToken): Promise<string | undefined>;
+    load(tag: string, cancellationToken?: CancellationToken): Promise<typeof ts | undefined>;
+    open(): Promise<void>;
+    resolveTag(tag: string): Promise<string | undefined>;
+    update(): Promise<void>;
+    validateTag(tag: string): Promise<boolean | undefined>;
 }
 
 declare enum OptionBrand {
@@ -132,6 +136,10 @@ interface CommandLineOptions {
      * Print the version number and exit.
      */
     version?: boolean;
+    /**
+     * Watch for changes and rerun related tests files.
+     */
+    watch?: boolean;
 }
 
 /**
@@ -172,15 +180,23 @@ declare class ConfigService {
     parseCommandLine(commandLineArgs: Array<string>): Promise<void>;
     readConfigFile(): Promise<void>;
     resolveConfig(): ResolvedConfig;
-    selectTestFiles(): Array<string>;
+}
+
+declare class SelectService {
+    #private;
+    readonly resolvedConfig: ResolvedConfig;
+    constructor(resolvedConfig: ResolvedConfig);
+    isTestFile(filePath: string): boolean;
+    selectFiles(): Promise<Array<string>>;
 }
 
 declare class TSTyche {
     #private;
     readonly resolvedConfig: ResolvedConfig;
-    static readonly version = "1.0.0";
+    static readonly version = "2.0.0-beta.0";
     constructor(resolvedConfig: ResolvedConfig, storeService: StoreService);
     run(testFiles: Array<string | URL>): Promise<void>;
+    watch(testFiles: Array<string>, selectService: SelectService): Promise<void>;
 }
 
 declare class Cli {
@@ -252,6 +268,10 @@ declare class CollectService {
 
 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.
      */
@@ -371,12 +391,18 @@ declare class ResultManager {
     handleEvent([eventName, payload]: Event): void;
 }
 
-type Event = ["start", {
+type Event = ["config:error", {
+    diagnostics: Array<Diagnostic>;
+}] | ["deprecation:info", {
+    diagnostics: Array<Diagnostic>;
+}] | ["input:info", {
+    key: string;
+}] | ["select:error", {
+    diagnostics: Array<Diagnostic>;
+}] | ["run:start", {
     result: Result;
-}] | ["end", {
+}] | ["run:end", {
     result: Result;
-}] | ["config:error", {
-    diagnostics: Array<Diagnostic>;
 }] | ["store:info", {
     compilerVersion: string;
     installationPath: string;
@@ -461,22 +487,28 @@ declare abstract class RelationMatcherBase {
     typeChecker: TypeChecker;
     abstract relation: Relation;
     abstract relationExplanationText: string;
+    relationExplanationVerb: string;
     constructor(typeChecker: TypeChecker);
     protected explain(sourceType: ts.Type, targetType: ts.Type, isNot: boolean): Array<Diagnostic>;
     match(sourceType: ts.Type, targetType: ts.Type, isNot: boolean): MatchResult;
 }
 
-declare class ToBeAssignable extends RelationMatcherBase {
+declare class ToBe extends RelationMatcherBase {
     relation: Relation;
     relationExplanationText: string;
-    match(sourceType: ts.Type, targetType: ts.Type, isNot: boolean): MatchResult;
 }
 
-declare class ToEqual extends RelationMatcherBase {
+declare class ToBeAssignableTo extends RelationMatcherBase {
     relation: Relation;
     relationExplanationText: string;
 }
 
+declare class ToBeAssignableWith extends RelationMatcherBase {
+    relation: Relation;
+    relationExplanationText: string;
+    match(sourceType: ts.Type, targetType: ts.Type, isNot: boolean): MatchResult;
+}
+
 declare class ToHaveProperty {
     #private;
     compiler: typeof ts;
@@ -488,6 +520,7 @@ declare class ToHaveProperty {
 declare class ToMatch extends RelationMatcherBase {
     relation: Relation;
     relationExplanationText: string;
+    relationExplanationVerb: string;
 }
 
 declare class ToRaiseError {
@@ -505,8 +538,11 @@ declare class Expect {
     #private;
     compiler: typeof ts;
     typeChecker: TypeChecker;
+    toBe: ToBe;
     toBeAny: PrimitiveTypeMatcher;
-    toBeAssignable: ToBeAssignable;
+    toBeAssignable: ToBeAssignableWith;
+    toBeAssignableTo: ToBeAssignableTo;
+    toBeAssignableWith: ToBeAssignableWith;
     toBeBigInt: PrimitiveTypeMatcher;
     toBeBoolean: PrimitiveTypeMatcher;
     toBeNever: PrimitiveTypeMatcher;
@@ -518,7 +554,7 @@ declare class Expect {
     toBeUniqueSymbol: PrimitiveTypeMatcher;
     toBeUnknown: PrimitiveTypeMatcher;
     toBeVoid: PrimitiveTypeMatcher;
-    toEqual: ToEqual;
+    toEqual: ToBe;
     toHaveProperty: ToHaveProperty;
     toMatch: ToMatch;
     toRaiseError: ToRaiseError;
@@ -527,48 +563,19 @@ declare class Expect {
     match(assertion: Assertion, expectResult: ExpectResult): MatchResult | undefined;
 }
 
-/**
- * A stream to output messages.
- */
-interface WriteStream {
-    /**
-     * @param log - Message to write to the stream.
-     */
-    write: (log: string) => void;
+interface ReadStream {
+    on: (event: "data", listener: (chunk: string) => void) => this;
+    setEncoding: (encoding: "utf8") => this;
+    setRawMode?: (mode: boolean) => this;
+    unref: () => this;
 }
-/**
- * Options to configure an instance of the {@link Logger}.
- */
-interface LoggerOptions {
-    /**
-     * Specifies whether color should be disabled in the output. Default: `Environment.noColor`.
-     */
-    noColor?: boolean;
-    /**
-     * A stream to write warnings and errors. Default: `process.stderr`.
-     */
-    stderr?: WriteStream;
-    /**
-     * A stream to write informational messages. Default: `process.stdout`.
-     */
-    stdout?: WriteStream;
+interface InputServiceOptions {
+    stdin?: ReadStream;
 }
-/**
- * Wraps the provided streams with a set of convenience methods.
- */
-declare class Logger {
+declare class InputService {
     #private;
-    /**
-     * @param options - {@link LoggerOptions | Options} to configure an instance of the Logger.
-     */
-    constructor(options?: LoggerOptions);
-    /**
-     * Moves the cursor one line up in the `stdout` stream and erases that line.
-     */
-    eraseLastLine(): void;
-    writeError(body: JSX.Element | Array<JSX.Element>): void;
-    writeMessage(body: JSX.Element | Array<JSX.Element>): void;
-    writeWarning(body: JSX.Element | Array<JSX.Element>): void;
+    constructor(options?: InputServiceOptions);
+    dispose(): void;
 }
 
 declare function addsPackageStepText(compilerVersion: string, installationPath: string): JSX.Element;
@@ -585,6 +592,24 @@ declare function formattedText(input: string | Array<string> | Record<string, un
 
 declare function helpText(optionDefinitions: Map<string, OptionDefinition>, tstycheVersion: string): JSX.Element;
 
+interface WriteStream {
+    write: (log: string) => void;
+}
+interface OutputServiceOptions {
+    noColor?: boolean;
+    stderr?: WriteStream;
+    stdout?: WriteStream;
+}
+declare class OutputService {
+    #private;
+    constructor(options?: OutputServiceOptions);
+    clearTerminal(): void;
+    eraseLastLine(): void;
+    writeError(body: JSX.Element | Array<JSX.Element>): void;
+    writeMessage(body: JSX.Element | Array<JSX.Element>): void;
+    writeWarning(body: JSX.Element | Array<JSX.Element>): void;
+}
+
 declare function summaryText({ duration, expectCount, fileCount, onlyMatch, pathMatch, skipMatch, targetCount, testCount, }: {
     duration: number;
     expectCount: ResultCount;
@@ -602,6 +627,8 @@ declare function usesCompilerStepText(compilerVersion: string, tsconfigFilePath:
     prependEmptyLine: boolean;
 }): JSX.Element;
 
+declare function watchModeUsageText(): JSX.Element;
+
 declare class Path {
     static dirname(filePath: string): string;
     static join(...filePaths: Array<string>): string;
@@ -622,7 +649,7 @@ declare class ProjectService {
 
 declare abstract class Reporter {
     readonly resolvedConfig: ResolvedConfig;
-    protected logger: Logger;
+    protected outputService: OutputService;
     constructor(resolvedConfig: ResolvedConfig);
     abstract handleEvent([eventName, payload]: Event): void;
 }
@@ -636,11 +663,15 @@ declare class ThoroughReporter extends Reporter {
     handleEvent([eventName, payload]: Event): void;
 }
 
+declare class WatchModeReporter extends Reporter {
+    handleEvent([eventName]: Event): void;
+}
+
 declare class TaskRunner {
     #private;
     readonly resolvedConfig: ResolvedConfig;
     constructor(resolvedConfig: ResolvedConfig, storeService: StoreService);
-    run(testFiles: Array<URL>, target: Array<string>, signal?: AbortSignal): Promise<Result>;
+    run(testFiles: Array<URL>, target: Array<string>, cancellationToken?: CancellationToken): Promise<Result>;
 }
 
 declare enum Color {
@@ -699,35 +730,14 @@ declare global {
         }
     }
 }
-/**
- * Options to configure an instance of the {@link Scribbler}.
- */
 interface ScribblerOptions {
-    /**
-     * The end of line sequence to be used in the output. Default: `"\n"`.
-     */
     newLine?: string;
-    /**
-     * Do not include ANSI color escape codes in the output. Default: `false`.
-     */
     noColor?: boolean;
 }
-/**
- * Provides the JSX factory function and renderer.
- */
 declare class Scribbler {
     #private;
-    /**
-     * @param options - {@link ScribblerOptions | Options} to configure an instance of the Scribbler.
-     */
     constructor(options?: ScribblerOptions);
-    /**
-     * Creates a new text element of the given `type`.
-     */
     static createElement(type: ComponentConstructor | string, props: Record<string, unknown> | null, ...children: Array<ElementChildren>): JSX.Element;
-    /**
-     * Renders the provided JSX `element` and returns the resulting string.
-     */
     render(element: JSX.Element | null): string;
 }
 
@@ -749,4 +759,12 @@ declare class Version {
     static isVersionTag(target: string): boolean;
 }
 
-export { Assertion, Cli, CollectService, Color, type CommandLineOptions, type ConfigFileOptions, ConfigService, DescribeResult, Diagnostic, DiagnosticCategory, type DiagnosticOrigin, Environment, type Event, EventEmitter, type EventHandler, Expect, ExpectResult, FileResult, type FileResultStatus, type ItemDefinition, Line, Logger, type LoggerOptions, type MatchResult, OptionBrand, type OptionDefinition, OptionDefinitionsMap, OptionGroup, Path, ProjectResult, ProjectService, Reporter, type ResolvedConfig, Result, ResultCount, ResultManager, ResultStatus, ResultTiming, Scribbler, type ScribblerOptions, StoreService, SummaryReporter, TSTyche, TargetResult, type TargetResultStatus, TaskRunner, TestMember, TestMemberBrand, TestMemberFlags, TestResult, TestTree, Text, ThoroughReporter, type TypeChecker, Version, type WriteStream, addsPackageStepText, describeNameText, diagnosticText, fileStatusText, fileViewText, formattedText, helpText, summaryText, testNameText, usesCompilerStepText };
+type RunCallback = (testFiles: Array<string>) => Promise<void>;
+declare class Watcher {
+    #private;
+    readonly resolvedConfig: ResolvedConfig;
+    constructor(resolvedConfig: ResolvedConfig, runCallback: RunCallback, selectService: SelectService, testFiles: Array<string>);
+    watch(): Promise<void>;
+}
+
+export { Assertion, CancellationToken, Cli, CollectService, Color, type CommandLineOptions, type ConfigFileOptions, ConfigService, DescribeResult, Diagnostic, DiagnosticCategory, type DiagnosticOrigin, Environment, type Event, EventEmitter, type EventHandler, Expect, ExpectResult, FileResult, type FileResultStatus, InputService, type InputServiceOptions, type ItemDefinition, Line, type MatchResult, OptionBrand, type OptionDefinition, OptionDefinitionsMap, OptionGroup, OutputService, type OutputServiceOptions, Path, ProjectResult, ProjectService, type ReadStream, Reporter, type ResolvedConfig, Result, ResultCount, ResultManager, ResultStatus, ResultTiming, Scribbler, type ScribblerOptions, SelectService, StoreService, SummaryReporter, TSTyche, TargetResult, type TargetResultStatus, TaskRunner, TestMember, TestMemberBrand, TestMemberFlags, TestResult, TestTree, Text, ThoroughReporter, type TypeChecker, Version, WatchModeReporter, Watcher, type WriteStream, addsPackageStepText, describeNameText, diagnosticText, fileStatusText, fileViewText, formattedText, helpText, summaryText, testNameText, usesCompilerStepText, watchModeUsageText };