@overkill-dev/engine 0.0.23 → 0.0.25

package/readme.md

@@ -10,14 +10,13 @@ Top-level API:
 - `createTable(options)`
 - `createTestPlan(root)`
 - `execute(testPlan)`
-- `runIfMain(import.meta, testNode, options?)`
 - `createEngine()`
 - `formatCaseId(caseId)`
 - `validateReporterSinks(reporters)`
 - `createPlainOutputRenderer()`
 - `captureSourceLocation()`
 - `unknownSourceLocation`
-- `CaseId`, `TestId`, `TestRoot`, `TestPlan`, `ExecuteOptions`, `RunIfMainOptions`, `NonEmptyReadonlyArray`, `DeepComparable`
+- `CaseId`, `TestId`, `TestRoot`, `TestPlan`, `ExecuteOptions`, `NonEmptyReadonlyArray`, `DeepComparable`
 - `Reporter`, `ReporterEvent`, `RealTimeReporter`, `FinalResultReporter`, `RunFacts`, `SinkDeclaration`, `OutputLineIntent`, `OutputRenderer`
 - `RunResult`, `TestOutcome`, `PassOutcome`, `FailOutcome`, `SkipOutcome`, `InconclusiveOutcome`
 - `AssertionNode`, `AssertionResult`, `AssertAssertionFacade`, `TestScopeAssertContext`
@@ -30,11 +29,10 @@ The top-level constructors share one default engine instance. Use
 `createEngine()` when a collection needs isolated construction state for
 `defined` counts and orphan detection.
 
-Direct Node execution:
+Direct execution:
 
 ```ts
-import { createTestCase, runIfMain } from '@overkill-dev/engine';
-import { createDotReporter } from '@overkill-dev/reporter-dot';
+import { createRoot, createTestCase, createTestPlan, execute } from '@overkill-dev/engine';
 
 export const testNode = createTestCase({
     body(scope) {
@@ -45,17 +43,24 @@ export const testNode = createTestCase({
     name: 'passes'
 });
 
-await runIfMain(import.meta, testNode, {
-    root: { name: import.meta.url, metadata: {} },
-    reporters: [ createDotReporter() ]
+const root = createRoot({
+    children: [ testNode ],
+    metadata: { kind: 'microtest' },
+    name: 'direct'
 });
+
+await execute(createTestPlan(root));
 ```
 
-Aggregate direct Node execution:
+Runner-owned direct Node entrypoints are exposed by `@overkill-dev/run` and
+`@overkill-dev/test` through `runIfMain(import.meta, testNode, options?)`.
+Those entrypoints load runner config, match the direct file to a profile, and
+use default runner reporters when no explicit reporters are configured.
+
+Aggregate direct execution:
 
 ```ts
-import { createSuite, runIfMain } from '@overkill-dev/engine';
-import { createDotReporter } from '@overkill-dev/reporter-dot';
+import { createRoot, createSuite, createTestPlan, execute } from '@overkill-dev/engine';
 import { testNode as orders } from './orders.test.ts';
 import { testNode as users } from './users.test.ts';
 
@@ -65,10 +70,13 @@ export const testNode = createSuite({
     name: 'all'
 });
 
-await runIfMain(import.meta, testNode, {
-    root: { name: 'all', metadata: {} },
-    reporters: [ createDotReporter() ]
+const root = createRoot({
+    children: [ testNode ],
+    metadata: { kind: 'microtest' },
+    name: 'all'
 });
+
+await execute(createTestPlan(root));
 ```
 
 Direct `createTestPlan(...)` calls require an explicit `createRoot(...)`.

package/sbom.cdx.json

@@ -16,9 +16,9 @@
         "component": {
             "type": "library",
             "name": "@overkill-dev/engine",
-            "version": "0.0.23",
-            "bom-ref": "pkg:npm/@overkill-dev/engine@0.0.23",
-            "purl": "pkg:npm/@overkill-dev/engine@0.0.23"
+            "version": "0.0.25",
+            "bom-ref": "pkg:npm/@overkill-dev/engine@0.0.25",
+            "purl": "pkg:npm/@overkill-dev/engine@0.0.25"
         }
     },
     "components": [
@@ -54,7 +54,7 @@
             "ref": "pkg:npm/@enormora/wall-clock@0.0.3"
         },
         {
-            "ref": "pkg:npm/@overkill-dev/engine@0.0.23",
+            "ref": "pkg:npm/@overkill-dev/engine@0.0.25",
             "dependsOn": [
                 "pkg:npm/@enormora/wall-clock@0.0.3",
                 "pkg:npm/diff@9.0.0"

package/engine/run-if-main.d.ts

@@ -1,29 +0,0 @@
-import type { WallClock } from '@enormora/wall-clock';
-import type { Execute } from './execution.ts';
-import type { Metadata } from './metadata.ts';
-import { type OutputRenderer } from './reporter-output.ts';
-import type { Reporter, RunFacts } from './reporter.ts';
-import type { RootOptions, TestNode, TestRoot } from './test-node.ts';
-import type { TestPlanFactory } from './test-plan.ts';
-export type RunIfMainOptions = {
-    readonly outputRenderer?: OutputRenderer;
-    readonly reporters?: readonly Reporter[];
-    readonly root?: RunIfMainRootOptions;
-    readonly runFacts?: RunFacts;
-};
-export type RunIfMainRootOptions = {
-    readonly metadata: Metadata;
-    readonly name: string;
-};
-export type RunIfMain = (meta: Readonly<ImportMeta>, testNode: TestNode, options?: RunIfMainOptions) => Promise<void>;
-export type RunIfMainDependencies = {
-    readonly createRoot: (options: RootOptions) => TestRoot;
-    readonly createTestPlan: TestPlanFactory;
-    readonly execute: Execute;
-    readonly nodeVersion: string;
-    readonly readExitCode: () => number | string | null | undefined;
-    readonly wallClock: WallClock;
-    readonly writeExitCode: (exitCode: number) => void;
-};
-export declare function createRunIfMain(dependencies: RunIfMainDependencies): RunIfMain;
-//# sourceMappingURL=run-if-main.d.ts.map

package/engine/run-if-main.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"run-if-main.d.ts","sourceRoot":"","sources":["../../../../source/engine/run-if-main.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,KAAK,EAAE,OAAO,EAAkB,MAAM,gBAAgB,CAAC;AAC9D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,EAA6B,KAAK,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtF,OAAO,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAExD,OAAO,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AACtE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEtD,MAAM,MAAM,gBAAgB,GAAG;IAC3B,QAAQ,CAAC,cAAc,CAAC,EAAE,cAAc,CAAC;IACzC,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,QAAQ,EAAE,CAAC;IACzC,QAAQ,CAAC,IAAI,CAAC,EAAE,oBAAoB,CAAC;IACrC,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IAC/B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,CACpB,IAAI,EAAE,QAAQ,CAAC,UAAU,CAAC,EAC1B,QAAQ,EAAE,QAAQ,EAClB,OAAO,CAAC,EAAE,gBAAgB,KACzB,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnB,MAAM,MAAM,qBAAqB,GAAG;IAChC,QAAQ,CAAC,UAAU,EAAE,CAAC,OAAO,EAAE,WAAW,KAAK,QAAQ,CAAC;IACxD,QAAQ,CAAC,cAAc,EAAE,eAAe,CAAC;IACzC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,YAAY,EAAE,MAAM,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAChE,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,aAAa,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;CACtD,CAAC;AAkDF,wBAAgB,eAAe,CAAC,YAAY,EAAE,qBAAqB,GAAG,SAAS,CAe9E"}

package/engine/run-if-main.js

@@ -1,46 +0,0 @@
-import { createPlainOutputRenderer } from "./reporter-output.js";
-const failureExitCodes = new Set([undefined, null, 0, '0']);
-function shouldSetFailureExitCode(exitCode) {
-    return failureExitCodes.has(exitCode);
-}
-function hasFailure(result) {
-    return result.summary.failed > 0 || result.runnerErrors.length > 0;
-}
-function rootMetadata(options) {
-    return options?.root?.metadata ?? {};
-}
-function rootName(meta, options) {
-    return options?.root?.name ?? meta.url;
-}
-function createRootOptions(meta, testNode, options) {
-    return {
-        children: [testNode],
-        metadata: rootMetadata(options),
-        name: rootName(meta, options)
-    };
-}
-function createExecuteOptions(options, dependencies) {
-    const startedAt = new Date(dependencies.wallClock.currentTimestampInMilliseconds);
-    return {
-        execution: { mode: 'serial-in-process' },
-        outputRenderer: options?.outputRenderer ?? createPlainOutputRenderer(),
-        reporters: options?.reporters ?? [],
-        runFacts: {
-            ...options?.runFacts,
-            nodeVersion: dependencies.nodeVersion
-        },
-        startedAt: startedAt.toISOString()
-    };
-}
-export function createRunIfMain(dependencies) {
-    return async function runIfMain(meta, testNode, options) {
-        if (!meta.main) {
-            return;
-        }
-        const result = await dependencies.execute(dependencies.createTestPlan(dependencies.createRoot(createRootOptions(meta, testNode, options))), createExecuteOptions(options, dependencies));
-        if (hasFailure(result) && shouldSetFailureExitCode(dependencies.readExitCode())) {
-            dependencies.writeExitCode(1);
-        }
-    };
-}
-//# sourceMappingURL=run-if-main.js.map

package/engine/run-if-main.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"run-if-main.js","sourceRoot":"","sources":["../../../../source/engine/run-if-main.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,yBAAyB,EAAuB,MAAM,sBAAsB,CAAC;AAkCtF,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAqC,CAAE,SAAS,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,CAAE,CAAC,CAAC;AAElG,SAAS,wBAAwB,CAAC,QAA4C;IAC1E,OAAO,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AAC1C,CAAC;AAED,SAAS,UAAU,CAAC,MAAiB;IACjC,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC;AACvE,CAAC;AAED,SAAS,YAAY,CAAC,OAAqC;IACvD,OAAO,OAAO,EAAE,IAAI,EAAE,QAAQ,IAAI,EAAE,CAAC;AACzC,CAAC;AAED,SAAS,QAAQ,CAAC,IAA0B,EAAE,OAAqC;IAC/E,OAAO,OAAO,EAAE,IAAI,EAAE,IAAI,IAAI,IAAI,CAAC,GAAG,CAAC;AAC3C,CAAC;AAED,SAAS,iBAAiB,CACtB,IAA0B,EAC1B,QAAkB,EAClB,OAAqC;IAErC,OAAO;QACH,QAAQ,EAAE,CAAE,QAAQ,CAAE;QACtB,QAAQ,EAAE,YAAY,CAAC,OAAO,CAAC;QAC/B,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;KAChC,CAAC;AACN,CAAC;AAED,SAAS,oBAAoB,CACzB,OAAqC,EACrC,YAAmC;IAEnC,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,8BAA8B,CAAC,CAAC;IAElF,OAAO;QACH,SAAS,EAAE,EAAE,IAAI,EAAE,mBAAmB,EAAE;QACxC,cAAc,EAAE,OAAO,EAAE,cAAc,IAAI,yBAAyB,EAAE;QACtE,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,EAAE;QACnC,QAAQ,EAAE;YACN,GAAG,OAAO,EAAE,QAAQ;YACpB,WAAW,EAAE,YAAY,CAAC,WAAW;SACxC;QACD,SAAS,EAAE,SAAS,CAAC,WAAW,EAAE;KACrC,CAAC;AACN,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,YAAmC;IAC/D,OAAO,KAAK,UAAU,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO;QACnD,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACb,OAAO;QACX,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,OAAO,CACrC,YAAY,CAAC,cAAc,CAAC,YAAY,CAAC,UAAU,CAAC,iBAAiB,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,EAChG,oBAAoB,CAAC,OAAO,EAAE,YAAY,CAAC,CAC9C,CAAC;QAEF,IAAI,UAAU,CAAC,MAAM,CAAC,IAAI,wBAAwB,CAAC,YAAY,CAAC,YAAY,EAAE,CAAC,EAAE,CAAC;YAC9E,YAAY,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;QAClC,CAAC;IACL,CAAC,CAAC;AACN,CAAC"}