@everyonesoftware/common 7.0.0 → 8.0.0

package/outputs/testIndex.d.cts

@@ -144,12 +144,11 @@ declare abstract class Test {
  * A {@link Test} type that uses the standard "assert" module to make assertions.
  */
 declare class AssertTest implements Test {
-    private readonly name;
-    protected constructor(name: string);
+    private constructor();
     /**
      * Create a new {@link AssertTest} object.
      */
-    static create(name: string): AssertTest;
+    static create(): AssertTest;
     fail(message: string): never;
     assertUndefined(value: unknown): asserts value is undefined;
     assertNotUndefined<T>(value: T): asserts value is NonNullable<T>;
@@ -336,14 +335,39 @@ declare class TestAction {
     runAsync(): void | Promise<void>;
 }
 
+/**
+ * Options that can be passed to {@link TestError.getErrorString()}.
+ */
+interface GetErrorStringOptions {
+    /**
+     * Whether all of the file paths in the stack trace should be shortened to be relative to the
+     * current directory.
+     */
+    readonly relativeFilePaths?: boolean;
+    /**
+     * Remove any stack frames from code that is not part of the current project.
+     */
+    readonly removeNonProjectPaths?: boolean;
+}
+declare abstract class TestError {
+    protected constructor();
+    /**
+     * Get the error that caused the test or test group to fail.
+     */
+    abstract getError(): unknown;
+    /**
+     * Get the string representation of the error.
+     */
+    abstract getErrorString(options?: GetErrorStringOptions): string;
+}
+
 declare class FailedTest {
     private readonly testAction;
     private readonly error;
     private constructor();
-    static create(testAction: TestAction, error: unknown): FailedTest;
+    static create(testAction: TestAction, error: TestError): FailedTest;
     getTestAction(): TestAction;
-    getError(): unknown;
-    getErrorMessage(): string;
+    getTestError(): TestError;
 }
 
 declare class SkippedTest {
@@ -359,6 +383,7 @@ type ConsoleTestRunnerStyle = TestActionType | "passed" | "skipped" | "failed";
 declare abstract class ConsoleTestRunnerUI {
     private writeStream?;
     private readonly styles;
+    private getErrorStringOptions?;
     protected constructor();
     static flat(): FlatConsoleTestRunnerUI;
     static tree(): TreeConsoleTestRunnerUI;
@@ -373,12 +398,13 @@ declare abstract class ConsoleTestRunnerUI {
     protected writeLine(text?: string): AsyncResult<number>;
     protected writeTestActionName(testAction: TestAction): AsyncResult<number>;
     protected writeFullTestActionName(testAction: TestAction): AsyncResult<number>;
+    setGetErrorStringOptions(options: GetErrorStringOptions | undefined): this;
     beforeTestGroup(testGroup: TestAction): AsyncResult<void>;
     afterTestGroup(testGroup: TestAction): AsyncResult<void>;
     beforeTest(testAction: TestAction): AsyncResult<void>;
     afterPassedTest(testAction: TestAction): AsyncResult<void>;
     afterSkippedTest(testAction: TestAction, skip: TestSkip): AsyncResult<void>;
-    afterFailedTest(currentTestAction: TestAction, error: unknown): AsyncResult<void>;
+    afterFailedTest(currentTestAction: TestAction, error: TestError): AsyncResult<void>;
     writeSummary(passedTestCount: number, skippedTests: Iterable<SkippedTest>, failedTests: Iterable<FailedTest>): AsyncResult<void>;
 }
 declare class FlatConsoleTestRunnerUI extends ConsoleTestRunnerUI {
@@ -396,6 +422,25 @@ declare class TreeConsoleTestRunnerUI extends ConsoleTestRunnerUI {
     beforeTest(testAction: TestAction): AsyncResult<void>;
 }
 
+/**
+ * A type that can create new {@link Test} objects.
+ */
+declare abstract class TestCreator {
+    /**
+     * Create the default {@link TestCreator}.
+     */
+    static create(): TestCreator;
+    /**
+     * Create a new {@link Test} object.
+     */
+    abstract createTest(): Test;
+}
+
+declare abstract class TestErrorCreator {
+    static create(): TestErrorCreator;
+    abstract createTestError(error: unknown): TestError;
+}
+
 type ConsoleTestFunction = (runner: ConsoleTestRunner) => (void | Promise<void>);
 type ConsoleTestFunctionContainer = {
     test: ConsoleTestFunction;
@@ -409,14 +454,17 @@ declare class ConsoleTestRunner implements TestRunner {
     private passedTestCount;
     private readonly skippedTests;
     private readonly testFailures;
+    private readonly testCreator;
+    private readonly testErrorCreator;
     private readonly ui;
-    constructor(ui?: ConsoleTestRunnerUI);
-    static create(ui?: ConsoleTestRunnerUI): ConsoleTestRunner;
+    constructor(testCreator?: TestCreator, testErrorCreator?: TestErrorCreator, ui?: ConsoleTestRunnerUI);
+    static create(testCreator?: TestCreator, testErrorCreator?: TestErrorCreator, ui?: ConsoleTestRunnerUI): ConsoleTestRunner;
     static run(testFunction: ConsoleTestFunction | ConsoleTestFunctionContainer): Promise<void>;
     static run(testFunctions: JavascriptIterable<ConsoleTestFunction | ConsoleTestFunctionContainer>): Promise<void>;
     setWriteStream(writeStream: CharacterWriteStream): this;
     setStyle(style: ConsoleTestRunnerStyle, styleFunction: (text: string) => string): this;
     setStyles(styles: Partial<Record<ConsoleTestRunnerStyle, (text: string) => string>>): this;
+    setGetErrorStringOptions(options: GetErrorStringOptions): this;
     /**
      * Get the number of {@link TestAction}s that have yet to be executed.
      */
@@ -451,7 +499,7 @@ declare class ConsoleTestRunner implements TestRunner {
     beforeTest(testAction: TestAction): AsyncResult<void>;
     afterPassedTest(testAction: TestAction): AsyncResult<void>;
     afterSkippedTest(testAction: TestAction, skip: TestSkip): AsyncResult<void>;
-    afterFailedTest(testAction: TestAction, error: unknown): AsyncResult<void>;
+    afterFailedTest(testAction: TestAction, error: TestError): AsyncResult<void>;
     andList(values: unknown[] | Iterable<unknown>): string;
     toString(value: unknown): string;
     skip(message?: string): TestSkip;

package/outputs/testIndex.d.ts

@@ -144,12 +144,11 @@ declare abstract class Test {
  * A {@link Test} type that uses the standard "assert" module to make assertions.
  */
 declare class AssertTest implements Test {
-    private readonly name;
-    protected constructor(name: string);
+    private constructor();
     /**
      * Create a new {@link AssertTest} object.
      */
-    static create(name: string): AssertTest;
+    static create(): AssertTest;
     fail(message: string): never;
     assertUndefined(value: unknown): asserts value is undefined;
     assertNotUndefined<T>(value: T): asserts value is NonNullable<T>;
@@ -336,14 +335,39 @@ declare class TestAction {
     runAsync(): void | Promise<void>;
 }
 
+/**
+ * Options that can be passed to {@link TestError.getErrorString()}.
+ */
+interface GetErrorStringOptions {
+    /**
+     * Whether all of the file paths in the stack trace should be shortened to be relative to the
+     * current directory.
+     */
+    readonly relativeFilePaths?: boolean;
+    /**
+     * Remove any stack frames from code that is not part of the current project.
+     */
+    readonly removeNonProjectPaths?: boolean;
+}
+declare abstract class TestError {
+    protected constructor();
+    /**
+     * Get the error that caused the test or test group to fail.
+     */
+    abstract getError(): unknown;
+    /**
+     * Get the string representation of the error.
+     */
+    abstract getErrorString(options?: GetErrorStringOptions): string;
+}
+
 declare class FailedTest {
     private readonly testAction;
     private readonly error;
     private constructor();
-    static create(testAction: TestAction, error: unknown): FailedTest;
+    static create(testAction: TestAction, error: TestError): FailedTest;
     getTestAction(): TestAction;
-    getError(): unknown;
-    getErrorMessage(): string;
+    getTestError(): TestError;
 }
 
 declare class SkippedTest {
@@ -359,6 +383,7 @@ type ConsoleTestRunnerStyle = TestActionType | "passed" | "skipped" | "failed";
 declare abstract class ConsoleTestRunnerUI {
     private writeStream?;
     private readonly styles;
+    private getErrorStringOptions?;
     protected constructor();
     static flat(): FlatConsoleTestRunnerUI;
     static tree(): TreeConsoleTestRunnerUI;
@@ -373,12 +398,13 @@ declare abstract class ConsoleTestRunnerUI {
     protected writeLine(text?: string): AsyncResult<number>;
     protected writeTestActionName(testAction: TestAction): AsyncResult<number>;
     protected writeFullTestActionName(testAction: TestAction): AsyncResult<number>;
+    setGetErrorStringOptions(options: GetErrorStringOptions | undefined): this;
     beforeTestGroup(testGroup: TestAction): AsyncResult<void>;
     afterTestGroup(testGroup: TestAction): AsyncResult<void>;
     beforeTest(testAction: TestAction): AsyncResult<void>;
     afterPassedTest(testAction: TestAction): AsyncResult<void>;
     afterSkippedTest(testAction: TestAction, skip: TestSkip): AsyncResult<void>;
-    afterFailedTest(currentTestAction: TestAction, error: unknown): AsyncResult<void>;
+    afterFailedTest(currentTestAction: TestAction, error: TestError): AsyncResult<void>;
     writeSummary(passedTestCount: number, skippedTests: Iterable<SkippedTest>, failedTests: Iterable<FailedTest>): AsyncResult<void>;
 }
 declare class FlatConsoleTestRunnerUI extends ConsoleTestRunnerUI {
@@ -396,6 +422,25 @@ declare class TreeConsoleTestRunnerUI extends ConsoleTestRunnerUI {
     beforeTest(testAction: TestAction): AsyncResult<void>;
 }
 
+/**
+ * A type that can create new {@link Test} objects.
+ */
+declare abstract class TestCreator {
+    /**
+     * Create the default {@link TestCreator}.
+     */
+    static create(): TestCreator;
+    /**
+     * Create a new {@link Test} object.
+     */
+    abstract createTest(): Test;
+}
+
+declare abstract class TestErrorCreator {
+    static create(): TestErrorCreator;
+    abstract createTestError(error: unknown): TestError;
+}
+
 type ConsoleTestFunction = (runner: ConsoleTestRunner) => (void | Promise<void>);
 type ConsoleTestFunctionContainer = {
     test: ConsoleTestFunction;
@@ -409,14 +454,17 @@ declare class ConsoleTestRunner implements TestRunner {
     private passedTestCount;
     private readonly skippedTests;
     private readonly testFailures;
+    private readonly testCreator;
+    private readonly testErrorCreator;
     private readonly ui;
-    constructor(ui?: ConsoleTestRunnerUI);
-    static create(ui?: ConsoleTestRunnerUI): ConsoleTestRunner;
+    constructor(testCreator?: TestCreator, testErrorCreator?: TestErrorCreator, ui?: ConsoleTestRunnerUI);
+    static create(testCreator?: TestCreator, testErrorCreator?: TestErrorCreator, ui?: ConsoleTestRunnerUI): ConsoleTestRunner;
     static run(testFunction: ConsoleTestFunction | ConsoleTestFunctionContainer): Promise<void>;
     static run(testFunctions: JavascriptIterable<ConsoleTestFunction | ConsoleTestFunctionContainer>): Promise<void>;
     setWriteStream(writeStream: CharacterWriteStream): this;
     setStyle(style: ConsoleTestRunnerStyle, styleFunction: (text: string) => string): this;
     setStyles(styles: Partial<Record<ConsoleTestRunnerStyle, (text: string) => string>>): this;
+    setGetErrorStringOptions(options: GetErrorStringOptions): this;
     /**
      * Get the number of {@link TestAction}s that have yet to be executed.
      */
@@ -451,7 +499,7 @@ declare class ConsoleTestRunner implements TestRunner {
     beforeTest(testAction: TestAction): AsyncResult<void>;
     afterPassedTest(testAction: TestAction): AsyncResult<void>;
     afterSkippedTest(testAction: TestAction, skip: TestSkip): AsyncResult<void>;
-    afterFailedTest(testAction: TestAction, error: unknown): AsyncResult<void>;
+    afterFailedTest(testAction: TestAction, error: TestError): AsyncResult<void>;
     andList(values: unknown[] | Iterable<unknown>): string;
     toString(value: unknown): string;
     skip(message?: string): TestSkip;

package/outputs/testIndex.js

@@ -9,8 +9,8 @@ import {
   TestRunner,
   TestSkip,
   test
-} from "./chunk-VF6FBNAU.js";
-import "./chunk-MMAX3IZF.js";
+} from "./chunk-FEQPKLDH.js";
+import "./chunk-OYMWB5SX.js";
 export {
   AssertTest,
   BasicTestSkip,