tstyche 7.0.0 → 7.2.0

package/README.md

@@ -30,14 +30,14 @@ test("isSameLength", () => {
 });
 ```
 
-To group and organize tests, TSTyche has:
+TSTyche lets you organize tests using:
 
-- `test()`, `it()` and `describe()` helpers,
-- with `.only`, `.skip` and `.todo` run mode flags.
+- helpers: `test()`, `it()` and `describe()`
+- run mode flags: `.only`, `.skip` and `.todo`
 
 ## Assertions
 
-The `expect` style assertions can check either the inferred type of an expression (as in the example above) or a type directly:
+The `expect` style assertions can check either the inferred type of an expression or a type directly:
 
 ```ts
 import { type _, expect } from "tstyche";
@@ -58,32 +58,32 @@ expect<WithLoading<_>>().type.not.toBeInstantiableWith<[string]>();
 
 Relation matchers:
 
-- `.toBe()` checks if a type is the same as the given type,
-- `.toBeAssignableFrom()` checks if a type is assignable from the given type,
-- `.toBeAssignableTo()` checks if a type is assignable to the given type.
+- `.toBe()` checks if a type is the same as the given type
+- `.toBeAssignableFrom()` checks if a type is assignable from the given type
+- `.toBeAssignableTo()` checks if a type is assignable to the given type
 
 Ability matchers:
 
-- `.toAcceptProps()` checks if a JSX component accepts the given props,
-- `.toBeApplicable` checks if a decorator is applicable to the given class or class member,
-- `.toBeCallableWith()` checks if a function is callable with the given arguments,
-- `.toBeConstructableWith()` checks if a class is constructable with the given arguments,
-- `.toBeInstantiableWith()` checks if a generic is instantiable with the given type arguments,
-- `.toHaveProperty()` checks if a type has the given property.
+- `.toAcceptProps()` checks if a JSX component accepts the given props
+- `.toBeApplicable` checks if a decorator is applicable to the given class or class member
+- `.toBeCallableWith()` checks if a function is callable with the given arguments
+- `.toBeConstructableWith()` checks if a class is constructable with the given arguments
+- `.toBeInstantiableWith()` checks if a generic is instantiable with the given type arguments
+- `.toHaveProperty()` checks if a type has the given property
 
 ## Runner
 
-The `tstyche` command is the heart of TSTyche. It allows you to select test files by path, filter tests by name and run them against specific versions of TypeScript:
+The `tstyche` command is the heart of TSTyche. It lets you select test files by path, filter tests by name and run them against specific versions of TypeScript:
 
 ```shell
 tstyche query-params --only multiple --target '>=5.6'
 ```
 
-It is that simple! Actually, TSTyche does even more:
+That is just the beginning. It even lets you:
 
-- checks messages of errors suppressed by `@ts-expect-error` directives,
-- generates type tests from a data table,
-- runs tests in watch mode.
+- check messages of errors suppressed by `@ts-expect-error` directives
+- generate type tests from a template file
+- run tests in watch mode
 
 ## Try It Out
 
@@ -95,6 +95,10 @@ Try TSTyche online on StackBlitz:
 
 Visit [tstyche.org](https://tstyche.org) to view the full documentation.
 
+## Roadmap
+
+See [ROADMAP.md](https://github.com/tstyche/tstyche/blob/main/ROADMAP.md) for planned features.
+
 ## License
 
 [MIT][license-url] © TSTyche

package/dist/api.d.ts

@@ -1,4 +1,4 @@
-import type ts from 'typescript';
+import ts from 'typescript';
 
 declare enum CancellationReason {
     ConfigChange = "configChange",
@@ -36,8 +36,7 @@ declare enum TestTreeNodeBrand {
     Describe = "describe",
     Test = "test",
     It = "it",
-    Expect = "expect",
-    When = "when"
+    Expect = "expect"
 }
 
 declare enum TestTreeNodeFlags {
@@ -47,17 +46,9 @@ declare enum TestTreeNodeFlags {
     Todo = 4
 }
 
-declare class WhenNode extends TestTreeNode {
-    actionNode: ts.CallExpression;
-    actionNameNode: ts.PropertyAccessExpression;
-    abilityDiagnostics: Set<ts.Diagnostic>;
-    target: ts.NodeArray<ts.Expression> | ts.NodeArray<ts.TypeNode>;
-    constructor(compiler: typeof ts, brand: TestTreeNodeBrand, node: ts.CallExpression, parent: TestTree | TestTreeNode, flags: TestTreeNodeFlags, actionNode: ts.CallExpression, actionNameNode: ts.PropertyAccessExpression);
-}
-
 declare class TestTreeNode {
     brand: TestTreeNodeBrand;
-    children: Array<TestTreeNode | ExpectNode | WhenNode>;
+    children: Array<TestTreeNode | ExpectNode>;
     diagnostics: Set<ts.Diagnostic>;
     flags: TestTreeNodeFlags;
     name: string;
@@ -79,7 +70,7 @@ declare class ExpectNode extends TestTreeNode {
 }
 
 declare class TestTree {
-    children: Array<TestTreeNode | ExpectNode | WhenNode>;
+    children: Array<TestTreeNode | ExpectNode>;
     diagnostics: Set<ts.Diagnostic>;
     hasOnly: boolean;
     sourceFile: ts.SourceFile;
@@ -93,9 +84,9 @@ declare class DiagnosticOrigin {
     sourceFile: ts.SourceFile | JsonSourceFile;
     start: number;
     constructor(start: number, end: number, sourceFile: ts.SourceFile | JsonSourceFile, assertionNode?: ExpectNode);
+    static fromAbilityDiagnostic(diagnostic: ts.DiagnosticWithLocation, assertionNode: ExpectNode): DiagnosticOrigin;
     static fromAssertion(assertionNode: ExpectNode): DiagnosticOrigin;
     static fromNode(node: ts.Node, assertionNode?: ExpectNode): DiagnosticOrigin;
-    static fromNodes(nodes: ts.NodeArray<ts.Node>, assertionNode?: ExpectNode): DiagnosticOrigin;
 }
 
 declare class Diagnostic {
@@ -115,12 +106,27 @@ declare class Diagnostic {
     static warning(text: string | Array<string>, origin?: DiagnosticOrigin): Diagnostic;
 }
 
+type DiagnosticsHandler<T extends Diagnostic | Array<Diagnostic> = Diagnostic> = (this: void, diagnostics: T) => void;
+interface Offset {
+    position: number;
+    diff: number;
+}
+
 declare function diagnosticBelongsToNode(diagnostic: ts.Diagnostic, node: ts.NodeArray<ts.Node> | ts.Node): boolean;
 declare function getDiagnosticMessageText(diagnostic: ts.Diagnostic): string | Array<string>;
 declare function getTextSpanEnd(span: ts.TextSpan): number;
 declare function isDiagnosticWithLocation(diagnostic: ts.Diagnostic): diagnostic is ts.DiagnosticWithLocation;
 
-type DiagnosticsHandler<T extends Diagnostic | Array<Diagnostic> = Diagnostic> = (this: void, diagnostics: T) => void;
+declare class MappedDiagnostic {
+    category: ts.DiagnosticCategory;
+    code: number;
+    file: ts.SourceFile;
+    length: number | undefined;
+    messageText: string | ts.DiagnosticMessageChain;
+    relatedInformation?: Array<ts.DiagnosticRelatedInformation>;
+    start: number | undefined;
+    constructor(sourceFile: ts.SourceFile, diagnostic: ts.Diagnostic, offsets?: Array<Offset>);
+}
 
 declare class JsonSourceFile {
     #private;
@@ -282,12 +288,13 @@ declare class Options {
 }
 
 interface EnvironmentOptions {
+    fetchRetries: number;
+    fetchTimeout: number;
     isCi: boolean;
     noColor: boolean;
     noInteractive: boolean;
     npmRegistry: string;
     storePath: string;
-    timeout: number;
     typescriptModule: string | undefined;
 }
 
@@ -451,9 +458,6 @@ declare class SuppressedResult {
     constructor(suppressed: SuppressedError);
 }
 
-interface EventHandler {
-    on: (event: Event) => void;
-}
 type Event = ["config:error", {
     diagnostics: Array<Diagnostic>;
 }] | ["select:error", {
@@ -490,7 +494,7 @@ type Event = ["config:error", {
 }] | ["collect:error", {
     diagnostics: Array<Diagnostic>;
 }] | ["collect:node", {
-    node: TestTreeNode | ExpectNode | WhenNode;
+    node: TestTreeNode | ExpectNode;
 }] | ["collect:end", {
     tree: TestTree;
 }] | ["describe:start", {
@@ -536,6 +540,9 @@ type Event = ["config:error", {
 }] | ["watch:error", {
     diagnostics: Array<Diagnostic>;
 }];
+interface EventHandler {
+    on: (event: Event) => void;
+}
 
 declare class EventEmitter {
     #private;
@@ -750,5 +757,5 @@ declare class Version {
     static isSatisfiedWith(source: string, target: string): boolean;
 }
 
-export { BaseReporter, CancellationReason, CancellationToken, Cli, Color, Config, ConfigDiagnosticText, DescribeResult, Diagnostic, DiagnosticCategory, DiagnosticOrigin, Directive, DotReporter, EventEmitter, ExpectResult, FileLocation, FileResult, Line, ListReporter, OptionBrand, OptionGroup, Options, OutputService, Path, ProjectConfigKind, ProjectResult, Result, ResultStatus, Runner, Scribbler, ScribblerJsx, Select, SelectDiagnosticText, SetupReporter, Store, StreamController, SummaryReporter, SuppressedResult, TargetResult, TestResult, Text, Version, WatchReporter, addsText, defaultOptions, describeNameText, diagnosticBelongsToNode, diagnosticText, dotText, environmentOptions, fileStatusText, formattedText, getDiagnosticMessageText, getTextSpanEnd, helpText, isDiagnosticWithLocation, prologueText, summaryText, testNameText, usesText, waitingForFileChangesText, watchUsageText };
-export type { AssertionCounts, AssertionResultStatus, CodeFrameOptions, CommandLineOptions, ConfigFileOptions, DiagnosticsHandler, DirectiveRange, EnvironmentOptions, Event, EventHandler, FileCounts, FileResultStatus, InlineConfig, ItemDefinition, OptionDefinition, ProjectConfig, Reporter, ReporterEvent, ResolvedConfig, ResultCounts, ResultTiming, ScribblerOptions, SuppressedCounts, SuppressedResultStatus, TargetCounts, TargetResultStatus, TestCounts, TestResultStatus, TextRange, WriteStream };
+export { BaseReporter, CancellationReason, CancellationToken, Cli, Color, Config, ConfigDiagnosticText, DescribeResult, Diagnostic, DiagnosticCategory, DiagnosticOrigin, Directive, DotReporter, EventEmitter, ExpectResult, FileLocation, FileResult, Line, ListReporter, MappedDiagnostic, OptionBrand, OptionGroup, Options, OutputService, Path, ProjectConfigKind, ProjectResult, Result, ResultStatus, Runner, Scribbler, ScribblerJsx, Select, SelectDiagnosticText, SetupReporter, Store, StreamController, SummaryReporter, SuppressedResult, TargetResult, TestResult, Text, Version, WatchReporter, addsText, defaultOptions, describeNameText, diagnosticBelongsToNode, diagnosticText, dotText, environmentOptions, fileStatusText, formattedText, getDiagnosticMessageText, getTextSpanEnd, helpText, isDiagnosticWithLocation, prologueText, summaryText, testNameText, usesText, waitingForFileChangesText, watchUsageText };
+export type { AssertionCounts, AssertionResultStatus, CodeFrameOptions, CommandLineOptions, ConfigFileOptions, DiagnosticsHandler, DirectiveRange, EnvironmentOptions, Event, EventHandler, FileCounts, FileResultStatus, InlineConfig, ItemDefinition, Offset, OptionDefinition, ProjectConfig, Reporter, ReporterEvent, ResolvedConfig, ResultCounts, ResultTiming, ScribblerOptions, SuppressedCounts, SuppressedResultStatus, TargetCounts, TargetResultStatus, TestCounts, TestResultStatus, TextRange, WriteStream };