@augment-vir/test 30.4.0 → 30.5.0

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

@@ -44,5 +44,103 @@ export type FunctionTestCaseMultipleInputs<FunctionToTest extends AnyFunction> =
  * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
  */
 export type FunctionTestCase<FunctionToTest extends AnyFunction> = 1 extends Parameters<FunctionToTest>['length'] ? Parameters<FunctionToTest>['length'] extends 0 | 1 ? FunctionTestCaseSingleInput<FunctionToTest> : FunctionTestCaseMultipleInputs<FunctionToTest> : 0 extends Parameters<FunctionToTest>['length'] ? BaseTestCase<Awaited<ReturnType<FunctionToTest>>> : FunctionTestCaseMultipleInputs<FunctionToTest>;
+/**
+ * Succinctly run many input / output tests for a pure function without repeating `it` boilerplate.
+ * Compatible with both [Node.js's test runner](https://nodejs.org/api/test.html) and
+ * [web-test-runner](https://modern-web.dev/docs/test-runner/overview/) or other Mocha-style test
+ * runners.
+ *
+ * @category Test
+ * @category Package : @augment-vir/test
+ * @example
+ *
+ * ```ts
+ * import {itCases, describe} from '@augment-vir/test';
+ *
+ * function myFunctionToTest(a: number, b: number) {
+ *     return a + b;
+ * }
+ *
+ * describe(myFunctionToTest.name, () => {
+ *     itCases(myFunctionToTest, [
+ *         {
+ *             it: 'handles negative numbers',
+ *             inputs: [
+ *                 -1,
+ *                 -2,
+ *             ],
+ *             expect: -3,
+ *         },
+ *         {
+ *             it: 'handles 0',
+ *             inputs: [
+ *                 0,
+ *                 0,
+ *             ],
+ *             expect: 0,
+ *         },
+ *         {
+ *             it: 'adds',
+ *             inputs: [
+ *                 3,
+ *                 5,
+ *             ],
+ *             expect: 8,
+ *         },
+ *     ]);
+ * });
+ * ```
+ *
+ * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
+ */
 export declare function itCases<const FunctionToTest extends AnyFunction>(functionToTest: FunctionToTest, customAsserter: CustomOutputAsserter<NoInfer<FunctionToTest>>, testCases: ReadonlyArray<FunctionTestCase<NoInfer<FunctionToTest>>>): unknown[];
+/**
+ * Succinctly run many input / output tests for a pure function without repeating `it` boilerplate.
+ * Compatible with both [Node.js's test runner](https://nodejs.org/api/test.html) and
+ * [web-test-runner](https://modern-web.dev/docs/test-runner/overview/) or other Mocha-style test
+ * runners.
+ *
+ * @category Test
+ * @category Package : @augment-vir/test
+ * @example
+ *
+ * ```ts
+ * import {itCases, describe} from '@augment-vir/test';
+ *
+ * function myFunctionToTest(a: number, b: number) {
+ *     return a + b;
+ * }
+ *
+ * describe(myFunctionToTest.name, () => {
+ *     itCases(myFunctionToTest, [
+ *         {
+ *             it: 'handles negative numbers',
+ *             inputs: [
+ *                 -1,
+ *                 -2,
+ *             ],
+ *             expect: -3,
+ *         },
+ *         {
+ *             it: 'handles 0',
+ *             inputs: [
+ *                 0,
+ *                 0,
+ *             ],
+ *             expect: 0,
+ *         },
+ *         {
+ *             it: 'adds',
+ *             inputs: [
+ *                 3,
+ *                 5,
+ *             ],
+ *             expect: 8,
+ *         },
+ *     ]);
+ * });
+ * ```
+ *
+ * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
+ */
 export declare function itCases<const FunctionToTest extends AnyFunction>(functionToTest: FunctionToTest, testCases: ReadonlyArray<FunctionTestCase<NoInfer<FunctionToTest>>>): unknown[];

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

@@ -10,6 +10,45 @@ const unsetError = Symbol('unset-error');
  *
  * @category Test
  * @category Package : @augment-vir/test
+ * @example
+ *
+ * ```ts
+ * import {itCases, describe} from '@augment-vir/test';
+ *
+ * function myFunctionToTest(a: number, b: number) {
+ *     return a + b;
+ * }
+ *
+ * describe(myFunctionToTest.name, () => {
+ *     itCases(myFunctionToTest, [
+ *         {
+ *             it: 'handles negative numbers',
+ *             inputs: [
+ *                 -1,
+ *                 -2,
+ *             ],
+ *             expect: -3,
+ *         },
+ *         {
+ *             it: 'handles 0',
+ *             inputs: [
+ *                 0,
+ *                 0,
+ *             ],
+ *             expect: 0,
+ *         },
+ *         {
+ *             it: 'adds',
+ *             inputs: [
+ *                 3,
+ *                 5,
+ *             ],
+ *             expect: 8,
+ *         },
+ *     ]);
+ * });
+ * ```
+ *
  * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
  */
 export function itCases(functionToTest, testCasesOrCustomAsserter, maybeTestCases) {

package/dist/augments/universal-testing-suite/mocha-types.d.ts

@@ -0,0 +1,76 @@
+/**
+ * These types have all been deduced from local testing, as Mocha's types aren't accurate. Only
+ * properties that make sense are included. (Lots of actual properties on these types are
+ * misleadingly named. Those have been omitted.)
+ */
+import type { AnyFunction } from '@augment-vir/common';
+/**
+ * Any Mocha context node inside {@link MochaTestContext}.
+ *
+ * @category Test : Util
+ * @category Package : @augment-vir/test
+ * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
+ */
+export type MochaNode = MochaSuite | MochaTest | MochaRoot;
+/**
+ * The root context inside {@link MochaTestContext}.
+ *
+ * @category Test : Util
+ * @category Package : @augment-vir/test
+ * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
+ */
+export type MochaRoot = {
+    title: '';
+    root: true;
+};
+/**
+ * An individual test suite inside {@link MochaTestContext}.
+ *
+ * @category Test : Util
+ * @category Package : @augment-vir/test
+ * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
+ */
+export type MochaSuite = {
+    title: string;
+    root: false;
+    ctx: {
+        test: MochaTest;
+    };
+    suites: MochaSuite[];
+    tests: MochaSuite[];
+    parent: MochaNode;
+};
+/**
+ * An individual test context inside {@link MochaTestContext}.
+ *
+ * @category Test : Util
+ * @category Package : @augment-vir/test
+ * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
+ */
+export type MochaTest = {
+    type: 'test';
+    /** The current test name. */
+    title: string;
+    /** The current test callback. */
+    fn: AnyFunction;
+    id: string;
+    parent: MochaNode;
+    ctx: {
+        test: MochaTest;
+    };
+    root?: undefined;
+};
+/**
+ * The test context for [web-test-runner](https://modern-web.dev/docs/test-runner/overview/) or
+ * other Mocha-style test runners.
+ *
+ * @category Test : Util
+ * @category Package : @augment-vir/test
+ * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
+ */
+export type MochaTestContext = Readonly<{
+    test: MochaTest;
+}> & {
+    /** Added for use by `assertSnapshot`. */
+    snapshotCount?: number;
+};

package/dist/augments/universal-testing-suite/mocha-types.js

@@ -0,0 +1,6 @@
+/**
+ * These types have all been deduced from local testing, as Mocha's types aren't accurate. Only
+ * properties that make sense are included. (Lots of actual properties on these types are
+ * misleadingly named. Those have been omitted.)
+ */
+export {};

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

@@ -0,0 +1,49 @@
+import { AnyFunction } from '@augment-vir/core';
+import { type FunctionTestCase } from './it-cases.js';
+/**
+ * Similar to `itCases` but instead of defining expectation in each test case, each test case is a
+ * snapshot test.
+ *
+ * In order to generate or update the snapshot files, run tests in update mode.
+ *
+ * @category Test
+ * @category Package : @augment-vir/test
+ * @example
+ *
+ * ```ts
+ * import {snapshotCases, describe} from '@augment-vir/test';
+ *
+ * function myFunctionToTest(a: number, b: number) {
+ *     return a + b;
+ * }
+ *
+ * describe(myFunctionToTest.name, () => {
+ *     snapshotCases(myFunctionToTest, [
+ *         {
+ *             it: 'handles negative numbers',
+ *             inputs: [
+ *                 -1,
+ *                 -2,
+ *             ],
+ *         },
+ *         {
+ *             it: 'handles 0',
+ *             inputs: [
+ *                 0,
+ *                 0,
+ *             ],
+ *         },
+ *         {
+ *             it: 'adds',
+ *             inputs: [
+ *                 3,
+ *                 5,
+ *             ],
+ *         },
+ *     ]);
+ * });
+ * ```
+ *
+ * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
+ */
+export declare function snapshotCases<const FunctionToTest extends AnyFunction>(functionToTest: FunctionToTest, testCases: ReadonlyArray<Omit<FunctionTestCase<NoInfer<FunctionToTest>>, 'expect' | 'throws'>>): void[];

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

@@ -0,0 +1,75 @@
+import { wrapInTry } from '@augment-vir/common';
+import { ensureError, extractErrorMessage } from '@augment-vir/core';
+import { it } from './universal-it.js';
+import { assertSnapshot } from './universal-snapshot.js';
+/**
+ * Similar to `itCases` but instead of defining expectation in each test case, each test case is a
+ * snapshot test.
+ *
+ * In order to generate or update the snapshot files, run tests in update mode.
+ *
+ * @category Test
+ * @category Package : @augment-vir/test
+ * @example
+ *
+ * ```ts
+ * import {snapshotCases, describe} from '@augment-vir/test';
+ *
+ * function myFunctionToTest(a: number, b: number) {
+ *     return a + b;
+ * }
+ *
+ * describe(myFunctionToTest.name, () => {
+ *     snapshotCases(myFunctionToTest, [
+ *         {
+ *             it: 'handles negative numbers',
+ *             inputs: [
+ *                 -1,
+ *                 -2,
+ *             ],
+ *         },
+ *         {
+ *             it: 'handles 0',
+ *             inputs: [
+ *                 0,
+ *                 0,
+ *             ],
+ *         },
+ *         {
+ *             it: 'adds',
+ *             inputs: [
+ *                 3,
+ *                 5,
+ *             ],
+ *         },
+ *     ]);
+ * });
+ * ```
+ *
+ * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
+ */
+export function snapshotCases(functionToTest, testCases) {
+    return testCases.map((testCase) => {
+        const itFunction = testCase.only ? it.only : testCase.skip ? it.skip : it;
+        return itFunction(testCase.it, async (testContext) => {
+            const functionInputs = 'input' in testCase
+                ? [testCase.input]
+                : 'inputs' in testCase
+                    ? testCase.inputs
+                    : // as cast here to cover the case where the input has NO inputs
+                        [];
+            const snapshotData = await wrapInTry(async () => {
+                return await functionToTest(...functionInputs);
+            }, {
+                handleError(caught) {
+                    const error = ensureError(caught);
+                    const errorClassName = error.constructor.name;
+                    return {
+                        [errorClassName]: extractErrorMessage(error),
+                    };
+                },
+            });
+            await assertSnapshot(testContext, snapshotData);
+        });
+    });
+}

package/dist/augments/universal-testing-suite/universal-it.js

@@ -1,11 +1,26 @@
 import { isRuntimeEnv, RuntimeEnv } from '@augment-vir/core';
-const its = isRuntimeEnv(RuntimeEnv.Node)
-    ? {
-        node: (await import('node:test')).it,
-    }
-    : {
-        mocha: globalThis.it,
-    };
+function createWebIt() {
+    const webIt = Object.assign((doesThis, callback) => {
+        return globalThis.it(doesThis, async function () {
+            const context = this;
+            await callback(context);
+        });
+    }, {
+        skip: (doesThis, callback) => {
+            return globalThis.it.skip(doesThis, async function () {
+                const context = this;
+                await callback(context);
+            });
+        },
+        only: (doesThis, callback) => {
+            return globalThis.it.only(doesThis, async function () {
+                const context = this;
+                await callback(context);
+            });
+        },
+    });
+    return webIt;
+}
 /**
  * A single test declaration. This can be used in both web tests _and_ node tests, so you only have
  * import from a single place and learn a single interface.
@@ -34,4 +49,6 @@ const its = isRuntimeEnv(RuntimeEnv.Node)
  *
  * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
  */
-export const it = its.mocha || its.node;
+export const it = isRuntimeEnv(RuntimeEnv.Node)
+    ? (await import('node:test')).it
+    : createWebIt();

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

@@ -0,0 +1,25 @@
+import { UniversalTestContext } from './universal-test-context.js';
+/**
+ * An error that is thrown from {@link assertSnapshot} when the snapshot comparison fails due to the
+ * snapshot expectation file simply not existing.
+ *
+ * @category Test : Util
+ * @category Package : @augment-vir/test
+ * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
+ */
+export declare class SnapshotFileMissingError extends Error {
+    constructor(testName: string);
+}
+/**
+ * Assert that the given snapshot data matches already-saved snapshot file's expectations. Note that
+ * the given data will be serialized into a JSON string if it is not already a string. This works in
+ * both Node and web tests.
+ *
+ * Web tests require a web-test-runner config with the `snapshotPlugin` plugin from
+ * `@virmator/test/dist/web-snapshot-plugin/web-snapshot-plugin.js` in order to work.
+ *
+ * @category Test
+ * @category Package : @augment-vir/test
+ * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
+ */
+export declare function assertSnapshot(testContext: UniversalTestContext, data: unknown): Promise<void>;

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

@@ -0,0 +1,90 @@
+import { check } from '@augment-vir/assert';
+import { extractErrorMessage, log, RuntimeEnv } from '@augment-vir/common';
+import { SnapshotCommand, } from '@virmator/test/dist/web-snapshot-plugin/snapshot-payload.js';
+import { isTestContext } from './universal-test-context.js';
+/**
+ * An error that is thrown from {@link assertSnapshot} when the snapshot comparison fails due to the
+ * snapshot expectation file simply not existing.
+ *
+ * @category Test : Util
+ * @category Package : @augment-vir/test
+ * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
+ */
+export class SnapshotFileMissingError extends Error {
+    constructor(testName) {
+        super(`Missing snapshot file for test '${testName}'.\n\nRun tests in update mode to create the snapshot file.`);
+    }
+}
+/**
+ * Assert that the given snapshot data matches already-saved snapshot file's expectations. Note that
+ * the given data will be serialized into a JSON string if it is not already a string. This works in
+ * both Node and web tests.
+ *
+ * Web tests require a web-test-runner config with the `snapshotPlugin` plugin from
+ * `@virmator/test/dist/web-snapshot-plugin/web-snapshot-plugin.js` in order to work.
+ *
+ * @category Test
+ * @category Package : @augment-vir/test
+ * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
+ */
+export async function assertSnapshot(testContext, data) {
+    const { snapshotName, testName } = getTestName(testContext);
+    const serializedData = check.isString(data) ? data : JSON.stringify(data);
+    if (isTestContext(testContext, RuntimeEnv.Node)) {
+        try {
+            testContext.snapshotCount = testContext.snapshotCount
+                ? testContext.snapshotCount + 1
+                : 1;
+            testContext.assert.snapshot(serializedData);
+        }
+        catch (error) {
+            if (extractErrorMessage(error).includes('Cannot read snapshot file')) {
+                throw new SnapshotFileMissingError(testName);
+            }
+            else {
+                throw error;
+            }
+        }
+    }
+    else {
+        const { executeServerCommand } = await import('@web/test-runner-commands');
+        const result = await executeServerCommand(SnapshotCommand.CompareSnapshot, {
+            content: serializedData,
+            name: snapshotName,
+        });
+        if (result.updated) {
+            log.info(`Snapshot updated at '${result.snapshotPath}'`);
+        }
+        else if (!result.exists) {
+            throw new SnapshotFileMissingError(testName);
+        }
+        else if (!result.matches) {
+            throw new Error(`Snapshot mismatch at '${testName}':\n\nActual: ${serializedData}\n\nExpected: ${result.savedContent}\n`);
+        }
+    }
+}
+function flattenMochaParentTitles(node) {
+    if (node.root) {
+        return [];
+    }
+    else {
+        return [
+            ...flattenMochaParentTitles(node.parent),
+            node.title,
+        ];
+    }
+}
+function getTestName(testContext) {
+    const testName = isTestContext(testContext, RuntimeEnv.Node)
+        ? testContext.fullName
+        : flattenMochaParentTitles(testContext.test).join(' > ');
+    testContext.snapshotCount = testContext.snapshotCount ? testContext.snapshotCount + 1 : 1;
+    const snapshotName = [
+        testName,
+        testContext.snapshotCount,
+    ].join(' ');
+    return {
+        snapshotName,
+        testName,
+    };
+}

package/dist/augments/universal-testing-suite/universal-test-context.d.ts

@@ -1,15 +1,6 @@
 import { RuntimeEnv } from '@augment-vir/core';
 import { TestContext as NodeTestContextImport } from 'node:test';
-import type { MochaContext } from '../../mocha-types.js';
-/**
- * The test context for [web-test-runner](https://modern-web.dev/docs/test-runner/overview/) or
- * other Mocha-style test runners.
- *
- * @category Test : Util
- * @category Package : @augment-vir/test
- * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
- */
-export type MochaTestContext = MochaContext;
+import { MochaTestContext } from './mocha-types.js';
 /**
  * The test context for [Node.js's test runner](https://nodejs.org/api/test.html).
  *
@@ -17,7 +8,10 @@ export type MochaTestContext = MochaContext;
  * @category Package : @augment-vir/test
  * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
  */
-export type NodeTestContext = NodeTestContextImport;
+export type NodeTestContext = Readonly<NodeTestContextImport> & {
+    /** Added for use by `assertSnapshot`. */
+    snapshotCount?: number;
+};
 /**
  * Test context provided by `it`'s callback.
  *
@@ -41,16 +35,17 @@ export type UniversalTestContext = NodeTestContext | MochaTestContext;
  */
 export type ContextByEnv = {
     [RuntimeEnv.Node]: NodeTestContext;
-    [RuntimeEnv.Web]: MochaContext;
+    [RuntimeEnv.Web]: MochaTestContext;
 };
 /**
- * Ensures that the given context is for the given env, otherwise throws an Error.
+ * Asserts that the given context is for the given env and returns that context.
  *
  * @category Test : Util
  * @category Package : @augment-vir/test
+ * @throws `TypeError` if the context does not match the env.
  * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
  */
-export declare function ensureTestContext<const SpecificEnv extends RuntimeEnv>(context: UniversalTestContext, env: RuntimeEnv): ContextByEnv[SpecificEnv];
+export declare function assertWrapTestContext<const SpecificEnv extends RuntimeEnv>(context: UniversalTestContext, env: RuntimeEnv): ContextByEnv[SpecificEnv];
 /**
  * Asserts that the given context is for the given env, otherwise throws an Error.
  *
@@ -66,7 +61,7 @@ export declare function assertTestContext<const SpecificEnv extends RuntimeEnv>(
  * @category Package : @augment-vir/test
  * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
  */
-export declare function isTestContext<const SpecificEnv extends RuntimeEnv>(context: UniversalTestContext, env: RuntimeEnv): context is ContextByEnv[SpecificEnv];
+export declare function isTestContext<const SpecificEnv extends RuntimeEnv>(context: UniversalTestContext, env: SpecificEnv): context is ContextByEnv[SpecificEnv];
 /**
  * Determine the env for the given test context.
  *

package/dist/augments/universal-testing-suite/universal-test-context.js

@@ -1,12 +1,13 @@
 import { RuntimeEnv } from '@augment-vir/core';
 /**
- * Ensures that the given context is for the given env, otherwise throws an Error.
+ * Asserts that the given context is for the given env and returns that context.
  *
  * @category Test : Util
  * @category Package : @augment-vir/test
+ * @throws `TypeError` if the context does not match the env.
  * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
  */
-export function ensureTestContext(context, env) {
+export function assertWrapTestContext(context, env) {
     assertTestContext(context, env);
     return context;
 }
@@ -48,5 +49,5 @@ const nodeOnlyCheckKey = 'diagnostic';
  * @package [`@augment-vir/test`](https://www.npmjs.com/package/@augment-vir/test)
  */
 export function determineTestContextEnv(context) {
-    return context[nodeOnlyCheckKey] ? RuntimeEnv.Node : RuntimeEnv.Web;
+    return nodeOnlyCheckKey in context ? RuntimeEnv.Node : RuntimeEnv.Web;
 }

package/dist/index.d.ts

@@ -1,5 +1,8 @@
 export * from './augments/test-web.js';
 export * from './augments/universal-testing-suite/it-cases.js';
+export * from './augments/universal-testing-suite/mocha-types.js';
+export * from './augments/universal-testing-suite/snapshot-cases.js';
 export * from './augments/universal-testing-suite/universal-describe.js';
 export * from './augments/universal-testing-suite/universal-it.js';
+export * from './augments/universal-testing-suite/universal-snapshot.js';
 export * from './augments/universal-testing-suite/universal-test-context.js';

package/dist/index.js

@@ -1,5 +1,8 @@
 export * from './augments/test-web.js';
 export * from './augments/universal-testing-suite/it-cases.js';
+export * from './augments/universal-testing-suite/mocha-types.js';
+export * from './augments/universal-testing-suite/snapshot-cases.js';
 export * from './augments/universal-testing-suite/universal-describe.js';
 export * from './augments/universal-testing-suite/universal-it.js';
+export * from './augments/universal-testing-suite/universal-snapshot.js';
 export * from './augments/universal-testing-suite/universal-test-context.js';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/test",
-    "version": "30.4.0",
+    "version": "30.5.0",
     "description": "A universal testing suite that works with Mocha style test runners _and_ Node.js's built-in test runner.",
     "keywords": [
         "test",
@@ -42,9 +42,10 @@
         "test:web": "virmator test --no-deps web 'src/test-web/**/*.test.ts' 'src/augments/universal-testing-suite/**/*.test.ts'"
     },
     "dependencies": {
-        "@augment-vir/assert": "^30.4.0",
-        "@augment-vir/common": "^30.4.0",
+        "@augment-vir/assert": "^30.5.0",
+        "@augment-vir/common": "^30.5.0",
         "@open-wc/testing-helpers": "^3.0.1",
+        "@virmator/test": "^13.7.0",
         "type-fest": "^4.26.1"
     },
     "devDependencies": {

package/dist/mocha-types.d.ts

@@ -1,73 +0,0 @@
-/**
- * Extracted from https://www.npmjs.com/package/@types/mocha/v/10.0.7 with modifications to prevent
- * leakage of global types.
- *
- * The original code has the following license:
- *
- * MIT License
- *
- * Copyright (c) Microsoft Corporation.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
- * associated documentation files (the "Software"), to deal in the Software without restriction,
- * including without limitation the rights to use, copy, modify, merge, publish, distribute,
- * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all copies or
- * substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
- * NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
- * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
- * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE
- */
-interface Runnable extends NodeJS.EventEmitter {
-    on(event: 'error', listener: (error: any) => void): this;
-    once(event: 'error', listener: (error: any) => void): this;
-    addListener(event: 'error', listener: (error: any) => void): this;
-    removeListener(event: 'error', listener: (error: any) => void): this;
-    prependListener(event: 'error', listener: (error: any) => void): this;
-    prependOnceListener(event: 'error', listener: (error: any) => void): this;
-    emit(name: 'error', error: any): boolean;
-}
-interface Runnable extends NodeJS.EventEmitter {
-    on(event: string, listener: (...args: any[]) => void): this;
-    once(event: string, listener: (...args: any[]) => void): this;
-    addListener(event: string, listener: (...args: any[]) => void): this;
-    removeListener(event: string, listener: (...args: any[]) => void): this;
-    prependListener(event: string, listener: (...args: any[]) => void): this;
-    prependOnceListener(event: string, listener: (...args: any[]) => void): this;
-    emit(name: string, ...args: any[]): boolean;
-}
-interface Test extends Runnable {
-    type: 'test';
-    speed?: 'slow' | 'medium' | 'fast' | undefined;
-    err?: Error | undefined;
-    clone(): Test;
-}
-export interface MochaContext {
-    test?: Runnable | undefined;
-    currentTest?: Test | undefined;
-    /** Get the context `Runnable`. */
-    runnable(): Runnable;
-    /** Set the context `Runnable`. */
-    runnable(runnable: Runnable): MochaContext;
-    /** Get test timeout. */
-    timeout(): number;
-    /** Set test timeout. */
-    timeout(ms: string | number): MochaContext;
-    /** Get test slowness threshold. */
-    slow(): number;
-    /** Set test slowness threshold. */
-    slow(ms: string | number): MochaContext;
-    /** Mark a test as skipped. */
-    skip(): never;
-    /** Get the number of allowed retries on failed tests. */
-    retries(): number;
-    /** Set the number of allowed retries on failed tests. */
-    retries(n: number): MochaContext;
-    [key: string]: any;
-}
-export {};

package/dist/mocha-types.js

@@ -1,26 +0,0 @@
-/**
- * Extracted from https://www.npmjs.com/package/@types/mocha/v/10.0.7 with modifications to prevent
- * leakage of global types.
- *
- * The original code has the following license:
- *
- * MIT License
- *
- * Copyright (c) Microsoft Corporation.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
- * associated documentation files (the "Software"), to deal in the Software without restriction,
- * including without limitation the rights to use, copy, modify, merge, publish, distribute,
- * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all copies or
- * substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
- * NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
- * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
- * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE
- */
-export {};