tstyche 4.0.0-beta.6 → 4.0.0-beta.7

package/README.md

@@ -18,18 +18,15 @@ If you are used to test JavaScript, a simple type test file should look familiar
 ```ts
 import { expect, test } from "tstyche";
 
-function pickLonger<T extends { length: number }>(a: T, b: T) {
-  return a.length >= b.length ? a : b;
+function isSameLength<T extends { length: number }>(a: T, b: T) {
+  return a.length === b.length;
 }
 
-test("pickLonger()", () => {
-  expect(pickLonger([1, 2], [1, 2, 3])).type.toBe<Array<number>>();
-  expect(pickLonger("two", "three")).type.toBe<"two" | "three">();
+test("isSameLength", () => {
+  expect(isSameLength([1, 2], [1, 2, 3])).type.toBe<boolean>();
+  expect(isSameLength("one", "two")).type.toBe<boolean>();
 
-  expect(pickLonger).type.not.toBeCallableWith(1, 2);
-
-  expect(pickLonger).type.not.toBeCallableWith("zero", [123]);
-  expect(pickLonger<string | Array<number>>).type.toBeCallableWith("zero", [123]);
+  expect(isSameLength).type.not.toBeCallableWith(1, 2);
 });
 ```
 

package/build/index.cjs

@@ -17,3 +17,4 @@ exports.it = noopChain;
 exports.omit = doNothing;
 exports.pick = doNothing;
 exports.test = noopChain;
+exports.when = noopChain;

package/build/index.d.cts

@@ -269,5 +269,29 @@ declare const test: Test;
  * Defines a single test.
  */
 declare const it: Test;
+interface Actions {
+    /**
+     * Calls the given function with the provided arguments.
+     */
+    isCalledWith: (...args: Array<unknown>) => void;
+}
+interface When {
+    /**
+     * Creates a test plan.
+     *
+     * @template Target - The type upon which an action is performed.
+     */
+    <Target>(): Actions;
+    /**
+     * Creates a test plan.
+     *
+     * @param target - The expression upon which an action is performed.
+     */
+    (target: unknown): Actions;
+}
+/**
+ * Creates a test plan.
+ */
+declare const when: When;
 
-export { describe, expect, it, omit, pick, test };
+export { describe, expect, it, omit, pick, test, when };

package/build/index.d.ts

@@ -269,5 +269,29 @@ declare const test: Test;
  * Defines a single test.
  */
 declare const it: Test;
+interface Actions {
+    /**
+     * Calls the given function with the provided arguments.
+     */
+    isCalledWith: (...args: Array<unknown>) => void;
+}
+interface When {
+    /**
+     * Creates a test plan.
+     *
+     * @template Target - The type upon which an action is performed.
+     */
+    <Target>(): Actions;
+    /**
+     * Creates a test plan.
+     *
+     * @param target - The expression upon which an action is performed.
+     */
+    (target: unknown): Actions;
+}
+/**
+ * Creates a test plan.
+ */
+declare const when: When;
 
-export { describe, expect, it, omit, pick, test };
+export { describe, expect, it, omit, pick, test, when };

package/build/index.js

@@ -9,4 +9,4 @@ const noopChain = new Proxy(doNothing, {
     },
 });
 
-export { noopChain as describe, noopChain as expect, noopChain as it, doNothing as omit, doNothing as pick, noopChain as test };
+export { noopChain as describe, noopChain as expect, noopChain as it, doNothing as omit, doNothing as pick, noopChain as test, noopChain as when };

package/build/tstyche.d.ts

@@ -3,6 +3,7 @@ import type ts from 'typescript';
 declare enum CancellationReason {
     ConfigChange = "configChange",
     ConfigError = "configError",
+    CollectError = "collectError",
     FailFast = "failFast",
     WatchClose = "watchClose"
 }
@@ -75,7 +76,8 @@ type DiagnosticsHandler<T extends Diagnostic | Array<Diagnostic> = Diagnostic> =
 declare enum TestTreeNodeBrand {
     Describe = "describe",
     Test = "test",
-    Expect = "expect"
+    Expect = "expect",
+    When = "when"
 }
 
 declare enum TestTreeNodeFlags {
@@ -342,6 +344,16 @@ declare class CollectService {
     createTestTree(sourceFile: ts.SourceFile, semanticDiagnostics?: Array<ts.Diagnostic>): TestTree;
 }
 
+declare function nodeBelongsToArgumentList(compiler: typeof ts, node: ts.Node): boolean;
+
+declare class WhenNode extends TestTreeNode {
+    actionNode: ts.CallExpression;
+    actionNameNode: ts.PropertyAccessExpression;
+    abilityDiagnostics: Set<ts.Diagnostic> | undefined;
+    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);
+}
+
 interface EnvironmentOptions {
     /**
      * Is `true` if the process is running in continuous integration environment.
@@ -493,13 +505,12 @@ declare class TargetResult {
 declare class Result {
     expectCount: ResultCount;
     fileCount: ResultCount;
-    resolvedConfig: ResolvedConfig;
     results: Array<TargetResult>;
     targetCount: ResultCount;
     tasks: Array<Task>;
     testCount: ResultCount;
     timing: ResultTiming;
-    constructor(resolvedConfig: ResolvedConfig, tasks: Array<Task>);
+    constructor(tasks: Array<Task>);
 }
 
 interface EventHandler {
@@ -535,11 +546,13 @@ type Event = ["config:error", {
 }] | ["task:end", {
     result: TaskResult;
 }] | ["collect:start", {
-    testTree: TestTree;
+    tree: TestTree;
+}] | ["collect:error", {
+    diagnostics: Array<Diagnostic>;
 }] | ["collect:node", {
-    testNode: TestTreeNode | AssertionNode;
+    node: TestTreeNode | AssertionNode | WhenNode;
 }] | ["collect:end", {
-    testTree: TestTree;
+    tree: TestTree;
 }] | ["describe:start", {
     result: DescribeResult;
 }] | ["describe:end", {
@@ -632,11 +645,6 @@ 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;
@@ -727,13 +735,10 @@ declare class OutputService {
     static writeWarning(element: ScribblerJsx.Element | Array<ScribblerJsx.Element>): void;
 }
 
-declare function summaryText({ duration, expectCount, fileCount, onlyMatch, pathMatch, skipMatch, targetCount, testCount, }: {
+declare function summaryText({ duration, expectCount, fileCount, targetCount, testCount, }: {
     duration: number;
     expectCount: ResultCount;
     fileCount: ResultCount;
-    onlyMatch: string | undefined;
-    pathMatch: Array<string>;
-    skipMatch: string | undefined;
     targetCount: ResultCount;
     testCount: ResultCount;
 }): ScribblerJsx.Element;
@@ -873,5 +878,5 @@ declare class WatchService {
     watch(cancellationToken: CancellationToken): AsyncIterable<Array<Task>>;
 }
 
-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, diagnosticBelongsToNode, diagnosticText, environmentOptions, fileViewText, formattedText, getDiagnosticMessageText, getTextSpanEnd, helpText, isDiagnosticWithLocation, 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, TestTreeNode, TestTreeNodeBrand, TestTreeNodeFlags, Text, Version, WatchReporter, WatchService, Watcher, WhenNode, addsPackageText, defaultOptions, describeNameText, diagnosticBelongsToNode, diagnosticText, environmentOptions, fileViewText, formattedText, getDiagnosticMessageText, getTextSpanEnd, helpText, isDiagnosticWithLocation, nodeBelongsToArgumentList, 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 };