@augment-vir/test 31.55.0 → 31.57.0

package/dist/augments/universal-testing-suite/snapshot-cases-with-context.d.ts

@@ -1,4 +1,18 @@
+import { type AnyFunction } from '@augment-vir/core';
 import { type BaseFunctionWithContext, type FunctionWithContextTestCase } from './it-cases-with-context.js';
+/**
+ * Test case for {@link snapshotCasesWithContext}.
+ *
+ * @category Test
+ * @category Package : @augment-vir/test
+ */
+export type SnapshotTestCaseWithContext<FunctionToTest extends AnyFunction> = Omit<FunctionWithContextTestCase<NoInfer<FunctionToTest>>, 'expect' | 'throws'> & {
+    /**
+     * If true, allows errors to be thrown and snapshotted. Otherwise thrown errors will fail the
+     * test.
+     */
+    fails?: boolean;
+};
 /**
  * Same as `snapshotCases` but passes the test context as the first parameter to the function under
  * test.
@@ -52,4 +66,4 @@ import { type BaseFunctionWithContext, type FunctionWithContextTestCase } from '
  *
  * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
  */
-export declare function snapshotCasesWithContext<const FunctionToTest extends BaseFunctionWithContext>(this: void, functionToTest: FunctionToTest, testCases: ReadonlyArray<Omit<FunctionWithContextTestCase<NoInfer<FunctionToTest>>, 'expect' | 'throws'>>): void[];
+export declare function snapshotCasesWithContext<const FunctionToTest extends BaseFunctionWithContext>(this: void, functionToTest: FunctionToTest, testCases: ReadonlyArray<SnapshotTestCaseWithContext<NoInfer<FunctionToTest>>>): void[];

package/dist/augments/universal-testing-suite/snapshot-cases-with-context.js

@@ -69,11 +69,16 @@ export function snapshotCasesWithContext(functionToTest, testCases) {
                 return await functionToTest(testContext, ...functionInputs);
             }, {
                 handleError(caught) {
-                    const error = ensureError(caught);
-                    const errorClassName = error.constructor.name;
-                    return {
-                        [errorClassName]: extractErrorMessage(error),
-                    };
+                    if (testCase.fails) {
+                        const error = ensureError(caught);
+                        const errorClassName = error.constructor.name;
+                        return {
+                            [errorClassName]: extractErrorMessage(error),
+                        };
+                    }
+                    else {
+                        throw caught;
+                    }
                 },
             });
             await assertSnapshot(testContext, snapshotData);

package/dist/augments/universal-testing-suite/snapshot-cases.d.ts

@@ -1,5 +1,18 @@
 import { type AnyFunction } from '@augment-vir/core';
 import { type FunctionTestCase } from './it-cases.js';
+/**
+ * Test case for {@link snapshotCases}.
+ *
+ * @category Test
+ * @category Package : @augment-vir/test
+ */
+export type SnapshotTestCase<FunctionToTest extends AnyFunction> = Omit<FunctionTestCase<NoInfer<FunctionToTest>>, 'expect' | 'throws'> & {
+    /**
+     * If true, allows errors to be thrown and snapshotted. Otherwise thrown errors will fail the
+     * test.
+     */
+    fails?: boolean;
+};
 /**
  * Similar to `itCases` but instead of defining expectation in each test case, each test case is a
  * snapshot test.
@@ -46,4 +59,4 @@ import { type FunctionTestCase } from './it-cases.js';
  *
  * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
  */
-export declare function snapshotCases<const FunctionToTest extends AnyFunction>(this: void, functionToTest: FunctionToTest, testCases: ReadonlyArray<Omit<FunctionTestCase<NoInfer<FunctionToTest>>, 'expect' | 'throws'>>): void[];
+export declare function snapshotCases<const FunctionToTest extends AnyFunction>(this: void, functionToTest: FunctionToTest, testCases: ReadonlyArray<SnapshotTestCase<NoInfer<FunctionToTest>>>): void[];

package/dist/augments/universal-testing-suite/snapshot-cases.js

@@ -62,11 +62,16 @@ export function snapshotCases(functionToTest, testCases) {
                 return await functionToTest(...functionInputs);
             }, {
                 handleError(caught) {
-                    const error = ensureError(caught);
-                    const errorClassName = error.constructor.name;
-                    return {
-                        [errorClassName]: extractErrorMessage(error),
-                    };
+                    if (testCase.fails) {
+                        const error = ensureError(caught);
+                        const errorClassName = error.constructor.name;
+                        return {
+                            [errorClassName]: extractErrorMessage(error),
+                        };
+                    }
+                    else {
+                        throw caught;
+                    }
                 },
             });
             await assertSnapshot(testContext, snapshotData);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/test",
-    "version": "31.55.0",
+    "version": "31.57.0",
     "description": "A universal testing suite that works with Mocha style test runners _and_ Node.js's built-in test runner.",
     "keywords": [
         "test",
@@ -44,8 +44,8 @@
         "test:web": "virmator test --no-deps web 'src/test-web/**/*.test.ts' 'src/augments/universal-testing-suite/**/*.test.ts'"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.55.0",
-        "@augment-vir/common": "^31.55.0",
+        "@augment-vir/assert": "^31.57.0",
+        "@augment-vir/common": "^31.57.0",
         "@date-vir/duration": "^8.1.0",
         "@virmator/test": "^14.3.5",
         "type-fest": "^5.3.1"