sxy-test-runner 2.3.17 → 2.3.18

package/dist/cli/lib/runDescribeRun.js

@@ -5,10 +5,18 @@ import { runIt } from './runIt.js';
 export function runDescribeRun(config, describe, parsedIts) {
     return timeProfileAsync(`run describe, run its ${describe.thing}`, async () => {
         const { its, beforeDescribeExports, afterDescribeFunc, beforeEachTestFunc, afterEachTestFunc } = parsedIts;
-        const itResults = [];
+        const parallelOverride = describe.meta === undefined
+            ? undefined
+            : 'parallelTests' in describe.meta ? describe.meta.parallelTests : !describe.meta.sequentialTests;
+        const isParallel = parallelOverride ?? config.execution.tests === 'parallel';
+        const itPromises = [];
         for (const it of its) {
-            itResults.push(await runIt(config, it, beforeEachTestFunc, afterEachTestFunc));
+            const itPromise = runIt(config, it, beforeEachTestFunc, afterEachTestFunc);
+            itPromises.push(itPromise);
+            if (!isParallel)
+                await itPromise;
         }
+        const itResults = await Promise.all(itPromises);
         const itResultsSummary = {
             total: 0,
             passes: 0

package/dist/cli/lib/runDescribeRun.js.map

@@ -1 +1 @@
-{"version":3,"file":"runDescribeRun.js","sourceRoot":"","sources":["../../../src/cli/lib/runDescribeRun.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AACvC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAMlC,MAAM,UAAU,cAAc,CAAC,MAAmB,EAAE,QAAkB,EAAE,SAAyB;IAE7F,OAAO,gBAAgB,CAAC,yBAAyB,QAAQ,CAAC,KAAK,EAAE,EAAE,KAAK,IAAI,EAAE;QAC1E,MAAM,EAAE,GAAG,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,GAAG,SAAS,CAAA;QAE1G,MAAM,SAAS,GAAe,EAAE,CAAA;QAChC,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC;YACnB,SAAS,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,MAAM,EAAE,EAAE,EAAE,kBAAkB,EAAE,iBAAiB,CAAC,CAAC,CAAA;QAClF,CAAC;QAED,MAAM,gBAAgB,GAAqB;YACvC,KAAK,EAAE,CAAC;YACR,MAAM,EAAE,CAAC;SACZ,CAAA;QAED,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YAC/B,gBAAgB,CAAC,KAAK,IAAI,CAAC,CAAC,QAAQ,CAAC,OAAO,KAAK,IAAI,CAAC,CAAA;YACtD,gBAAgB,CAAC,MAAM,IAAI,CAAC,CAAC,QAAQ,CAAC,OAAO,IAAI,KAAK,CAAC,CAAA;QAC3D,CAAC;QAED,KAAK,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,CAAA;QAE3C,MAAM,cAAc,GAAmB;YACnC,OAAO,EAAE,QAAQ,CAAC,OAAO;YACzB,KAAK,EAAE,QAAQ,CAAC,KAAK;YACrB,OAAO,EAAE,CAAC,gBAAgB,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,MAAM,KAAK,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI;YACjG,IAAI,EAAE,CAAC,EAAE,6BAA6B;YACtC,SAAS;YACT,gBAAgB;SACnB,CAAA;QAED,YAAY;QACZ,IAAI,OAAO,iBAAiB,KAAK,UAAU;YAAE,MAAM,iBAAiB,EAAE,CAAA;QACtE,MAAM,uBAAuB,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAA;QAE5D,OAAO,cAAc,CAAA;IACzB,CAAC,CAAC,CAAA;AACN,CAAC;AAED,KAAK,UAAU,uBAAuB,CAAC,MAAmB,EAAE,OAAoB;IAC5E,IAAI,MAAM,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;QACzC,MAAM,QAAQ,CAAC,MAAM,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAA;IACrD,CAAC;AACL,CAAC","sourcesContent":["import { timeProfileAsync } from './timeProfier.js'\nimport { runTasks } from './runTasks.js'\nimport { debug } from '../../output.js'\nimport { runIt } from './runIt.js'\n\nimport type {\n    FinalConfig, Describe, DescribeResult, ItResult, ItResultsSummary, ParsedDescribe, TaskExports\n} from '../../types.js'\n\nexport function runDescribeRun(config: FinalConfig, describe: Describe, parsedIts: ParsedDescribe)\n: Promise<DescribeResult> {\n    return timeProfileAsync(`run describe, run its ${describe.thing}`, async () => {\n        const { its, beforeDescribeExports, afterDescribeFunc, beforeEachTestFunc, afterEachTestFunc } = parsedIts\n\n        const itResults: ItResult[] = []\n        for (const it of its) {\n            itResults.push(await runIt(config, it, beforeEachTestFunc, afterEachTestFunc))\n        }\n\n        const itResultsSummary: ItResultsSummary = {\n            total: 0,\n            passes: 0\n        }\n\n        for (const itResult of itResults) {\n            itResultsSummary.total += +(itResult.success !== null)\n            itResultsSummary.passes += +(itResult.success ?? false)\n        }\n\n        debug('itResultsSummary', itResultsSummary)\n\n        const describeResult: DescribeResult = {\n            counter: describe.counter,\n            thing: describe.thing,\n            success: (itResultsSummary.total > 0) ? itResultsSummary.passes === itResultsSummary.total : null,\n            time: 0, // overwritten by runDescribe\n            itResults,\n            itResultsSummary\n        }\n\n        // run after\n        if (typeof afterDescribeFunc === 'function') await afterDescribeFunc()\n        await configAfterEachDescribe(config, beforeDescribeExports)\n\n        return describeResult\n    })\n}\n\nasync function configAfterEachDescribe(config: FinalConfig, exports: TaskExports): Promise<void> {\n    if (config.afterEachDescribe !== undefined) {\n        await runTasks(config.afterEachDescribe, exports)\n    }\n}\n"]}
+{"version":3,"file":"runDescribeRun.js","sourceRoot":"","sources":["../../../src/cli/lib/runDescribeRun.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AACvC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAMlC,MAAM,UAAU,cAAc,CAAC,MAAmB,EAAE,QAAkB,EAAE,SAAyB;IAE7F,OAAO,gBAAgB,CAAC,yBAAyB,QAAQ,CAAC,KAAK,EAAE,EAAE,KAAK,IAAI,EAAE;QAC1E,MAAM,EAAE,GAAG,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,GAAG,SAAS,CAAA;QAE1G,MAAM,gBAAgB,GAAG,QAAQ,CAAC,IAAI,KAAK,SAAS;YAChD,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,eAAe,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,eAAe,CAAA;QAErG,MAAM,UAAU,GAAG,gBAAgB,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,KAAK,UAAU,CAAA;QAE5E,MAAM,UAAU,GAA6B,EAAE,CAAA;QAC/C,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC;YACnB,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,EAAE,EAAE,EAAE,kBAAkB,EAAE,iBAAiB,CAAC,CAAA;YAC1E,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YAC1B,IAAI,CAAC,UAAU;gBAAE,MAAM,SAAS,CAAA;QACpC,CAAC;QACD,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;QAE/C,MAAM,gBAAgB,GAAqB;YACvC,KAAK,EAAE,CAAC;YACR,MAAM,EAAE,CAAC;SACZ,CAAA;QAED,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YAC/B,gBAAgB,CAAC,KAAK,IAAI,CAAC,CAAC,QAAQ,CAAC,OAAO,KAAK,IAAI,CAAC,CAAA;YACtD,gBAAgB,CAAC,MAAM,IAAI,CAAC,CAAC,QAAQ,CAAC,OAAO,IAAI,KAAK,CAAC,CAAA;QAC3D,CAAC;QAED,KAAK,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,CAAA;QAE3C,MAAM,cAAc,GAAmB;YACnC,OAAO,EAAE,QAAQ,CAAC,OAAO;YACzB,KAAK,EAAE,QAAQ,CAAC,KAAK;YACrB,OAAO,EAAE,CAAC,gBAAgB,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,MAAM,KAAK,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI;YACjG,IAAI,EAAE,CAAC,EAAE,6BAA6B;YACtC,SAAS;YACT,gBAAgB;SACnB,CAAA;QAED,YAAY;QACZ,IAAI,OAAO,iBAAiB,KAAK,UAAU;YAAE,MAAM,iBAAiB,EAAE,CAAA;QACtE,MAAM,uBAAuB,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAA;QAE5D,OAAO,cAAc,CAAA;IACzB,CAAC,CAAC,CAAA;AACN,CAAC;AAED,KAAK,UAAU,uBAAuB,CAAC,MAAmB,EAAE,OAAoB;IAC5E,IAAI,MAAM,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;QACzC,MAAM,QAAQ,CAAC,MAAM,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAA;IACrD,CAAC;AACL,CAAC","sourcesContent":["import { timeProfileAsync } from './timeProfier.js'\nimport { runTasks } from './runTasks.js'\nimport { debug } from '../../output.js'\nimport { runIt } from './runIt.js'\n\nimport type {\n    FinalConfig, Describe, DescribeResult, ItResult, ItResultsSummary, ParsedDescribe, TaskExports\n} from '../../types.js'\n\nexport function runDescribeRun(config: FinalConfig, describe: Describe, parsedIts: ParsedDescribe)\n: Promise<DescribeResult> {\n    return timeProfileAsync(`run describe, run its ${describe.thing}`, async () => {\n        const { its, beforeDescribeExports, afterDescribeFunc, beforeEachTestFunc, afterEachTestFunc } = parsedIts\n\n        const parallelOverride = describe.meta === undefined\n            ? undefined\n            : 'parallelTests' in describe.meta ? describe.meta.parallelTests : !describe.meta.sequentialTests\n\n        const isParallel = parallelOverride ?? config.execution.tests === 'parallel'\n\n        const itPromises: Array<Promise<ItResult>> = []\n        for (const it of its) {\n            const itPromise = runIt(config, it, beforeEachTestFunc, afterEachTestFunc)\n            itPromises.push(itPromise)\n            if (!isParallel) await itPromise\n        }\n        const itResults = await Promise.all(itPromises)\n\n        const itResultsSummary: ItResultsSummary = {\n            total: 0,\n            passes: 0\n        }\n\n        for (const itResult of itResults) {\n            itResultsSummary.total += +(itResult.success !== null)\n            itResultsSummary.passes += +(itResult.success ?? false)\n        }\n\n        debug('itResultsSummary', itResultsSummary)\n\n        const describeResult: DescribeResult = {\n            counter: describe.counter,\n            thing: describe.thing,\n            success: (itResultsSummary.total > 0) ? itResultsSummary.passes === itResultsSummary.total : null,\n            time: 0, // overwritten by runDescribe\n            itResults,\n            itResultsSummary\n        }\n\n        // run after\n        if (typeof afterDescribeFunc === 'function') await afterDescribeFunc()\n        await configAfterEachDescribe(config, beforeDescribeExports)\n\n        return describeResult\n    })\n}\n\nasync function configAfterEachDescribe(config: FinalConfig, exports: TaskExports): Promise<void> {\n    if (config.afterEachDescribe !== undefined) {\n        await runTasks(config.afterEachDescribe, exports)\n    }\n}\n"]}

package/dist/describe.d.ts

@@ -1,3 +1,9 @@
 import type { DescribeCallback } from './types.js';
+export type DescribeMeta = {
+    parallelTests: boolean;
+} | {
+    sequentialTests: boolean;
+};
 export declare function describe(theThing: string, tests: DescribeCallback): void;
+export declare function describe(theThing: string, meta: DescribeMeta, tests: DescribeCallback): void;
 //# sourceMappingURL=describe.d.ts.map

package/dist/describe.js

@@ -1,6 +1,6 @@
 import chalk from './packages/chalk.js';
 import { debug } from './output.js';
-export function describe(theThing, tests) {
+export function describe(theThing, testsOrMeta, possiblyTests) {
     if (!global.__sxy_test_runner__) {
         throw new Error('sxy-test-runner describe() was called, but the test framework has not initialized.'
             + ' This might be because you have run a test file directly'
@@ -9,9 +9,19 @@ export function describe(theThing, tests) {
     }
     const thisDescribeCounter = global.__sxy_test_runner__.describeCounter;
     global.__sxy_test_runner__.describeCounter++;
+    let meta = undefined;
+    let tests;
+    if (typeof testsOrMeta === 'function') {
+        tests = testsOrMeta;
+    }
+    else {
+        meta = testsOrMeta;
+        tests = possiblyTests; // eslint-disable-line no-type-assertion/no-type-assertion
+    }
     global.__sxy_test_runner__.describes.push({
         counter: thisDescribeCounter,
         thing: theThing,
+        meta,
         tests
     });
     debug(chalk.lightgrey `${thisDescribeCounter})`

package/dist/describe.js.map

@@ -1 +1 @@
-{"version":3,"file":"describe.js","sourceRoot":"","sources":["../src/describe.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,qBAAqB,CAAA;AAEvC,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AAGnC,MAAM,UAAU,QAAQ,CAAC,QAAgB,EAAE,KAAuB;IAC9D,IAAI,CAAC,MAAM,CAAC,mBAAmB,EAAE,CAAC;QAC9B,MAAM,IAAI,KAAK,CACX,oFAAoF;cAClF,0DAA0D;cAC1D,+CAA+C,CACpD,CAAA;QACD,gFAAgF;IACpF,CAAC;IAED,MAAM,mBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC,eAAe,CAAA;IACtE,MAAM,CAAC,mBAAmB,CAAC,eAAe,EAAE,CAAA;IAE5C,MAAM,CAAC,mBAAmB,CAAC,SAAS,CAAC,IAAI,CAAC;QACtC,OAAO,EAAE,mBAAmB;QAC5B,KAAK,EAAE,QAAQ;QACf,KAAK;KACR,CAAC,CAAA;IAEF,KAAK,CACD,KAAK,CAAC,SAAS,CAAA,GAAG,mBAAmB,GAAG;UAClC,KAAK,CAAC,SAAS,CAAA,aAAa,GAAG,KAAK,CAAC,UAAU,CAAA,GAAG,QAAQ,IAAI,CACvE,CAAA;AACL,CAAC","sourcesContent":["import chalk from './packages/chalk.js'\n\nimport { debug } from './output.js'\nimport type { DescribeCallback } from './types.js'\n\nexport function describe(theThing: string, tests: DescribeCallback): void {\n    if (!global.__sxy_test_runner__) {\n        throw new Error(\n            'sxy-test-runner describe() was called, but the test framework has not initialized.'\n            + ' This might be because you have run a test file directly'\n            + ', instead of running \\'pnpm sxy-test-runner\\''\n        )\n        // todo - maybe we can initialise the framework and just run only this test file\n    }\n\n    const thisDescribeCounter = global.__sxy_test_runner__.describeCounter\n    global.__sxy_test_runner__.describeCounter++\n\n    global.__sxy_test_runner__.describes.push({\n        counter: thisDescribeCounter,\n        thing: theThing,\n        tests\n    })\n\n    debug(\n        chalk.lightgrey`${thisDescribeCounter})`\n            + chalk.lightgrey` Done with ` + chalk.brightblue`${theThing}\\n`\n    )\n}\n"]}
+{"version":3,"file":"describe.js","sourceRoot":"","sources":["../src/describe.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,qBAAqB,CAAA;AAEvC,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AAOnC,MAAM,UAAU,QAAQ,CACpB,QAAgB,EAAE,WAA4C,EAAE,aAAgC;IAEhG,IAAI,CAAC,MAAM,CAAC,mBAAmB,EAAE,CAAC;QAC9B,MAAM,IAAI,KAAK,CACX,oFAAoF;cAClF,0DAA0D;cAC1D,+CAA+C,CACpD,CAAA;QACD,gFAAgF;IACpF,CAAC;IAED,MAAM,mBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC,eAAe,CAAA;IACtE,MAAM,CAAC,mBAAmB,CAAC,eAAe,EAAE,CAAA;IAE5C,IAAI,IAAI,GAAG,SAAS,CAAA;IACpB,IAAI,KAAK,CAAA;IACT,IAAI,OAAO,WAAW,KAAK,UAAU,EAAE,CAAC;QACpC,KAAK,GAAG,WAAW,CAAA;IACvB,CAAC;SAAM,CAAC;QACJ,IAAI,GAAG,WAAW,CAAA;QAClB,KAAK,GAAG,aAAiC,CAAA,CAAC,0DAA0D;IACxG,CAAC;IACD,MAAM,CAAC,mBAAmB,CAAC,SAAS,CAAC,IAAI,CAAC;QACtC,OAAO,EAAE,mBAAmB;QAC5B,KAAK,EAAE,QAAQ;QACf,IAAI;QACJ,KAAK;KACR,CAAC,CAAA;IAEF,KAAK,CACD,KAAK,CAAC,SAAS,CAAA,GAAG,mBAAmB,GAAG;UAClC,KAAK,CAAC,SAAS,CAAA,aAAa,GAAG,KAAK,CAAC,UAAU,CAAA,GAAG,QAAQ,IAAI,CACvE,CAAA;AACL,CAAC","sourcesContent":["import chalk from './packages/chalk.js'\n\nimport { debug } from './output.js'\nimport type { DescribeCallback } from './types.js'\n\nexport type DescribeMeta = { parallelTests: boolean } | { sequentialTests: boolean }\n\nexport function describe(theThing: string, tests: DescribeCallback): void;\nexport function describe(theThing: string, meta: DescribeMeta, tests: DescribeCallback): void;\nexport function describe(\n    theThing: string, testsOrMeta: DescribeCallback | DescribeMeta, possiblyTests?: DescribeCallback\n): void {\n    if (!global.__sxy_test_runner__) {\n        throw new Error(\n            'sxy-test-runner describe() was called, but the test framework has not initialized.'\n            + ' This might be because you have run a test file directly'\n            + ', instead of running \\'pnpm sxy-test-runner\\''\n        )\n        // todo - maybe we can initialise the framework and just run only this test file\n    }\n\n    const thisDescribeCounter = global.__sxy_test_runner__.describeCounter\n    global.__sxy_test_runner__.describeCounter++\n\n    let meta = undefined\n    let tests\n    if (typeof testsOrMeta === 'function') {\n        tests = testsOrMeta\n    } else {\n        meta = testsOrMeta\n        tests = possiblyTests as DescribeCallback // eslint-disable-line no-type-assertion/no-type-assertion\n    }\n    global.__sxy_test_runner__.describes.push({\n        counter: thisDescribeCounter,\n        thing: theThing,\n        meta,\n        tests\n    })\n\n    debug(\n        chalk.lightgrey`${thisDescribeCounter})`\n            + chalk.lightgrey` Done with ` + chalk.brightblue`${theThing}\\n`\n    )\n}\n"]}

package/dist/types.d.ts

@@ -1,3 +1,4 @@
+import { DescribeMeta } from './describe.js';
 export type ExecutionMode = 'parallel' | 'sequential';
 export type GlobPattern = string | string[];
 export interface ExecutionConfig {
@@ -52,6 +53,7 @@ export type DescribeCallback = (parcel: DescribeParcel) => void | Promise<void>;
 export interface Describe {
     counter: number;
     thing: string;
+    meta?: DescribeMeta;
     tests: DescribeCallback;
 }
 export interface It {

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,2EAA2E;AAC3E,2EAA2E;AAC3E,2EAA2E;AAC3E,+EAA+E","sourcesContent":["// Shared types for the test-run data model, user config, and CLI plumbing.\n// The config/result shapes are inferred from usage across the old awaitful\n// source (defaultConfig.js, validateConfig.js, init.js's template, and the\n// run*/parseDescribe/showTestResult modules) - there was no prior type source.\n\nexport type ExecutionMode = 'parallel' | 'sequential'\nexport type GlobPattern = string | string[]\n\nexport interface ExecutionConfig {\n    files: ExecutionMode\n    describes: ExecutionMode\n    tests: ExecutionMode\n}\n\nexport interface WatchConfig {\n    watchFilesBase: string\n    watchFiles: GlobPattern\n    watchFilesIgnore: GlobPattern\n    runAllOnStartup: boolean\n    reRunFailingTests: boolean\n    ttyActionsOnKeypress: boolean\n}\n\nexport type TaskExports = Record<string, unknown>\nexport type ConfigTaskFn = (parcel?: TaskExports) => TaskExports | void | Promise<TaskExports | void>\n// a task may also be a file path (relative to the project root) to dynamically import\nexport type ConfigTask = ConfigTaskFn | string\nexport type ConfigTasks = ConfigTask | ConfigTask[]\n\nexport interface FinalConfig {\n    testsBase: string\n    tests: GlobPattern\n    testsFilter?: string\n    testsIgnore: GlobPattern\n    setup?: ConfigTasks\n    beforeEachFile?: ConfigTasks\n    afterEachFile?: ConfigTasks\n    beforeEachDescribe?: ConfigTasks\n    afterEachDescribe?: ConfigTasks\n    beforeEachTest?: ConfigTasks\n    afterEachTest?: ConfigTasks\n    teardown?: ConfigTasks\n    showErrorTrace: boolean\n    compact: boolean\n    execution: ExecutionConfig\n    watch: WatchConfig\n}\n\nexport type UserConfig = Partial<Omit<FinalConfig, 'testsFilter' | 'execution' | 'watch'>> & {\n    execution?: Partial<ExecutionConfig>\n    watch?: Partial<WatchConfig>\n}\n\nexport type UserConfigInternal = UserConfig & Partial<Pick<FinalConfig, 'testsFilter'>>\n\n\n// -- test-run data model --------------------------------------------------\n\nexport type TestParcel = TaskExports\n\nexport interface DescribeParcel extends TaskExports {\n    it: (should: string, test: (parcel: TestParcel) => void | Promise<void>) => void\n    test: (should: string, test: (parcel: TestParcel) => void | Promise<void>) => void\n    afterDescribe: (func: () => void | Promise<void>) => void\n    beforeEachTest: (func: () => TaskExports | void | Promise<TaskExports | void>) => void\n    afterEachTest: (func: () => void | Promise<void>) => void\n}\n\nexport type DescribeCallback = (parcel: DescribeParcel) => void | Promise<void>\n\nexport interface Describe {\n    counter: number\n    thing: string\n    tests: DescribeCallback\n}\n\nexport interface It {\n    counter: number\n    should: string\n    test: (parcel: TestParcel) => void | Promise<void>\n}\n\nexport interface ParsedDescribe {\n    its: It[]\n    beforeDescribeExports: TaskExports\n    afterDescribeFunc?: () => void | Promise<void>\n    beforeEachTestFunc?: () => TaskExports | void | Promise<TaskExports | void>\n    afterEachTestFunc?: () => void | Promise<void>\n    error?: unknown\n}\n\nexport interface TestError extends Error {\n    actual?: unknown\n    expected?: unknown\n}\n\nexport interface ItResult {\n    counter: number\n    should: string\n    success: boolean | null\n    time: number\n    error?: TestError\n    logs: unknown[][]\n}\n\nexport interface ItResultsSummary {\n    total: number\n    passes: number\n}\n\nexport interface DescribeResult {\n    counter: number\n    thing: string\n    success: boolean | null\n    // total elapsed for the whole describe, filled in by runDescribe once it has finished\n    time: number\n    itResults: ItResult[]\n    itResultsSummary: ItResultsSummary\n    logs?: unknown[][]\n    error?: unknown\n}\n\nexport interface DescribeResultsSummary {\n    total: number\n    passes: number\n    invalid: number\n    itsTotal: number\n    itsPasses: number\n}\n\nexport interface TestFile {\n    file: string\n    describes?: Describe[]\n    error?: string | false\n    logs?: unknown[][]\n}\n\nexport interface TestResult {\n    file: string\n    success: boolean | null\n    describeResults: DescribeResult[]\n    describeResultsSummary: DescribeResultsSummary\n    logs: unknown[][]\n}\n\nexport interface TestsResultsSummary {\n    total: number\n    passes: number\n    invalid: number\n    describesTotal: number\n    describesPasses: number\n    describesInvalid: number\n    itsTotal: number\n    itsPasses: number\n}\n\nexport type DependencyTrees = Record<string, string[]>\n\nexport type OutFn = (...texts: unknown[]) => void\n\n\n\n// -- CLI argument parsing ---------------------------------------------------\n\nexport interface AllowedArgument {\n    flag?: string\n    hasValue: boolean\n}\n\nexport type AllowedArguments = Record<string, AllowedArgument>\nexport type AllowedFlags = Record<string, string>\nexport type ParsedArguments = Record<string, string | true>\n\nexport interface TestExecutionFilters {\n    describe?: string\n    it?: string\n}\n\n// -- globals ----------------------------------------------------------------\n\nexport interface SxyTestRunnerGlobal {\n    describes: Describe[]\n    describeCounter: number\n}\ndeclare global {\n    // eslint-disable-next-line camelcase\n    var __sxy_test_runner__: SxyTestRunnerGlobal | undefined\n    // eslint-disable-next-line camelcase\n    var __sxyt_commandLineArguments: string[]\n}\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,2EAA2E;AAC3E,2EAA2E;AAC3E,2EAA2E;AAC3E,+EAA+E","sourcesContent":["// Shared types for the test-run data model, user config, and CLI plumbing.\n// The config/result shapes are inferred from usage across the old awaitful\n// source (defaultConfig.js, validateConfig.js, init.js's template, and the\n// run*/parseDescribe/showTestResult modules) - there was no prior type source.\n\nimport { DescribeMeta } from './describe.js'\n\nexport type ExecutionMode = 'parallel' | 'sequential'\nexport type GlobPattern = string | string[]\n\nexport interface ExecutionConfig {\n    files: ExecutionMode\n    describes: ExecutionMode\n    tests: ExecutionMode\n}\n\nexport interface WatchConfig {\n    watchFilesBase: string\n    watchFiles: GlobPattern\n    watchFilesIgnore: GlobPattern\n    runAllOnStartup: boolean\n    reRunFailingTests: boolean\n    ttyActionsOnKeypress: boolean\n}\n\nexport type TaskExports = Record<string, unknown>\nexport type ConfigTaskFn = (parcel?: TaskExports) => TaskExports | void | Promise<TaskExports | void>\n// a task may also be a file path (relative to the project root) to dynamically import\nexport type ConfigTask = ConfigTaskFn | string\nexport type ConfigTasks = ConfigTask | ConfigTask[]\n\nexport interface FinalConfig {\n    testsBase: string\n    tests: GlobPattern\n    testsFilter?: string\n    testsIgnore: GlobPattern\n    setup?: ConfigTasks\n    beforeEachFile?: ConfigTasks\n    afterEachFile?: ConfigTasks\n    beforeEachDescribe?: ConfigTasks\n    afterEachDescribe?: ConfigTasks\n    beforeEachTest?: ConfigTasks\n    afterEachTest?: ConfigTasks\n    teardown?: ConfigTasks\n    showErrorTrace: boolean\n    compact: boolean\n    execution: ExecutionConfig\n    watch: WatchConfig\n}\n\nexport type UserConfig = Partial<Omit<FinalConfig, 'testsFilter' | 'execution' | 'watch'>> & {\n    execution?: Partial<ExecutionConfig>\n    watch?: Partial<WatchConfig>\n}\n\nexport type UserConfigInternal = UserConfig & Partial<Pick<FinalConfig, 'testsFilter'>>\n\n\n// -- test-run data model --------------------------------------------------\n\nexport type TestParcel = TaskExports\n\nexport interface DescribeParcel extends TaskExports {\n    it: (should: string, test: (parcel: TestParcel) => void | Promise<void>) => void\n    test: (should: string, test: (parcel: TestParcel) => void | Promise<void>) => void\n    afterDescribe: (func: () => void | Promise<void>) => void\n    beforeEachTest: (func: () => TaskExports | void | Promise<TaskExports | void>) => void\n    afterEachTest: (func: () => void | Promise<void>) => void\n}\n\nexport type DescribeCallback = (parcel: DescribeParcel) => void | Promise<void>\n\nexport interface Describe {\n    counter: number\n    thing: string\n    meta?: DescribeMeta\n    tests: DescribeCallback\n}\n\nexport interface It {\n    counter: number\n    should: string\n    test: (parcel: TestParcel) => void | Promise<void>\n}\n\nexport interface ParsedDescribe {\n    its: It[]\n    beforeDescribeExports: TaskExports\n    afterDescribeFunc?: () => void | Promise<void>\n    beforeEachTestFunc?: () => TaskExports | void | Promise<TaskExports | void>\n    afterEachTestFunc?: () => void | Promise<void>\n    error?: unknown\n}\n\nexport interface TestError extends Error {\n    actual?: unknown\n    expected?: unknown\n}\n\nexport interface ItResult {\n    counter: number\n    should: string\n    success: boolean | null\n    time: number\n    error?: TestError\n    logs: unknown[][]\n}\n\nexport interface ItResultsSummary {\n    total: number\n    passes: number\n}\n\nexport interface DescribeResult {\n    counter: number\n    thing: string\n    success: boolean | null\n    // total elapsed for the whole describe, filled in by runDescribe once it has finished\n    time: number\n    itResults: ItResult[]\n    itResultsSummary: ItResultsSummary\n    logs?: unknown[][]\n    error?: unknown\n}\n\nexport interface DescribeResultsSummary {\n    total: number\n    passes: number\n    invalid: number\n    itsTotal: number\n    itsPasses: number\n}\n\nexport interface TestFile {\n    file: string\n    describes?: Describe[]\n    error?: string | false\n    logs?: unknown[][]\n}\n\nexport interface TestResult {\n    file: string\n    success: boolean | null\n    describeResults: DescribeResult[]\n    describeResultsSummary: DescribeResultsSummary\n    logs: unknown[][]\n}\n\nexport interface TestsResultsSummary {\n    total: number\n    passes: number\n    invalid: number\n    describesTotal: number\n    describesPasses: number\n    describesInvalid: number\n    itsTotal: number\n    itsPasses: number\n}\n\nexport type DependencyTrees = Record<string, string[]>\n\nexport type OutFn = (...texts: unknown[]) => void\n\n\n\n// -- CLI argument parsing ---------------------------------------------------\n\nexport interface AllowedArgument {\n    flag?: string\n    hasValue: boolean\n}\n\nexport type AllowedArguments = Record<string, AllowedArgument>\nexport type AllowedFlags = Record<string, string>\nexport type ParsedArguments = Record<string, string | true>\n\nexport interface TestExecutionFilters {\n    describe?: string\n    it?: string\n}\n\n// -- globals ----------------------------------------------------------------\n\nexport interface SxyTestRunnerGlobal {\n    describes: Describe[]\n    describeCounter: number\n}\ndeclare global {\n    // eslint-disable-next-line camelcase\n    var __sxy_test_runner__: SxyTestRunnerGlobal | undefined\n    // eslint-disable-next-line camelcase\n    var __sxyt_commandLineArguments: string[]\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sxy-test-runner",
-  "version": "2.3.17",
+  "version": "2.3.18",
   "license": "MIT",
   "homepage": "https://github.com/RobertSandiford/sxy-test-runner",
   "repository": {