tstyche 2.0.0-beta.1 → 2.0.0-rc.0

package/build/tstyche.d.ts

@@ -1,23 +1,27 @@
 import type ts from 'typescript';
 
+declare class DiagnosticOrigin {
+    breadcrumbs: Array<string> | undefined;
+    end: number;
+    sourceFile: ts.SourceFile;
+    start: number;
+    constructor(start: number, end: number, sourceFile: ts.SourceFile, breadcrumbs?: Array<string>);
+    static fromJsonNode(node: ts.Node, sourceFile: ts.SourceFile, skipTrivia: (position: number, sourceFile: ts.SourceFile) => number): DiagnosticOrigin;
+    static fromNode(node: ts.Node, breadcrumbs?: Array<string>): DiagnosticOrigin;
+}
+
 declare enum DiagnosticCategory {
     Error = "error",
     Warning = "warning"
 }
 
-interface DiagnosticOrigin {
-    breadcrumbs?: Array<string>;
-    end: number;
-    file: ts.SourceFile;
-    start: number;
-}
 declare class Diagnostic {
-    text: string | Array<string>;
     category: DiagnosticCategory;
-    origin?: DiagnosticOrigin | undefined;
-    code?: string;
-    related?: Array<Diagnostic>;
-    constructor(text: string | Array<string>, category: DiagnosticCategory, origin?: DiagnosticOrigin | undefined);
+    code: string | undefined;
+    related: Array<Diagnostic> | undefined;
+    origin: DiagnosticOrigin | undefined;
+    text: string | Array<string>;
+    constructor(text: string | Array<string>, category: DiagnosticCategory, origin?: DiagnosticOrigin);
     add(options: {
         code?: string;
         origin?: DiagnosticOrigin;
@@ -187,7 +191,6 @@ interface ResolvedConfig extends Omit<CommandLineOptions, keyof ConfigFileOption
 declare const defaultOptions: Required<ConfigFileOptions>;
 declare class ConfigService {
     #private;
-    compiler: typeof ts;
     constructor(compiler: typeof ts, storeService: StoreService);
     parseCommandLine(commandLineArgs: Array<string>): Promise<void>;
     readConfigFile(): Promise<void>;
@@ -202,6 +205,7 @@ declare class OptionDiagnosticText {
     static fileDoesNotExist(filePath: string): string;
     static noTestFilesWereLeft(resolvedConfig: ResolvedConfig): Array<string>;
     static noTestFilesWereSelected(resolvedConfig: ResolvedConfig): Array<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;
@@ -256,7 +260,7 @@ interface LineProps {
     indent?: number;
 }
 declare class Line implements ScribblerJsx.ElementClass {
-    readonly props: LineProps;
+    props: LineProps;
     constructor(props: LineProps);
     render(): ScribblerJsx.Element;
 }
@@ -277,7 +281,7 @@ interface TextProps {
     indent?: number | undefined;
 }
 declare class Text implements ScribblerJsx.ElementClass {
-    readonly props: TextProps;
+    props: TextProps;
     constructor(props: TextProps);
     render(): ScribblerJsx.Element;
 }
@@ -291,19 +295,15 @@ declare function diagnosticText(diagnostic: Diagnostic): ScribblerJsx.Element;
 declare class TestFile {
     #private;
     path: string;
-    position?: number;
-    constructor(identifier: string | URL);
-    add(options: {
-        position?: number;
-    }): this;
+    position: number | undefined;
+    constructor(identifier: string | URL, position?: number);
 }
 
 declare class TestTree {
-    compiler: typeof ts;
     diagnostics: Set<ts.Diagnostic>;
-    sourceFile: ts.SourceFile;
     members: Array<TestMember | Assertion>;
-    constructor(compiler: typeof ts, diagnostics: Set<ts.Diagnostic>, sourceFile: ts.SourceFile);
+    sourceFile: ts.SourceFile;
+    constructor(diagnostics: Set<ts.Diagnostic>, sourceFile: ts.SourceFile);
     get hasOnly(): boolean;
 }
 
@@ -322,14 +322,13 @@ declare enum TestMemberFlags {
 
 declare class TestMember {
     brand: TestMemberBrand;
-    node: ts.CallExpression;
-    parent: TestTree | TestMember;
-    flags: TestMemberFlags;
-    compiler: typeof ts;
     diagnostics: Set<ts.Diagnostic>;
+    flags: TestMemberFlags;
     members: Array<TestMember | Assertion>;
     name: string;
-    constructor(brand: TestMemberBrand, node: ts.CallExpression, parent: TestTree | TestMember, flags: TestMemberFlags);
+    node: ts.CallExpression;
+    parent: TestTree | TestMember;
+    constructor(compiler: typeof ts, brand: TestMemberBrand, node: ts.CallExpression, parent: TestTree | TestMember, flags: TestMemberFlags);
     get ancestorNames(): Array<string>;
     validate(): Array<Diagnostic>;
 }
@@ -338,11 +337,11 @@ interface MatcherNode extends ts.CallExpression {
     expression: ts.PropertyAccessExpression;
 }
 declare class Assertion extends TestMember {
+    isNot: boolean;
     matcherNode: MatcherNode;
     modifierNode: ts.PropertyAccessExpression;
     notNode: ts.PropertyAccessExpression | undefined;
-    isNot: boolean;
-    constructor(brand: TestMemberBrand, node: ts.CallExpression, parent: TestTree | TestMember, flags: TestMemberFlags, matcherNode: MatcherNode, modifierNode: ts.PropertyAccessExpression, notNode: ts.PropertyAccessExpression | undefined);
+    constructor(compiler: typeof ts, brand: TestMemberBrand, node: ts.CallExpression, parent: TestTree | TestMember, flags: TestMemberFlags, matcherNode: MatcherNode, modifierNode: ts.PropertyAccessExpression, notNode?: ts.PropertyAccessExpression);
     get ancestorNames(): Array<string>;
     get matcherName(): ts.MemberName;
     get source(): ts.NodeArray<ts.Expression> | ts.NodeArray<ts.TypeNode>;
@@ -351,10 +350,6 @@ declare class Assertion extends TestMember {
 
 declare class CollectService {
     #private;
-    compiler: typeof ts;
-    readonly matcherIdentifiers: string[];
-    readonly modifierIdentifiers: string[];
-    readonly notIdentifier = "not";
     constructor(compiler: typeof ts);
     createTestTree(sourceFile: ts.SourceFile, semanticDiagnostics?: Array<ts.Diagnostic>): TestTree;
 }
@@ -375,11 +370,11 @@ declare enum ResultStatus {
 
 declare class ExpectResult {
     assertion: Assertion;
-    parent: TestResult | undefined;
     diagnostics: Array<Diagnostic>;
+    parent: TestResult | undefined;
     status: ResultStatus;
     timing: ResultTiming;
-    constructor(assertion: Assertion, parent: TestResult | undefined);
+    constructor(assertion: Assertion, parent?: TestResult);
 }
 
 declare class ResultCount {
@@ -391,14 +386,14 @@ declare class ResultCount {
 }
 
 declare class TestResult {
-    test: TestMember;
-    parent: DescribeResult | undefined;
     diagnostics: Array<Diagnostic>;
     expectCount: ResultCount;
+    parent: DescribeResult | undefined;
     results: Array<ExpectResult>;
     status: ResultStatus;
+    test: TestMember;
     timing: ResultTiming;
-    constructor(test: TestMember, parent: DescribeResult | undefined);
+    constructor(test: TestMember, parent?: DescribeResult);
 }
 
 declare class DescribeResult {
@@ -406,47 +401,47 @@ declare class DescribeResult {
     parent: DescribeResult | undefined;
     results: Array<DescribeResult | TestResult>;
     timing: ResultTiming;
-    constructor(describe: TestMember, parent: DescribeResult | undefined);
+    constructor(describe: TestMember, parent?: DescribeResult);
 }
 
 type FileResultStatus = ResultStatus.Runs | ResultStatus.Passed | ResultStatus.Failed;
 declare class FileResult {
-    testFile: TestFile;
     diagnostics: Array<Diagnostic>;
     expectCount: ResultCount;
     results: Array<DescribeResult | TestResult | ExpectResult>;
     status: FileResultStatus;
     testCount: ResultCount;
+    testFile: TestFile;
     timing: ResultTiming;
     constructor(testFile: TestFile);
 }
 
 declare class ProjectResult {
     compilerVersion: string;
-    projectConfigFilePath: string | undefined;
     diagnostics: Array<Diagnostic>;
+    projectConfigFilePath: string | undefined;
     results: Array<FileResult>;
     constructor(compilerVersion: string, projectConfigFilePath: string | undefined);
 }
 
 type TargetResultStatus = ResultStatus.Runs | ResultStatus.Passed | ResultStatus.Failed;
 declare class TargetResult {
-    versionTag: string;
-    testFiles: Array<TestFile>;
     results: Map<string | undefined, ProjectResult>;
     status: TargetResultStatus;
+    testFiles: Array<TestFile>;
     timing: ResultTiming;
+    versionTag: string;
     constructor(versionTag: string, testFiles: Array<TestFile>);
 }
 
 declare class Result {
-    resolvedConfig: ResolvedConfig;
-    testFiles: Array<TestFile>;
     expectCount: ResultCount;
     fileCount: ResultCount;
+    resolvedConfig: ResolvedConfig;
     results: Array<TargetResult>;
     targetCount: ResultCount;
     testCount: ResultCount;
+    testFiles: Array<TestFile>;
     timing: ResultTiming;
     constructor(resolvedConfig: ResolvedConfig, testFiles: Array<TestFile>);
 }
@@ -579,7 +574,6 @@ declare function watchUsageText(): ScribblerJsx.Element;
 
 declare class SelectService {
     #private;
-    readonly resolvedConfig: ResolvedConfig;
     constructor(resolvedConfig: ResolvedConfig);
     isTestFile(filePath: string): boolean;
     selectFiles(): Promise<Array<string>>;
@@ -587,8 +581,7 @@ declare class SelectService {
 
 declare class TSTyche {
     #private;
-    readonly resolvedConfig: ResolvedConfig;
-    static readonly version = "2.0.0-beta.1";
+    static version: string;
     constructor(resolvedConfig: ResolvedConfig, outputService: OutputService, selectService: SelectService, storeService: StoreService);
     close(): void;
     run(testFiles: Array<string | URL>, cancellationToken?: CancellationToken): Promise<void>;
@@ -649,10 +642,10 @@ declare class PrimitiveTypeMatcher {
 }
 
 declare abstract class RelationMatcherBase {
-    typeChecker: TypeChecker;
     abstract relation: Relation;
     abstract relationExplanationText: string;
     relationExplanationVerb: string;
+    typeChecker: TypeChecker;
     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;
@@ -701,8 +694,6 @@ declare class ToRaiseError {
 
 declare class Expect {
     #private;
-    compiler: typeof ts;
-    typeChecker: TypeChecker;
     toBe: ToBe;
     toBeAny: PrimitiveTypeMatcher;
     toBeAssignable: ToBeAssignableWith;
@@ -742,7 +733,6 @@ declare class ExitCodeHandler implements EventHandler {
 
 declare class RuntimeReporter implements EventHandler {
     #private;
-    readonly resolvedConfig: ResolvedConfig;
     constructor(resolvedConfig: ResolvedConfig, outputService: OutputService);
     handleEvent([eventName, payload]: Event): void;
 }
@@ -782,16 +772,15 @@ declare class InputService {
 }
 
 declare class Path {
+    static normalizeSlashes: (filePath: string) => string;
     static dirname(filePath: string): string;
     static join(...filePaths: Array<string>): string;
-    static normalizeSlashes(filePath: string): string;
     static relative(from: string, to: string): string;
     static resolve(...filePaths: Array<string>): string;
 }
 
 declare class ProjectService {
     #private;
-    compiler: typeof ts;
     constructor(compiler: typeof ts);
     closeFile(filePath: string): void;
     getDefaultProject(filePath: string): ts.server.Project | undefined;
@@ -801,7 +790,6 @@ declare class ProjectService {
 
 declare class TaskRunner {
     #private;
-    readonly resolvedConfig: ResolvedConfig;
     constructor(resolvedConfig: ResolvedConfig, selectService: SelectService, storeService: StoreService);
     close(): void;
     run(testFiles: Array<TestFile>, cancellationToken?: CancellationToken): Promise<void>;
@@ -815,10 +803,12 @@ declare class Version {
 }
 
 type WatchHandler = (filePath: string) => void | Promise<void>;
+interface WatcherOptions {
+    recursive?: boolean;
+}
 declare class Watcher {
     #private;
-    readonly targetPath: string;
-    constructor(targetPath: string, onChanged: WatchHandler, onRemoved?: WatchHandler, recursive?: boolean);
+    constructor(targetPath: string, onChanged: WatchHandler, onRemoved?: WatchHandler, options?: WatcherOptions);
     close(): void;
     watch(): Promise<void>;
 }
@@ -831,10 +821,9 @@ declare class FileWatcher extends Watcher {
 type RunCallback = (testFiles: Array<TestFile>) => Promise<void>;
 declare class WatchService {
     #private;
-    readonly resolvedConfig: ResolvedConfig;
     constructor(resolvedConfig: ResolvedConfig, runCallback: RunCallback, selectService: SelectService, testFiles: Array<TestFile>);
     close(): void;
     watch(cancellationToken?: CancellationToken): Promise<Array<void>>;
 }
 
-export { Assertion, CancellationHandler, CancellationReason, CancellationToken, Cli, CollectService, Color, type CommandLineOptions, type ConfigFileOptions, ConfigService, DescribeResult, Diagnostic, DiagnosticCategory, type DiagnosticOrigin, Environment, type Event, EventEmitter, type EventHandler, ExitCodeHandler, Expect, ExpectResult, FileResult, type FileResultStatus, type FileWatchHandler, FileWatcher, type InputHandler, InputService, type InputServiceOptions, type ItemDefinition, Line, type MatchResult, OptionBrand, type OptionDefinition, OptionDefinitionsMap, OptionDiagnosticText, OptionGroup, OutputService, type OutputServiceOptions, Path, ProjectResult, ProjectService, type ReadStream, type ResolvedConfig, Result, ResultCount, ResultHandler, ResultStatus, ResultTiming, type RunCallback, RuntimeReporter, Scribbler, ScribblerJsx, type ScribblerOptions, 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 WriteStream, addsPackageStepText, defaultOptions, describeNameText, diagnosticText, fileStatusText, fileViewText, formattedText, helpText, summaryText, testNameText, usesCompilerStepText, waitingForFileChangesText, watchUsageText };
+export { Assertion, CancellationHandler, CancellationReason, CancellationToken, Cli, CollectService, Color, type CommandLineOptions, type ConfigFileOptions, ConfigService, DescribeResult, Diagnostic, DiagnosticCategory, DiagnosticOrigin, Environment, type Event, EventEmitter, type EventHandler, ExitCodeHandler, Expect, ExpectResult, FileResult, type FileResultStatus, type FileWatchHandler, FileWatcher, type InputHandler, InputService, type InputServiceOptions, type ItemDefinition, Line, type MatchResult, OptionBrand, type OptionDefinition, OptionDefinitionsMap, OptionDiagnosticText, OptionGroup, OutputService, type OutputServiceOptions, Path, ProjectResult, ProjectService, type ReadStream, type ResolvedConfig, Result, ResultCount, ResultHandler, ResultStatus, ResultTiming, type RunCallback, RuntimeReporter, Scribbler, ScribblerJsx, type ScribblerOptions, 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 };