tstyche 1.1.0 → 2.0.0-beta.0

package/README.md

@@ -25,7 +25,7 @@ function firstItem<T>(target: Array<T>): T | undefined {
 }
 
 test("firstItem", () => {
-  expect(firstItem(["a", "b", "c"])).type.toEqual<string | undefined>();
+  expect(firstItem(["a", "b", "c"])).type.toBe<string | undefined>();
 
   expect(firstItem()).type.toRaiseError("Expected 1 argument");
 });
@@ -52,13 +52,13 @@ function secondItem<T>(target: Array<T>): T | undefined {
 test("handles numbers", () => {
   assert.strictEqual(secondItem([1, 2, 3]), 2);
 
-  tstyche.expect(secondItem([1, 2, 3])).type.toEqual<number | undefined>();
+  tstyche.expect(secondItem([1, 2, 3])).type.toBe<number | undefined>();
 });
 ```
 
 Here is the list of all matchers:
 
-- `.toBeAssignable()`, `.toEqual()`, `.toMatch()` compares types or types of expression,
+- `.toBe()`, `.toBeAssignableTo()`, `.toBeAssignableWith()`, `.toMatch()` compare types or types of expression,
 - `.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.
@@ -91,8 +91,8 @@ If you have any questions or suggestions, [start a discussion](https://github.co
 [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/install-size/install/tstyche
-[install-size-url]: https://install-size.com/result?p=tstyche
+[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

package/build/index.d.cts

@@ -60,22 +60,115 @@ interface Test {
 }
 interface Matchers {
     /**
-     * Checks if the `any` type is identical to the source type.
+     * Checks if the source type is identical to the target type.
      */
-    toBeAny: () => void;
+    toBe: {
+        /**
+         * Checks if the source type is identical to the target type.
+         */
+        <Target>(): void;
+        /**
+         * Checks if the source type is identical to type of the target expression.
+         */
+        (target: unknown): void;
+    };
     /**
-     * Checks if the target type is assignable to the source type.
+     * Checks if the source type is assignable with the target type.
+     *
+     * @deprecated Use `.toBeAssignableWith()` or `.toBeAssignableTo()` instead. This matcher will be removed in TSTyche 3.
+     * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
      */
     toBeAssignable: {
         /**
-         * Checks if the target type is assignable to the source type.
+         * Checks if the source type is assignable with the target type.
+         *
+         * @deprecated Use `.toBeAssignableWith()` or `.toBeAssignableTo()` instead. This matcher will be removed in TSTyche 3.
+         * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
+         */
+        <Target>(): void;
+        /**
+         * Checks if the source type is assignable with type of the target expression.
+         *
+         * @deprecated Use `.toBeAssignableWith()` or `.toBeAssignableTo()` instead. This matcher will be removed in TSTyche 3.
+         * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
+         */
+        (target: unknown): void;
+    };
+    /**
+     * Checks if the source type is assignable to the target type.
+     */
+    toBeAssignableTo: {
+        /**
+         * Checks if the source type is assignable to the target type.
          */
         <Target>(): void;
         /**
-         * Checks if type of the target expression is assignable to the source type.
+         * Checks if the source type is assignable to type of the target expression.
          */
         (target: unknown): void;
     };
+    /**
+     * Checks if the source type is assignable with the target type.
+     */
+    toBeAssignableWith: {
+        /**
+         * Checks if the source type is assignable with the target type.
+         */
+        <Target>(): void;
+        /**
+         * Checks if the source type is assignable with type of the target expression.
+         */
+        (target: unknown): void;
+    };
+    /**
+     * Checks if the source type is identical to the target type.
+     *
+     * @deprecated Use `.toBe()` instead. This matcher will be removed in TSTyche 3.
+     * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
+     */
+    toEqual: {
+        /**
+         * Checks if the source type is identical to the target type.
+         *
+         * @deprecated Use `.toBe()` instead. This matcher will be removed in TSTyche 3.
+         * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
+         */
+        <Target>(): void;
+        /**
+         * Checks if the source type is identical to type of the target expression.
+         *
+         * @deprecated This matcher will be removed in TSTyche 3.
+         * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
+         */
+        (target: unknown): void;
+    };
+    /**
+     * 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.
+     */
+    toMatch: {
+        /**
+         * Checks if the source type matches the target type.
+         */
+        <Target>(): void;
+        /**
+         * Checks if the source type matches type of the target expression.
+         */
+        (target: unknown): void;
+    };
+    /**
+     * Checks if the source type raises an error.
+     */
+    toRaiseError: (...target: Array<string | number>) => void;
+}
+interface Matchers {
+    /**
+     * Checks if the source type is `any`.
+     */
+    toBeAny: () => void;
     /**
      * Checks if the source type is `bigint`.
      */
@@ -120,40 +213,6 @@ interface Matchers {
      * Checks if the source type is `void`.
      */
     toBeVoid: () => void;
-    /**
-     * Check if the target type is identical to the source type.
-     */
-    toEqual: {
-        /**
-         * Checks if the target type is identical to the source type.
-         */
-        <Target>(): void;
-        /**
-         * Checks if type of the target expression is identical to the source type.
-         */
-        (target: unknown): void;
-    };
-    /**
-     * Checks if a property key exists on the source type.
-     */
-    toHaveProperty: (key: string | number | symbol) => void;
-    /**
-     * Checks if the target type is a subtype the source type.
-     */
-    toMatch: {
-        /**
-         * Checks if the target type is a subtype the source type.
-         */
-        <Target>(): void;
-        /**
-         * Checks if type of the target expression is a subtype the source type.
-         */
-        (target: unknown): void;
-    };
-    /**
-     * Checks if the source type raises an error.
-     */
-    toRaiseError: (...target: Array<string | number>) => void;
 }
 interface Modifier {
     /**

package/build/index.d.ts

@@ -60,22 +60,115 @@ interface Test {
 }
 interface Matchers {
     /**
-     * Checks if the `any` type is identical to the source type.
+     * Checks if the source type is identical to the target type.
      */
-    toBeAny: () => void;
+    toBe: {
+        /**
+         * Checks if the source type is identical to the target type.
+         */
+        <Target>(): void;
+        /**
+         * Checks if the source type is identical to type of the target expression.
+         */
+        (target: unknown): void;
+    };
     /**
-     * Checks if the target type is assignable to the source type.
+     * Checks if the source type is assignable with the target type.
+     *
+     * @deprecated Use `.toBeAssignableWith()` or `.toBeAssignableTo()` instead. This matcher will be removed in TSTyche 3.
+     * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
      */
     toBeAssignable: {
         /**
-         * Checks if the target type is assignable to the source type.
+         * Checks if the source type is assignable with the target type.
+         *
+         * @deprecated Use `.toBeAssignableWith()` or `.toBeAssignableTo()` instead. This matcher will be removed in TSTyche 3.
+         * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
+         */
+        <Target>(): void;
+        /**
+         * Checks if the source type is assignable with type of the target expression.
+         *
+         * @deprecated Use `.toBeAssignableWith()` or `.toBeAssignableTo()` instead. This matcher will be removed in TSTyche 3.
+         * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
+         */
+        (target: unknown): void;
+    };
+    /**
+     * Checks if the source type is assignable to the target type.
+     */
+    toBeAssignableTo: {
+        /**
+         * Checks if the source type is assignable to the target type.
          */
         <Target>(): void;
         /**
-         * Checks if type of the target expression is assignable to the source type.
+         * Checks if the source type is assignable to type of the target expression.
          */
         (target: unknown): void;
     };
+    /**
+     * Checks if the source type is assignable with the target type.
+     */
+    toBeAssignableWith: {
+        /**
+         * Checks if the source type is assignable with the target type.
+         */
+        <Target>(): void;
+        /**
+         * Checks if the source type is assignable with type of the target expression.
+         */
+        (target: unknown): void;
+    };
+    /**
+     * Checks if the source type is identical to the target type.
+     *
+     * @deprecated Use `.toBe()` instead. This matcher will be removed in TSTyche 3.
+     * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
+     */
+    toEqual: {
+        /**
+         * Checks if the source type is identical to the target type.
+         *
+         * @deprecated Use `.toBe()` instead. This matcher will be removed in TSTyche 3.
+         * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
+         */
+        <Target>(): void;
+        /**
+         * Checks if the source type is identical to type of the target expression.
+         *
+         * @deprecated This matcher will be removed in TSTyche 3.
+         * To learn more, visit https://tstyche.org/release-notes/tstyche-2.
+         */
+        (target: unknown): void;
+    };
+    /**
+     * 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.
+     */
+    toMatch: {
+        /**
+         * Checks if the source type matches the target type.
+         */
+        <Target>(): void;
+        /**
+         * Checks if the source type matches type of the target expression.
+         */
+        (target: unknown): void;
+    };
+    /**
+     * Checks if the source type raises an error.
+     */
+    toRaiseError: (...target: Array<string | number>) => void;
+}
+interface Matchers {
+    /**
+     * Checks if the source type is `any`.
+     */
+    toBeAny: () => void;
     /**
      * Checks if the source type is `bigint`.
      */
@@ -120,40 +213,6 @@ interface Matchers {
      * Checks if the source type is `void`.
      */
     toBeVoid: () => void;
-    /**
-     * Check if the target type is identical to the source type.
-     */
-    toEqual: {
-        /**
-         * Checks if the target type is identical to the source type.
-         */
-        <Target>(): void;
-        /**
-         * Checks if type of the target expression is identical to the source type.
-         */
-        (target: unknown): void;
-    };
-    /**
-     * Checks if a property key exists on the source type.
-     */
-    toHaveProperty: (key: string | number | symbol) => void;
-    /**
-     * Checks if the target type is a subtype the source type.
-     */
-    toMatch: {
-        /**
-         * Checks if the target type is a subtype the source type.
-         */
-        <Target>(): void;
-        /**
-         * Checks if type of the target expression is a subtype the source type.
-         */
-        (target: unknown): void;
-    };
-    /**
-     * Checks if the source type raises an error.
-     */
-    toRaiseError: (...target: Array<string | number>) => void;
 }
 interface Modifier {
     /**

package/build/tstyche.d.ts

@@ -43,7 +43,6 @@ declare class StoreService {
     install(tag: string, cancellationToken?: CancellationToken): Promise<string | undefined>;
     load(tag: string, cancellationToken?: CancellationToken): Promise<typeof ts | undefined>;
     open(): Promise<void>;
-    prune: () => Promise<void>;
     resolveTag(tag: string): Promise<string | undefined>;
     update(): Promise<void>;
     validateTag(tag: string): Promise<boolean | undefined>;
@@ -137,6 +136,10 @@ interface CommandLineOptions {
      * Print the version number and exit.
      */
     version?: boolean;
+    /**
+     * Watch for changes and rerun related tests files.
+     */
+    watch?: boolean;
 }
 
 /**
@@ -177,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.1.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 {
@@ -257,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.
      */
@@ -376,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;
@@ -466,20 +487,26 @@ 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;
+}
+
+declare class ToBeAssignableTo extends RelationMatcherBase {
     relation: Relation;
     relationExplanationText: string;
-    match(sourceType: ts.Type, targetType: ts.Type, isNot: boolean): MatchResult;
 }
 
-declare class ToEqual extends RelationMatcherBase {
+declare class ToBeAssignableWith extends RelationMatcherBase {
     relation: Relation;
     relationExplanationText: string;
+    match(sourceType: ts.Type, targetType: ts.Type, isNot: boolean): MatchResult;
 }
 
 declare class ToHaveProperty {
@@ -493,6 +520,7 @@ declare class ToHaveProperty {
 declare class ToMatch extends RelationMatcherBase {
     relation: Relation;
     relationExplanationText: string;
+    relationExplanationVerb: string;
 }
 
 declare class ToRaiseError {
@@ -510,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;
@@ -523,7 +554,7 @@ declare class Expect {
     toBeUniqueSymbol: PrimitiveTypeMatcher;
     toBeUnknown: PrimitiveTypeMatcher;
     toBeVoid: PrimitiveTypeMatcher;
-    toEqual: ToEqual;
+    toEqual: ToBe;
     toHaveProperty: ToHaveProperty;
     toMatch: ToMatch;
     toRaiseError: ToRaiseError;
@@ -532,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;
@@ -590,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;
@@ -607,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;
@@ -627,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;
 }
@@ -641,6 +663,10 @@ 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;
@@ -704,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;
 }
 
@@ -754,4 +759,12 @@ declare class Version {
     static isVersionTag(target: string): boolean;
 }
 
-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, 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 };