tstyche 2.1.1 → 3.0.0-beta.1

package/README.md

@@ -2,10 +2,8 @@
 
 [![version][version-badge]][version-url]
 [![license][license-badge]][license-url]
-[![requirements][requirements-badge]][requirements-url]
 [![install-size][install-size-badge]][install-size-url]
 [![coverage][coverage-badge]][coverage-url]
-[![discord][discord-badge]][discord-url]
 
 The Essential Type Testing Tool.
 
@@ -80,7 +78,7 @@ Visit [https://tstyche.org](https://tstyche.org) to view the full documentation.
 
 ## Feedback
 
-If you have any questions or suggestions, [start a discussion](https://github.com/tstyche/tstyche/discussions/new/choose) or [open an issue](https://github.com/tstyche/tstyche/issues/new/choose) on GitHub. Preferring a chat? Join our [Discord server][discord-url].
+If you have any questions or suggestions, [start a discussion](https://github.com/tstyche/tstyche/discussions/new/choose) or [open an issue](https://github.com/tstyche/tstyche/issues/new/choose) on GitHub. Preferring a chat? Join our [Discord server](https://discord.gg/gCSasd3QJq).
 
 ## License
 
@@ -90,11 +88,7 @@ If you have any questions or suggestions, [start a discussion](https://github.co
 [version-url]: https://npmjs.com/package/tstyche
 [license-badge]: https://badgen.net/github/license/tstyche/tstyche
 [license-url]: https://github.com/tstyche/tstyche/blob/main/LICENSE.md
-[requirements-badge]: https://badgen.net/npm/node/tstyche
-[requirements-url]: https://tstyche.org/reference/requirements
 [install-size-badge]: https://badgen.net/packagephobia/install/tstyche
 [install-size-url]: https://packagephobia.com/result?p=tstyche
 [coverage-badge]: https://badgen.net/codacy/coverage/a581ca5c323a455886b7bdd9623c4ec8
 [coverage-url]: https://app.codacy.com/gh/tstyche/tstyche/coverage/dashboard
-[discord-badge]: https://badgen.net/static/chat/on%20Discord
-[discord-url]: https://discord.gg/gCSasd3QJq

package/build/tstyche.d.ts

@@ -1,67 +1,5 @@
 import type ts from 'typescript';
 
-declare enum CancellationReason {
-    ConfigChange = "configChange",
-    ConfigError = "configError",
-    FailFast = "failFast",
-    WatchClose = "watchClose"
-}
-
-declare class CancellationToken {
-    #private;
-    get isCancellationRequested(): boolean;
-    get reason(): CancellationReason | undefined;
-    cancel(reason: CancellationReason): void;
-    reset(): void;
-}
-
-declare class StoreService {
-    #private;
-    constructor();
-    getSupportedTags(): Promise<Array<string>>;
-    install(tag: string, cancellationToken?: CancellationToken): Promise<string | undefined>;
-    load(tag: string, cancellationToken?: CancellationToken): Promise<typeof ts | undefined>;
-    open(): Promise<void>;
-    update(): Promise<void>;
-    validateTag(tag: string): Promise<boolean | undefined>;
-}
-
-declare enum OptionBrand {
-    String = "string",
-    Number = "number",
-    Boolean = "boolean",
-    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 OptionDefinitionsMap {
-    #private;
-    static for(optionGroup: OptionGroup): Map<string, OptionDefinition>;
-}
-
 declare class TestTree {
     diagnostics: Set<ts.Diagnostic>;
     members: Array<TestMember | Assertion>;
@@ -147,10 +85,31 @@ declare class Diagnostic {
     static error(text: string | Array<string>, origin?: DiagnosticOrigin): Diagnostic;
     extendWith(text: string | Array<string>, origin?: DiagnosticOrigin): Diagnostic;
     static fromDiagnostics(diagnostics: Array<ts.Diagnostic>, compiler: typeof ts): Array<Diagnostic>;
-    static fromError(text: string | Array<string>, error: unknown): 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.
  */
@@ -209,6 +168,49 @@ interface CommandLineOptions {
     watch?: boolean;
 }
 
+interface EnvironmentOptions {
+    /**
+     * Is `true` if the process is running in a continuous integration environment.
+     */
+    isCi: boolean;
+    /**
+     * Specifies whether color should be disabled in the output.
+     */
+    noColor: boolean;
+    /**
+     * Specifies whether interactive elements should be disabled in the output.
+     */
+    noInteractive: boolean;
+    /**
+     * The base URL of the 'npm' registry to use.
+     */
+    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;
+}
+
+declare enum OptionBrand {
+    String = "string",
+    Number = "number",
+    Boolean = "boolean",
+    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
+}
+
 declare class ConfigDiagnosticText {
     #private;
     static doubleQuotesExpected(): string;
@@ -222,29 +224,19 @@ declare class ConfigDiagnosticText {
     static watchCannotBeEnabled(): string;
 }
 
-/**
- * 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>;
+declare class StoreService {
+    #private;
+    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>;
 }
 
-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.
      */
@@ -254,15 +246,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",
@@ -320,19 +338,12 @@ interface TextProps {
 }
 declare function Text({ children, color, indent }: TextProps): ScribblerJsx.Element;
 
-declare function addsPackageStepText(compilerVersion: string, installationPath: 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;
@@ -383,23 +394,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);
 }
 
@@ -407,10 +425,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 {
@@ -419,13 +437,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;
 
@@ -433,17 +451,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;
@@ -464,7 +474,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;
 
@@ -485,6 +495,21 @@ declare class SelectService {
     selectFiles(): Promise<Array<string>>;
 }
 
+declare enum CancellationReason {
+    ConfigChange = "configChange",
+    ConfigError = "configError",
+    FailFast = "failFast",
+    WatchClose = "watchClose"
+}
+
+declare class CancellationToken {
+    #private;
+    get isCancellationRequested(): boolean;
+    get reason(): CancellationReason | undefined;
+    cancel(reason: CancellationReason): void;
+    reset(): void;
+}
+
 declare class TSTyche {
     #private;
     static version: string;
@@ -498,65 +523,35 @@ 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 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", {
-    compilerVersion: string;
-    installationPath: string;
+}] | ["store:adds", {
+    packagePath: string;
+    packageVersion: string;
 }] | ["store:error", {
     diagnostics: Array<Diagnostic>;
 }] | ["target:start", {
     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", {
@@ -656,7 +651,6 @@ declare class ExpectDiagnosticText {
     static argumentMustBeProvided(argumentNameText: string): string;
     static componentAcceptsProps(isTypeNode: boolean): string;
     static componentDoesNotAcceptProps(isTypeNode: boolean): string;
-    static matcherIsDeprecated(matcherNameText: string): Array<string>;
     static matcherIsNotSupported(matcherNameText: string): string;
     static overloadGaveTheFollowingError(index: number, count: number, signatureText: string): string;
     static raisedTypeError(count?: number): string;
@@ -729,7 +723,6 @@ declare class ExpectService {
     toAcceptProps: ToAcceptProps;
     toBe: ToBe;
     toBeAny: PrimitiveTypeMatcher;
-    toBeAssignable: ToBeAssignableWith;
     toBeAssignableTo: ToBeAssignableTo;
     toBeAssignableWith: ToBeAssignableWith;
     toBeBigInt: PrimitiveTypeMatcher;
@@ -743,12 +736,10 @@ declare class ExpectService {
     toBeUniqueSymbol: PrimitiveTypeMatcher;
     toBeUnknown: PrimitiveTypeMatcher;
     toBeVoid: PrimitiveTypeMatcher;
-    toEqual: ToBe;
     toHaveProperty: ToHaveProperty;
     toMatch: ToMatch;
     toRaiseError: ToRaiseError;
     constructor(compiler: typeof ts, typeChecker: TypeChecker);
-    static assertTypeChecker(typeChecker: ts.TypeChecker): typeChecker is TypeChecker;
     match(assertion: Assertion, onDiagnostics: DiagnosticsHandler): MatchResult | undefined;
 }
 
@@ -794,19 +785,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;
 }
 
@@ -827,11 +808,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 {
@@ -859,8 +840,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, 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 };