tstyche 3.4.0 → 4.0.0-beta.0

package/README.md

@@ -59,8 +59,7 @@ Here is the list of all matchers:
 - `.toBe()`, `.toBeAssignableTo()`, `.toBeAssignableWith()` compare types or types of expression,
 - `.toAcceptProps()` checks JSX component props type,
 - `.toHaveProperty()` looks up keys on an object type,
-- `.toRaiseError()` captures the type error message or code,
-- `.toBeString()`, `.toBeNumber()`, `.toBeVoid()` and 9 more shorthand checks for primitive types.
+- `.toRaiseError()` captures the type error message or code.
 
 ## Runner
 

package/build/index.d.cts

@@ -127,80 +127,11 @@ interface Matchers {
      * Checks if a property key exists on the source type.
      */
     toHaveProperty: (key: string | number | symbol) => void;
-    /**
-     * Checks if the source type matches the target type.
-     *
-     * @deprecated This matcher will be removed in TSTyche 4. To learn more, visit https://tstyche.org/release-notes/tstyche-3.
-     */
-    toMatch: {
-        /**
-         * Checks if the source type matches the target type.
-         *
-         * @deprecated This matcher will be removed in TSTyche 4. To learn more, visit https://tstyche.org/release-notes/tstyche-3.
-         */
-        <Target>(): void;
-        /**
-         * Checks if the source type matches type of the target expression.
-         *
-         * @deprecated This matcher will be removed in TSTyche 4. To learn more, visit https://tstyche.org/release-notes/tstyche-3.
-         */
-        (target: unknown): void;
-    };
     /**
      * Checks if the source type raises an error.
      */
     toRaiseError: (...target: Array<string | number | RegExp>) => void;
 }
-interface Matchers {
-    /**
-     * Checks if the source type is `any`.
-     */
-    toBeAny: () => void;
-    /**
-     * Checks if the source type is `bigint`.
-     */
-    toBeBigInt: () => void;
-    /**
-     * Checks if the source type is `boolean`.
-     */
-    toBeBoolean: () => void;
-    /**
-     * Checks if the source type is `never`.
-     */
-    toBeNever: () => void;
-    /**
-     * Checks if the source type is `null`.
-     */
-    toBeNull: () => void;
-    /**
-     * Checks if the source type is `number`.
-     */
-    toBeNumber: () => void;
-    /**
-     * Checks if the source type is `string`.
-     */
-    toBeString: () => void;
-    /**
-     * Checks if the source type is `symbol`.
-     */
-    toBeSymbol: () => void;
-    /**
-     * Checks if the source type is `undefined`.
-     */
-    toBeUndefined: () => void;
-    /**
-     * Checks if the source type is `unique symbol`.
-     */
-    toBeUniqueSymbol: () => void;
-    /**
-     * Checks if the source type is `unknown`.
-     */
-    toBeUnknown: () => void;
-    /**
-     * Checks if the source type is `void`.
-     */
-    toBeVoid: () => void;
-}
 interface Modifier {
     /**
      * Passes the source type to the matcher.

package/build/index.d.ts

@@ -127,80 +127,11 @@ interface Matchers {
      * Checks if a property key exists on the source type.
      */
     toHaveProperty: (key: string | number | symbol) => void;
-    /**
-     * Checks if the source type matches the target type.
-     *
-     * @deprecated This matcher will be removed in TSTyche 4. To learn more, visit https://tstyche.org/release-notes/tstyche-3.
-     */
-    toMatch: {
-        /**
-         * Checks if the source type matches the target type.
-         *
-         * @deprecated This matcher will be removed in TSTyche 4. To learn more, visit https://tstyche.org/release-notes/tstyche-3.
-         */
-        <Target>(): void;
-        /**
-         * Checks if the source type matches type of the target expression.
-         *
-         * @deprecated This matcher will be removed in TSTyche 4. To learn more, visit https://tstyche.org/release-notes/tstyche-3.
-         */
-        (target: unknown): void;
-    };
     /**
      * Checks if the source type raises an error.
      */
     toRaiseError: (...target: Array<string | number | RegExp>) => void;
 }
-interface Matchers {
-    /**
-     * Checks if the source type is `any`.
-     */
-    toBeAny: () => void;
-    /**
-     * Checks if the source type is `bigint`.
-     */
-    toBeBigInt: () => void;
-    /**
-     * Checks if the source type is `boolean`.
-     */
-    toBeBoolean: () => void;
-    /**
-     * Checks if the source type is `never`.
-     */
-    toBeNever: () => void;
-    /**
-     * Checks if the source type is `null`.
-     */
-    toBeNull: () => void;
-    /**
-     * Checks if the source type is `number`.
-     */
-    toBeNumber: () => void;
-    /**
-     * Checks if the source type is `string`.
-     */
-    toBeString: () => void;
-    /**
-     * Checks if the source type is `symbol`.
-     */
-    toBeSymbol: () => void;
-    /**
-     * Checks if the source type is `undefined`.
-     */
-    toBeUndefined: () => void;
-    /**
-     * Checks if the source type is `unique symbol`.
-     */
-    toBeUniqueSymbol: () => void;
-    /**
-     * Checks if the source type is `unknown`.
-     */
-    toBeUnknown: () => void;
-    /**
-     * Checks if the source type is `void`.
-     */
-    toBeVoid: () => void;
-}
 interface Modifier {
     /**
      * Passes the source type to the matcher.

package/build/tstyche.d.ts

@@ -38,17 +38,16 @@ declare class SourceFile {
 }
 
 declare class DiagnosticOrigin {
-    assertion: Assertion | undefined;
+    assertion: AssertionNode | undefined;
     end: number;
     sourceFile: SourceFile | ts.SourceFile;
     start: number;
-    constructor(start: number, end: number, sourceFile: SourceFile | ts.SourceFile, assertion?: Assertion);
-    static fromAssertion(assertion: Assertion): DiagnosticOrigin;
-    static fromNode(node: ts.Node, assertion?: Assertion): DiagnosticOrigin;
+    constructor(start: number, end: number, sourceFile: SourceFile | ts.SourceFile, assertion?: AssertionNode);
+    static fromAssertion(assertion: AssertionNode): DiagnosticOrigin;
+    static fromNode(node: ts.Node, assertion?: AssertionNode): DiagnosticOrigin;
 }
 
 declare class Diagnostic {
-    #private;
     category: DiagnosticCategory;
     code: string | undefined;
     origin: DiagnosticOrigin | undefined;
@@ -62,18 +61,19 @@ 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>): Array<Diagnostic>;
+    static toMessageText(chain: ts.DiagnosticMessageChain): Array<string>;
     static warning(text: string | Array<string>, origin?: DiagnosticOrigin): Diagnostic;
 }
 
 type DiagnosticsHandler<T extends Diagnostic | Array<Diagnostic> = Diagnostic> = (this: void, diagnostics: T) => void;
 
-declare enum TestMemberBrand {
+declare enum TestTreeNodeBrand {
     Describe = "describe",
     Test = "test",
     Expect = "expect"
 }
 
-declare enum TestMemberFlags {
+declare enum TestTreeNodeFlags {
     None = 0,
     Fail = 1,
     Only = 2,
@@ -81,31 +81,31 @@ 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 {
+declare class TestTreeNode {
     #private;
-    brand: TestMemberBrand;
+    brand: TestTreeNodeBrand;
+    children: Array<TestTreeNode | AssertionNode>;
     diagnostics: Set<ts.Diagnostic>;
-    flags: TestMemberFlags;
-    members: Array<TestMember | Assertion>;
+    flags: TestTreeNodeFlags;
     name: string;
     node: ts.CallExpression;
-    parent: TestTree | TestMember;
-    constructor(compiler: typeof ts, brand: TestMemberBrand, node: ts.CallExpression, parent: TestTree | TestMember, flags: TestMemberFlags);
+    parent: TestTree | TestTreeNode;
+    constructor(compiler: typeof ts, brand: TestTreeNodeBrand, node: ts.CallExpression, parent: TestTree | TestTreeNode, flags: TestTreeNodeFlags);
     validate(): Array<Diagnostic>;
 }
 
+declare class TestTree {
+    children: Array<TestTreeNode | AssertionNode>;
+    diagnostics: Set<ts.Diagnostic>;
+    hasOnly: boolean;
+    sourceFile: ts.SourceFile;
+    constructor(diagnostics: Set<ts.Diagnostic>, sourceFile: ts.SourceFile);
+}
+
 interface MatcherNode extends ts.CallExpression {
     expression: ts.PropertyAccessExpression;
 }
-declare class Assertion extends TestMember {
+declare class AssertionNode extends TestTreeNode {
     isNot: boolean;
     matcherName: ts.MemberName;
     matcherNode: MatcherNode;
@@ -113,7 +113,7 @@ declare class Assertion extends TestMember {
     notNode: ts.PropertyAccessExpression | undefined;
     source: ts.NodeArray<ts.Expression> | ts.NodeArray<ts.TypeNode>;
     target: ts.NodeArray<ts.Expression> | ts.NodeArray<ts.TypeNode>;
-    constructor(compiler: typeof ts, brand: TestMemberBrand, node: ts.CallExpression, parent: TestTree | TestMember, flags: TestMemberFlags, matcherNode: MatcherNode, modifierNode: ts.PropertyAccessExpression, notNode?: ts.PropertyAccessExpression);
+    constructor(compiler: typeof ts, brand: TestTreeNodeBrand, node: ts.CallExpression, parent: TestTree | TestTreeNode, flags: TestTreeNodeFlags, matcherNode: MatcherNode, modifierNode: ts.PropertyAccessExpression, notNode?: ts.PropertyAccessExpression);
 }
 
 declare class CollectService {
@@ -207,13 +207,13 @@ interface CommandLineOptions {
      */
     failFast?: boolean;
     /**
-     * Print the list of command line options with brief descriptions and exit.
+     * Fetch specified versions of the 'typescript' package and exit.
      */
-    help?: boolean;
+    fetch?: boolean;
     /**
-     * Install specified versions of the 'typescript' package and exit.
+     * Print the list of command line options with brief descriptions and exit.
      */
-    install?: boolean;
+    help?: boolean;
     /**
      * Print the list of supported versions of the 'typescript' package and exit.
      */
@@ -406,12 +406,12 @@ declare enum ResultStatus {
 }
 
 declare class ExpectResult {
-    assertion: Assertion;
+    assertion: AssertionNode;
     diagnostics: Array<Diagnostic>;
     parent: TestResult | undefined;
     status: ResultStatus;
     timing: ResultTiming;
-    constructor(assertion: Assertion, parent?: TestResult);
+    constructor(assertion: AssertionNode, parent?: TestResult);
 }
 
 declare class ResultCount {
@@ -428,17 +428,17 @@ declare class TestResult {
     parent: DescribeResult | undefined;
     results: Array<ExpectResult>;
     status: ResultStatus;
-    test: TestMember;
+    test: TestTreeNode;
     timing: ResultTiming;
-    constructor(test: TestMember, parent?: DescribeResult);
+    constructor(test: TestTreeNode, parent?: DescribeResult);
 }
 
 declare class DescribeResult {
-    describe: TestMember;
+    describe: TestTreeNode;
     parent: DescribeResult | undefined;
     results: Array<DescribeResult | TestResult>;
     timing: ResultTiming;
-    constructor(describe: TestMember, parent?: DescribeResult);
+    constructor(describe: TestTreeNode, parent?: DescribeResult);
 }
 
 declare class Task {
@@ -497,8 +497,6 @@ type Event = ["config:error", {
     diagnostics: Array<Diagnostic>;
 }] | ["select:error", {
     diagnostics: Array<Diagnostic>;
-}] | ["deprecation:info", {
-    diagnostics: Array<Diagnostic>;
 }] | ["run:start", {
     result: Result;
 }] | ["run:end", {
@@ -524,6 +522,12 @@ type Event = ["config:error", {
     result: TaskResult;
 }] | ["task:end", {
     result: TaskResult;
+}] | ["collect:start", {
+    testTree: TestTree;
+}] | ["collect:node", {
+    testNode: TestTreeNode | AssertionNode;
+}] | ["collect:end", {
+    testTree: TestTree;
 }] | ["describe:start", {
     result: DescribeResult;
 }] | ["describe:end", {
@@ -581,7 +585,6 @@ interface TypeChecker extends ts.TypeChecker {
     relation: {
         assignable: Relation;
         identity: Relation;
-        subtype: Relation;
     };
 }
 
@@ -589,25 +592,12 @@ declare class ExpectService {
     #private;
     private toAcceptProps;
     private toBe;
-    private toBeAny;
     private toBeAssignableTo;
     private toBeAssignableWith;
-    private toBeBigInt;
-    private toBeBoolean;
-    private toBeNever;
-    private toBeNull;
-    private toBeNumber;
-    private toBeString;
-    private toBeSymbol;
-    private toBeUndefined;
-    private toBeUniqueSymbol;
-    private toBeUnknown;
-    private toBeVoid;
     private toHaveProperty;
-    private toMatch;
     private toRaiseError;
-    constructor(compiler: typeof ts, typeChecker: TypeChecker, resolvedConfig?: ResolvedConfig);
-    match(assertion: Assertion, onDiagnostics: DiagnosticsHandler<Diagnostic | Array<Diagnostic>>): MatchResult | undefined;
+    constructor(compiler: typeof ts, typeChecker: TypeChecker, resolvedConfig: ResolvedConfig);
+    match(assertion: AssertionNode, onDiagnostics: DiagnosticsHandler<Diagnostic | Array<Diagnostic>>): MatchResult | undefined;
 }
 
 declare class CancellationHandler implements EventHandler {
@@ -627,6 +617,11 @@ declare class ResultHandler implements EventHandler {
     on([event, payload]: Event): void;
 }
 
+declare class TestTreeHandler implements EventHandler {
+    testTree: TestTree | undefined;
+    on([event, payload]: Event): void;
+}
+
 type InputHandler = (chunk: string) => void;
 declare class InputService {
     #private;
@@ -652,9 +647,6 @@ declare namespace ScribblerJsx {
         props: Record<string, unknown>;
         type: FunctionComponent | number | string;
     }
-    interface ElementChildrenAttribute {
-        children: ScribblerNode;
-    }
     interface IntrinsicElements {
         ansi: {
             escapes: Color | Array<Color>;
@@ -695,7 +687,13 @@ declare function addsPackageText(packageVersion: string, packagePath: string): S
 
 declare function describeNameText(name: string, indent?: number): ScribblerJsx.Element;
 
-declare function diagnosticText(diagnostic: Diagnostic): ScribblerJsx.Element;
+interface CodeFrameOptions {
+    linesAbove?: number;
+    linesBelow?: number;
+    showBreadcrumbs?: boolean;
+}
+
+declare function diagnosticText(diagnostic: Diagnostic, codeFrameOptions?: CodeFrameOptions): ScribblerJsx.Element;
 
 declare function taskStatusText(status: TaskResultStatus, task: Task): ScribblerJsx.Element;
 
@@ -800,6 +798,7 @@ declare class SelectDiagnosticText {
 interface ManifestData {
     $version?: string;
     lastUpdated?: number;
+    minorVersions: Array<string>;
     npmRegistry: string;
     packages: Record<string, {
         integrity: string;
@@ -812,6 +811,7 @@ declare class Manifest {
     #private;
     $version: string;
     lastUpdated: number;
+    minorVersions: Array<string>;
     npmRegistry: string;
     packages: Record<string, {
         integrity: string;
@@ -831,9 +831,7 @@ declare class Manifest {
 declare class Store {
     #private;
     static manifest: Manifest | undefined;
-    /** @deprecated Use 'Store.manifest' directly. */
-    static getSupportedTags(): Promise<Array<string> | undefined>;
-    static install(tag: string): Promise<void>;
+    static fetch(tag: string): Promise<void>;
     static load(tag: string): Promise<typeof ts | undefined>;
     static open(): Promise<void>;
     static prune(): Promise<void>;
@@ -845,8 +843,6 @@ declare class Version {
     #private;
     static isGreaterThan(source: string, target: string): boolean;
     static isSatisfiedWith(source: string, target: string): boolean;
-    /** @deprecated Name of this method is misleading and it is also not needed. */
-    static isVersionTag(target: string): boolean;
 }
 
 type WatchHandler = (filePath: string) => void;
@@ -871,4 +867,5 @@ declare class WatchService {
     watch(cancellationToken: CancellationToken): AsyncIterable<Array<Task>>;
 }
 
-export { Assertion, BaseReporter, CancellationHandler, CancellationReason, CancellationToken, Cli, CollectService, Color, type CommandLineOptions, Config, ConfigDiagnosticText, type ConfigFileOptions, DescribeResult, Diagnostic, DiagnosticCategory, DiagnosticOrigin, type DiagnosticsHandler, type EnvironmentOptions, type Event, EventEmitter, type EventHandler, ExitCodeHandler, ExpectResult, ExpectService, type FileWatchHandler, FileWatcher, type InputHandler, InputService, type ItemDefinition, Line, ListReporter, type MatchResult, OptionBrand, type OptionDefinition, OptionGroup, Options, OutputService, Path, type Plugin, PluginService, ProjectResult, ProjectService, type Reporter, type ReporterEvent, type ResolvedConfig, Result, ResultCount, ResultHandler, ResultStatus, ResultTiming, Runner, Scribbler, ScribblerJsx, type ScribblerOptions, Select, SelectDiagnosticText, type SelectHookContext, SetupReporter, SourceFile, Store, SummaryReporter, 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 };
+export { AssertionNode, BaseReporter, CancellationHandler, CancellationReason, CancellationToken, Cli, CollectService, Color, Config, ConfigDiagnosticText, DescribeResult, Diagnostic, DiagnosticCategory, DiagnosticOrigin, EventEmitter, ExitCodeHandler, ExpectResult, ExpectService, FileWatcher, InputService, Line, ListReporter, OptionBrand, OptionGroup, Options, OutputService, Path, PluginService, ProjectResult, ProjectService, Result, ResultCount, ResultHandler, ResultStatus, ResultTiming, Runner, Scribbler, ScribblerJsx, Select, SelectDiagnosticText, SetupReporter, SourceFile, Store, SummaryReporter, TargetResult, Task, TaskResult, TestResult, TestTree, TestTreeHandler, TestTreeNode, TestTreeNodeBrand, TestTreeNodeFlags, Text, Version, WatchReporter, WatchService, Watcher, addsPackageText, defaultOptions, describeNameText, diagnosticText, environmentOptions, fileViewText, formattedText, helpText, summaryText, taskStatusText, testNameText, usesCompilerText, waitingForFileChangesText, watchUsageText };
+export type { CodeFrameOptions, CommandLineOptions, ConfigFileOptions, DiagnosticsHandler, EnvironmentOptions, Event, EventHandler, FileWatchHandler, InputHandler, ItemDefinition, MatchResult, OptionDefinition, Plugin, Reporter, ReporterEvent, ResolvedConfig, ScribblerOptions, SelectHookContext, TargetResultStatus, TaskResultStatus, TypeChecker, WatchHandler, WatcherOptions };