@executablemd/cli 0.3.1 → 0.4.1

package/esm/deno.js

@@ -1,6 +1,6 @@
 export default {
     "name": "@executablemd/cli",
-    "version": "0.3.1",
+    "version": "0.4.1",
     "exports": "./src/cli.ts",
     "imports": {
         "@types/node": "npm:@types/node@^24.5.2",
@@ -10,10 +10,13 @@ export default {
         "@effectionx/test-adapter": "npm:@effectionx/test-adapter@0.7.4",
         "effection": "npm:effection@4.1.0-alpha.7",
         "effection/experimental": "npm:effection@4.1.0-alpha.7/experimental",
-        "@executablemd/durable-streams": "npm:@executablemd/durable-streams@^0.3.1",
-        "@executablemd/runtime": "npm:@executablemd/runtime@^0.3.1",
+        "@executablemd/durable-streams": "npm:@executablemd/durable-streams@^0.4.1",
+        "@executablemd/runtime": "npm:@executablemd/runtime@^0.4.1",
+        "@executablemd/testing": "npm:@executablemd/testing@^0.4.1",
+        "@std/assert": "jsr:@std/assert@^1.0.17",
+        "ajv": "npm:ajv@^8.17.1",
         "@executablemd/runtime/test": "file:///home/runner/work/executable.md/executable.md/runtime/test/mod.ts",
-        "@executablemd/code-review-agent": "npm:@executablemd/code-review-agent@^0.3.1",
+        "@executablemd/code-review-agent": "npm:@executablemd/code-review-agent@^0.4.1",
         "@effectionx/context-api": "npm:@effectionx/context-api@0.6.0",
         "@effectionx/converge": "npm:@effectionx/converge@0.1.4",
         "@effectionx/fetch": "npm:@effectionx/fetch@0.2.0",
@@ -32,10 +35,11 @@ export default {
         "oxlint-tsgolint": "npm:oxlint-tsgolint@^0.17",
         "unist-util-select": "npm:unist-util-select@^5",
         "mdast-util-to-string": "npm:mdast-util-to-string@^4",
-        "@executablemd/core": "npm:@executablemd/core@^0.3.1",
-        "@executablemd/core/": "npm:@executablemd/core@^0.3.1/",
-        "@executablemd/durable-streams/": "npm:@executablemd/durable-streams@^0.3.1/",
-        "@executablemd/runtime/": "npm:@executablemd/runtime@^0.3.1/",
-        "@executablemd/code-review-agent/": "npm:@executablemd/code-review-agent@^0.3.1/"
+        "@executablemd/core": "npm:@executablemd/core@^0.4.1",
+        "@executablemd/core/": "npm:@executablemd/core@^0.4.1/",
+        "@executablemd/durable-streams/": "npm:@executablemd/durable-streams@^0.4.1/",
+        "@executablemd/runtime/": "npm:@executablemd/runtime@^0.4.1/",
+        "@executablemd/testing/": "npm:@executablemd/testing@^0.4.1/",
+        "@executablemd/code-review-agent/": "npm:@executablemd/code-review-agent@^0.4.1/"
     }
 };

package/esm/src/cli.js

@@ -19,16 +19,11 @@ import { inspect } from "node:util";
 import process from "node:process";
 import { program, object, field, cli, commands } from "configliere";
 import { z } from "zod";
-import { runDocument, useNormalizedOutput, useTerminalOutput } from "@executablemd/core";
+import { execute, useNormalizedOutput, useTerminalOutput } from "@executablemd/core";
+import { installTestingVocabulary, TestFailureError, useTesting } from "@executablemd/testing";
 import { FileStream } from "./file-stream.js";
 import denoJson from "../deno.js";
-// ---------------------------------------------------------------------------
-// Workaround: field.default exists at runtime but is missing from the .d.ts
-// ---------------------------------------------------------------------------
 const defaults = (value) => (mods) => ({ ...mods, default: value });
-// ---------------------------------------------------------------------------
-// Program schema
-// ---------------------------------------------------------------------------
 const runConfig = object({
     docPath: {
         description: "markdown document to execute",
@@ -53,14 +48,35 @@ const runConfig = object({
         ...field(z.boolean(), defaults(false)),
     },
 });
+const testConfig = object({
+    docPath: {
+        description: "markdown document to test",
+        ...field(z.string(), cli.argument()),
+    },
+    componentDir: {
+        description: "component search directory",
+        ...field(z.array(z.string()), defaults(["components", "."]), field.array()),
+    },
+    verbose: {
+        description: "log journal entries to stderr",
+        aliases: ["-V"],
+        ...field(z.boolean(), defaults(false)),
+    },
+    journal: {
+        description: "write a diagnostic JSONL trace (path must not exist)",
+        aliases: ["-j"],
+        ...field(z.string().optional()),
+    },
+    raw: {
+        description: "output raw markdown without normalization or terminal formatting",
+        ...field(z.boolean(), defaults(false)),
+    },
+});
 const xmd = program({
     name: "xmd",
     version: denoJson.version,
-    config: commands({ run: runConfig }, { default: "run" }),
+    config: commands({ run: runConfig, test: testConfig }, { default: "run" }),
 });
-// ---------------------------------------------------------------------------
-// Journal entry formatting
-// ---------------------------------------------------------------------------
 const pretty = (value) => inspect(value, {
     colors: true,
     compact: true,
@@ -70,8 +86,9 @@ const pretty = (value) => inspect(value, {
 });
 function formatYieldResult(event) {
     const { result, description } = event;
-    if (result.status !== "ok" || result.value === undefined)
+    if (result.status !== "ok" || result.value === undefined) {
         return "";
+    }
     const v = result.value;
     switch (description.type) {
         case "import_component":
@@ -97,9 +114,6 @@ function summarizeEvent(event) {
     const detail = status === "err" && "error" in event.result ? ` (${event.result.error.message})` : "";
     return `[close] ${event.coroutineId} → ${status}${detail}`;
 }
-// ---------------------------------------------------------------------------
-// Document runner
-// ---------------------------------------------------------------------------
 function* createJournalFile(filePath) {
     let handle;
     try {
@@ -115,7 +129,7 @@ function* createJournalFile(filePath) {
     }
     yield* until(handle.close());
 }
-function* run(config) {
+function* run(config, mode) {
     const { docPath, componentDir, verbose, journal, raw } = config;
     // Every CLI invocation starts from an empty stream. --journal writes
     // current-run diagnostics only; existing traces are never loaded.
@@ -147,22 +161,23 @@ function* run(config) {
             }
         })
         : spawn(function* () { });
-    // ---------------------------------------------------------------------------
-    // Output middleware (spec §9).
-    //
-    // Middleware is installed on the DocumentOutput Api via Api.around() before
-    // runDocument is called. runDocument owns the channel internally —
-    // the CLI just installs transformations and consumes the returned stream.
-    // ---------------------------------------------------------------------------
     if (!raw) {
         yield* useNormalizedOutput();
     }
     if (process.stdout.isTTY && !raw) {
         yield* useTerminalOutput();
     }
-    // Run the document — returns a DocumentExecution.
-    // yield* execution waits for completion. execution.output streams chunks.
-    const execution = yield* runDocument({
+    // Compose testing around the single core execution entrypoint: both
+    // commands register the vocabulary (assertions work in regular documents,
+    // explicit <Testing> boundaries affect the outcome), while `xmd test`
+    // additionally activates root testing through a useTesting() session.
+    if (mode.testing) {
+        yield* useTesting({ verbose });
+    }
+    else {
+        yield* installTestingVocabulary({ verbose });
+    }
+    const execution = yield* execute({
         docPath,
         stream,
         componentDirs: componentDir,
@@ -184,10 +199,19 @@ function* run(config) {
         signal.close();
         yield* writer;
     }
+    // Inspect the completion Result AFTER the report finished streaming:
+    // test failures, assertion aborts, and any document abort exit nonzero.
+    const result = yield* execution;
+    if (!result.ok) {
+        if (result.error instanceof TestFailureError) {
+            console.error(`\ntests failed: ${result.error.message}`);
+        }
+        else {
+            console.error(result.error.message);
+        }
+        yield* exit(1);
+    }
 }
-// ---------------------------------------------------------------------------
-// Entry point
-// ---------------------------------------------------------------------------
 await main(function* (args) {
     const parser = xmd.createParser({ args });
     switch (parser.type) {
@@ -208,7 +232,10 @@ await main(function* (args) {
             }
             switch (parsed.value.name) {
                 case "run":
-                    yield* run(parsed.value.config);
+                    yield* run(parsed.value.config, { testing: false });
+                    break;
+                case "test":
+                    yield* run(parsed.value.config, { testing: true });
                     break;
             }
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@executablemd/cli",
-  "version": "0.3.1",
+  "version": "0.4.1",
   "description": "The xmd command-line interface for executable.md.",
   "homepage": "https://executable.md",
   "repository": {
@@ -17,8 +17,9 @@
   },
   "dependencies": {
     "@effectionx/stream-helpers": "0.8.3",
-    "@executablemd/core": "^0.3.1",
-    "@executablemd/durable-streams": "^0.3.1",
+    "@executablemd/core": "^0.4.1",
+    "@executablemd/durable-streams": "^0.4.1",
+    "@executablemd/testing": "^0.4.1",
     "configliere": "^0.2.3",
     "effection": "4.1.0-alpha.7",
     "zod": "^4.3.6"

package/types/deno.d.ts

@@ -12,6 +12,9 @@ declare namespace _default {
         "effection/experimental": string;
         "@executablemd/durable-streams": string;
         "@executablemd/runtime": string;
+        "@executablemd/testing": string;
+        "@std/assert": string;
+        ajv: string;
         "@executablemd/runtime/test": string;
         "@executablemd/code-review-agent": string;
         "@effectionx/context-api": string;
@@ -36,6 +39,7 @@ declare namespace _default {
         "@executablemd/core/": string;
         "@executablemd/durable-streams/": string;
         "@executablemd/runtime/": string;
+        "@executablemd/testing/": string;
         "@executablemd/code-review-agent/": string;
     };
 }