akm-cli 0.9.0-rc.0 → 0.9.0-rc.13

package/dist/output/context.js

@@ -9,7 +9,9 @@
  * calls read from this in-memory singleton instead of re-scanning argv and
  * re-loading config on every call.
  *
- * Initialized from `cli.ts` before `runMain`.
+ * Initialized from `cli.ts` before `runCli` dispatches the command (`cli.ts`
+ * drives citty's `runCommand` directly rather than `runMain` — see the
+ * top-level driver comment there).
  */
 import { UsageError } from "../core/errors.js";
 const OUTPUT_FORMATS = ["json", "yaml", "text", "jsonl", "md", "html"];
@@ -39,6 +41,8 @@ function parseShapeMode(value) {
 export function parseFlagValue(argv, flag) {
     for (let i = 0; i < argv.length; i++) {
         const arg = argv[i];
+        if (arg === "--")
+            break;
         if (arg === flag)
             return argv[i + 1];
         if (arg.startsWith(`${flag}=`))
@@ -47,15 +51,26 @@ export function parseFlagValue(argv, flag) {
     return undefined;
 }
 export function hasBooleanFlag(argv, flag) {
-    return argv.some((arg) => arg === flag || arg === `${flag}=true`);
+    for (const arg of argv) {
+        if (arg === "--")
+            return false;
+        if (arg === flag || arg === `${flag}=true`)
+            return true;
+    }
+    return false;
 }
 /**
  * Read a hyphenated arg out of citty's parsed `args` object.
  *
- * citty does not auto-camelise hyphenated arg keys (see `--max-pages`,
- * `--with-sources` for the existing convention), so command handlers end up
- * casting `args` to a string-indexed record at every read site. This helper
- * encapsulates the cast.
+ * Verified live: citty DOES auto-camelise a DECLARED hyphenated arg — for
+ * `"max-pages": { type: "string" }` in a command's `args`, citty's parsed
+ * object answers both `args["max-pages"]` and `args.maxPages` (a `Proxy`
+ * falls back through `camelCase`/`kebabCase`, and `--no-<flag>` negation is
+ * handled the same way for booleans). What citty's own TS types do NOT give
+ * callers is a statically-typed handle on that mapping, and command handlers
+ * here type `args` as `unknown` at the boundary — so every read site still
+ * needs a cast. This helper encapsulates that cast; it exists for typing
+ * convenience, not to work around a citty parsing limitation.
  */
 export function getHyphenatedArg(args, key) {
     if (typeof args !== "object" || args === null)
@@ -81,7 +96,7 @@ export function resolveOutputMode(argv, defaults = {}) {
     const detail = parseDetailLevel(rawDetail) ?? defaults?.detail ?? "brief";
     const shape = parseShapeMode(rawShape) ?? "human";
     const outputPath = parseFlagValue(argv, "--output");
-    return { format, detail, shape, forAgent: shape === "agent", ...(outputPath ? { outputPath } : {}) };
+    return { format, detail, shape, ...(outputPath ? { outputPath } : {}) };
 }
 let _mode;
 /**

package/dist/output/format-exempt.js

@@ -0,0 +1,80 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+/**
+ * Commands whose output is not an envelope, and therefore not formattable (D7).
+ *
+ * D7 makes all six `--format` values work on every command that renders through
+ * `output()`. A small set does not render an envelope at all: they emit a shell
+ * script, drive an interactive prompt, hand stdout to a child process, or print
+ * a document that IS the payload. Passing `--format` to one of those cannot do
+ * anything useful.
+ *
+ * The point of declaring the set here is that the exemption stops being
+ * implicit. Before D7 you discovered it by getting JSON when you asked for
+ * Markdown, or an exit 2 when you asked for HTML. Now the list is one grep away,
+ * it is documented in `STABILITY.md`, and asking for a format on an exempt
+ * command warns instead of silently doing something else.
+ *
+ * Names are canonical command paths resolved from the Citty tree.
+ */
+/**
+ * Top-level command tokens whose entire surface is format-exempt.
+ */
+const EXEMPT_COMMANDS = new Set([
+    // Emits shell completion script source for eval.
+    "completions",
+    // Both subcommands (`status`, `apply`) are also a child-process passthrough:
+    // `runMigrationTool` (src/commands/migration-tool.ts) spawns the standalone
+    // `scripts/akm-migrate.ts` tool and writes its stdout/stderr verbatim — the
+    // spawned script always emits its own fixed JSON shape and never consults
+    // `--format`. Found while verifying F1 (D7 B1): the finding's repro list
+    // named `akm migrate status --format text` alongside `secret list` as the
+    // SAME defect (missing text renderer inside `output()`), but `migrate
+    // status`/`apply` never reach `output()` at all, so that fix cannot and
+    // does not change their behavior — this is the `env run`/`secret run`
+    // passthrough pattern, not the generic-text-fallback one.
+    "migrate",
+    // Document payload group: bare `help` prints the sectioned overview,
+    // `help migrate <version>` prints release notes, and `help agents` prints
+    // the embedded CLI-reference guide (`src/output/cli-hints.ts`) — none of
+    // the three render a result envelope.
+    "help",
+    // Embedded agent guide document.
+    "hints",
+]);
+/**
+ * `<command> <subcommand>` pairs that are exempt while the rest of the group
+ * formats normally.
+ */
+const EXEMPT_SUBCOMMANDS = new Set([
+    // Child-process passthrough (the env/secret groups otherwise format fine).
+    "env run",
+    "secret run",
+    // B3/B4 (W1-F): a bare absolute filesystem path IS the payload — the
+    // documented shell-substitution primitive (`$(akm env path <ref>)`,
+    // Docker `_FILE` / `--env-file`) — not a field worth wrapping in an
+    // envelope. Wrapping it broke every existing substitution silently: the
+    // CLI's default format is `json`, so an un-flagged `akm env path <ref>`
+    // (exactly how the substitution is always written) started emitting
+    // `{"path":"..."}` instead of the raw path. Unlike `config path`, this
+    // command has no `--all`-style multi-field variant, so the whole surface
+    // can be exempt without wrongly warning on a real envelope case.
+    "env path",
+]);
+/**
+ * True when `--format` cannot meaningfully apply to this invocation.
+ *
+ * `commandPath` contains canonical Citty command names from the top-level
+ * command through the deepest resolved subcommand.
+ */
+export function isFormatExemptCommand(commandPath) {
+    const command = commandPath[0];
+    if (command === undefined)
+        return false;
+    return EXEMPT_COMMANDS.has(command) || EXEMPT_SUBCOMMANDS.has(commandPath.join(" "));
+}
+/** The declared exempt set, for docs generation and tests. */
+export function formatExemptSurfaces() {
+    return { commands: [...EXEMPT_COMMANDS], subcommands: [...EXEMPT_SUBCOMMANDS] };
+}

package/dist/output/generic-render.js

@@ -0,0 +1,251 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+/**
+ * True when `value` is a non-empty array of plain objects — the shape worth
+ * rendering as a table rather than as a nested list. Uniformity is judged on
+ * the union of keys, not on strict equality, so one row carrying an extra
+ * optional field still tabulates (its column is simply blank elsewhere).
+ */
+function isTabular(value) {
+    if (!Array.isArray(value) || value.length === 0)
+        return false;
+    return value.every((row) => row !== null && typeof row === "object" && !Array.isArray(row));
+}
+/** Column order for a table: first appearance across all rows, order-stable. */
+function tableColumns(rows) {
+    const columns = [];
+    for (const row of rows) {
+        for (const key of Object.keys(row)) {
+            if (!columns.includes(key))
+                columns.push(key);
+        }
+    }
+    return columns;
+}
+/**
+ * Render a leaf value for display. Objects and arrays that reach a cell are
+ * JSON-encoded rather than expanded — a table cell is not a place to nest.
+ */
+function displayScalar(value) {
+    if (value === null || value === undefined)
+        return "";
+    if (typeof value === "string")
+        return value;
+    if (typeof value === "number" || typeof value === "boolean")
+        return String(value);
+    return JSON.stringify(value);
+}
+/**
+ * Root-level envelope metadata the shape registry stamps on top of a
+ * command's actual result: `shape` (the discriminator) and `schemaVersion`
+ * (the envelope's own version), both added by the passthrough stamp in
+ * `src/output/shapes/passthrough.ts` and equivalent per-command shapers
+ * elsewhere. Transport bookkeeping, not a result anyone asked for — a `##
+ * shape` / `## schemaVersion` section (`renderGenericMarkdown`), an
+ * `<h2>shape</h2>` block (`renderGenericHtml`), or a `shape=…` line
+ * (`renderGenericText`) is noise in every command's output, so every generic
+ * renderer drops both. ONLY at the root, though: some shapes reuse
+ * `schemaVersion` as genuine per-entry content one level down (each event in
+ * `log list`'s `events[]` carries its own `schemaVersion`, see
+ * `shapeEventEntry` in `src/output/shapes/helpers.ts`), and that must
+ * survive untouched — every renderer below applies this filter only to the
+ * top-level `Object.entries` loop over the envelope, never recursively.
+ */
+const ENVELOPE_META_KEYS = new Set(["shape", "schemaVersion"]);
+// ── Markdown ─────────────────────────────────────────────────────────────────
+/** Escape the one character that can break a Markdown table row. */
+function escapeCell(text) {
+    return text.replace(/\|/g, "\\|").replace(/\n/g, " ");
+}
+function markdownTable(rows) {
+    const columns = tableColumns(rows);
+    if (columns.length === 0)
+        return [];
+    const lines = [
+        `| ${columns.join(" | ")} |`,
+        `| ${columns.map(() => "---").join(" | ")} |`,
+        ...rows.map((row) => `| ${columns.map((c) => escapeCell(displayScalar(row[c]))).join(" | ")} |`),
+    ];
+    return lines;
+}
+function markdownValue(value, depth) {
+    if (isTabular(value))
+        return markdownTable(value);
+    if (Array.isArray(value)) {
+        if (value.length === 0)
+            return ["_(none)_"];
+        return value.map((item) => `- ${escapeCell(displayScalar(item))}`);
+    }
+    if (value !== null && typeof value === "object") {
+        const lines = [];
+        for (const [key, nested] of Object.entries(value)) {
+            // Headings stop at h6; deeper nesting continues as bolded labels.
+            const heading = "#".repeat(Math.min(depth, 6));
+            lines.push(depth <= 6 ? `${heading} ${key}` : `**${key}**`, "", ...markdownValue(nested, depth + 1), "");
+        }
+        return lines;
+    }
+    return [displayScalar(value) === "" ? "_(empty)_" : displayScalar(value)];
+}
+/**
+ * Render a shaped envelope as Markdown. `command` titles the document so a
+ * rendered file identifies itself once detached from the invocation.
+ */
+export function renderGenericMarkdown(command, value) {
+    const body = value !== null && typeof value === "object" && !Array.isArray(value)
+        ? Object.entries(value)
+            .filter(([key]) => !ENVELOPE_META_KEYS.has(key)) // transport metadata, not a result
+            .flatMap(([key, nested]) => [`## ${key}`, "", ...markdownValue(nested, 3), ""])
+        : markdownValue(value, 2);
+    const lines = [`# ${command}`, "", ...body];
+    const rendered = lines
+        .join("\n")
+        .replace(/\n{3,}/g, "\n\n")
+        .trimEnd();
+    return `${rendered}\n`;
+}
+// ── HTML ─────────────────────────────────────────────────────────────────────
+const HTML_ESCAPES = {
+    "&": "&amp;",
+    "<": "&lt;",
+    ">": "&gt;",
+    '"': "&quot;",
+    "'": "&#39;",
+};
+/** Escape every value that reaches the document — this is untrusted content. */
+function escapeHtml(text) {
+    return text.replace(/[&<>"']/g, (char) => HTML_ESCAPES[char] ?? char);
+}
+function htmlTable(rows) {
+    const columns = tableColumns(rows);
+    if (columns.length === 0)
+        return "";
+    const head = `<tr>${columns.map((c) => `<th scope="col">${escapeHtml(c)}</th>`).join("")}</tr>`;
+    const body = rows
+        .map((row) => `<tr>${columns.map((c) => `<td>${escapeHtml(displayScalar(row[c]))}</td>`).join("")}</tr>`)
+        .join("");
+    return `<table><thead>${head}</thead><tbody>${body}</tbody></table>`;
+}
+function htmlValue(value, depth) {
+    if (isTabular(value))
+        return htmlTable(value);
+    if (Array.isArray(value)) {
+        if (value.length === 0)
+            return "<p><em>(none)</em></p>";
+        return `<ul>${value.map((item) => `<li>${escapeHtml(displayScalar(item))}</li>`).join("")}</ul>`;
+    }
+    if (value !== null && typeof value === "object") {
+        const level = Math.min(depth, 6);
+        return Object.entries(value)
+            .map(([key, nested]) => `<h${level}>${escapeHtml(key)}</h${level}>${htmlValue(nested, depth + 1)}`)
+            .join("");
+    }
+    const scalar = displayScalar(value);
+    return scalar === "" ? "<p><em>(empty)</em></p>" : `<p>${escapeHtml(scalar)}</p>`;
+}
+/**
+ * Render a shaped envelope as a self-contained HTML document.
+ *
+ * Self-contained matters: the output is routinely redirected to a file and
+ * opened directly, so it carries its own minimal styling and references
+ * nothing external.
+ */
+export function renderGenericHtml(command, value) {
+    const body = value !== null && typeof value === "object" && !Array.isArray(value)
+        ? Object.entries(value)
+            .filter(([key]) => !ENVELOPE_META_KEYS.has(key)) // transport metadata, not a result
+            .map(([key, nested]) => `<h2>${escapeHtml(key)}</h2>${htmlValue(nested, 3)}`)
+            .join("")
+        : htmlValue(value, 2);
+    return [
+        "<!doctype html>",
+        '<html lang="en">',
+        "<head>",
+        '<meta charset="utf-8">',
+        '<meta name="viewport" content="width=device-width, initial-scale=1">',
+        `<title>akm ${escapeHtml(command)}</title>`,
+        "<style>",
+        "body{font:16px/1.5 system-ui,sans-serif;margin:2rem auto;max-width:60rem;padding:0 1rem}",
+        "table{border-collapse:collapse;width:100%;margin:0 0 1rem}",
+        "th,td{border:1px solid #8884;padding:.35rem .6rem;text-align:left}",
+        "th{background:#8881}",
+        "h1{margin-bottom:1.5rem}",
+        "@media(prefers-color-scheme:dark){body{background:#111;color:#eee}}",
+        "</style>",
+        "</head>",
+        "<body>",
+        `<h1>akm ${escapeHtml(command)}</h1>`,
+        body === "" ? "<p><em>(no output)</em></p>" : body,
+        "</body>",
+        "</html>",
+        "",
+    ].join("\n");
+}
+// ── Text ─────────────────────────────────────────────────────────────────────
+/**
+ * Flatten `value` onto `lines` as `dotted.path=value` entries — the exact
+ * algorithm `formatConfigPlain` (`src/output/text/command-format.ts`)
+ * already established as this CLI's real plain-text house style for `akm
+ * config list`. Arrays serialize as one compact-JSON line rather than
+ * index-per-line (`items.0.name=…`), matching that same precedent instead of
+ * inventing a second convention: the arrays that reach this generic
+ * fallback are typically short id/tag lists, where one JSON-array line reads
+ * better than N extra `path.0=`, `path.1=`, … lines.
+ */
+function flattenForText(value, path, lines) {
+    if (value === null || value === undefined) {
+        lines.push(`${path}=`);
+    }
+    else if (Array.isArray(value)) {
+        lines.push(`${path}=${JSON.stringify(value)}`);
+    }
+    else if (typeof value === "object") {
+        const entries = Object.entries(value);
+        if (entries.length === 0) {
+            lines.push(`${path}={}`);
+            return;
+        }
+        for (const [key, nested] of entries) {
+            flattenForText(nested, `${path}.${key}`, lines);
+        }
+    }
+    else {
+        lines.push(`${path}=${String(value)}`);
+    }
+}
+/**
+ * Render a shaped envelope as flat `key=value` text — no markup characters.
+ *
+ * This is a DISTINCT function from `renderGenericMarkdown`, not a reuse of
+ * it, and that is a deliberate reversal of this fallback's first cut, which
+ * called `renderGenericMarkdown` directly for `text` on the reasoning that
+ * it emits no HTML and is therefore "plain-text-safe." That reasoning was
+ * wrong: `#` heading markers, `_..._` emphasis, and `| ... |` table syntax
+ * ARE markup — a terminal happens to print them as literal characters
+ * instead of throwing, but a user piping `--format text` into `grep` or a
+ * line-oriented script still sees literal `#`/`_`/`|` noise that plain JSON
+ * at least didn't have. That is the exact "one format wearing another
+ * format's flag" defect this whole fallback exists to close, with Markdown
+ * substituted for JSON instead of JSON itself.
+ *
+ * `akm config list --format text` and `akm info --format text` already
+ * establish this CLI's real plain-text convention — flat `dotted.path=value`
+ * lines, no markup — so the generic fallback now matches its registered
+ * siblings (what a command looks like once someone writes it a bespoke
+ * formatter) instead of matching `md`'s.
+ */
+export function renderGenericText(command, value) {
+    const lines = [];
+    if (value !== null && typeof value === "object" && !Array.isArray(value)) {
+        for (const [key, nested] of Object.entries(value)) {
+            if (ENVELOPE_META_KEYS.has(key))
+                continue; // transport metadata, not a result
+            flattenForText(nested, key, lines);
+        }
+    }
+    else {
+        flattenForText(value, command, lines);
+    }
+    return lines.length === 0 ? `${command}: (empty)\n` : `${lines.join("\n")}\n`;
+}

package/dist/output/html-render.js

@@ -5,30 +5,25 @@
  * `--format html` rendering primitives (#582).
  *
  * Templates live in `src/assets/templates/html/` (mirrored to
- * `dist/assets/templates/html/` by `scripts/copy-assets.ts`). A command with a
- * bespoke template ships `<command>.html`; every other command falls back to
- * `default.html`, which renders the command's JSON envelope in a `<pre>`
- * block. Substitution is plain `%%TOKEN%%` string replacement — no template
- * engine, by design.
+ * `dist/assets/templates/html/` by `scripts/copy-assets.ts`). `--format html`
+ * is health-only (chunk-9 WI-9.4c / Decision 4): `akm health` ships the sole
+ * bespoke `<command>.html` template; every other command rejects `--format
+ * html` with a `UsageError` before reaching this module (see
+ * `src/cli/shared.ts`'s `output()`). Substitution is plain `%%TOKEN%%` string
+ * replacement — no template engine, by design.
  */
 import fs from "node:fs";
 import path from "node:path";
 import { getDirname } from "../runtime.js";
 const TEMPLATES_DIR = path.join(getDirname(import.meta.url), "../assets/templates/html");
-/** Template used by every command without a bespoke `<command>.html`. */
-export const DEFAULT_TEMPLATE = "default";
 /**
- * Resolve the on-disk template path for a command. `<command>.html` when the
- * command ships a bespoke template (today: `health`), otherwise
- * `default.html`. Command names are sanitized to a bare basename so a hostile
- * command string can never escape the templates directory.
+ * Resolve the on-disk template path for a command's bespoke `<command>.html`.
+ * The command name is sanitized to a bare basename so a hostile command
+ * string can never escape the templates directory.
  */
 export function resolveTemplatePath(command) {
     const name = path.basename(command.trim());
-    const candidate = path.join(TEMPLATES_DIR, `${name}.html`);
-    if (name !== DEFAULT_TEMPLATE && fs.existsSync(candidate))
-        return candidate;
-    return path.join(TEMPLATES_DIR, `${DEFAULT_TEMPLATE}.html`);
+    return path.join(TEMPLATES_DIR, `${name}.html`);
 }
 /** Matches a `%%TOKEN%%` placeholder (uppercase + underscore key). */
 const TOKEN_RE = /%%[A-Z_]+%%/g;
@@ -43,7 +38,7 @@ const TOKEN_RE = /%%[A-Z_]+%%/g;
  */
 export function renderHtml(templatePath, replacements) {
     const html = fs.readFileSync(templatePath, "utf8");
-    return html.replace(TOKEN_RE, (token) => (token in replacements ? replacements[token] : token));
+    return html.replace(TOKEN_RE, (token) => replacements[token] ?? token);
 }
 /**
  * Minimal HTML entity escaping for text interpolated into templates. Escapes

package/dist/output/render-registry.js

@@ -0,0 +1,57 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+/**
+ * Per-command `md` / `html` renderer registries (D7).
+ *
+ * Mirrors `src/output/text/registry.ts`: a command may register a bespoke
+ * renderer for a document format, and anything unregistered falls back to the
+ * generic rendering of its shaped envelope (`./generic-render`). The fallback
+ * is what makes all six `--format` values universal; the registry is what lets
+ * a command that has something better to say — `akm health` and its report
+ * templates — say it without the output pipeline knowing that command exists.
+ *
+ * Kept separate from the module that dispatches through it so per-command
+ * renderer modules can import `registerMdRenderer` / `registerHtmlRenderer`
+ * without a cycle back into the pipeline, exactly as the text registry does.
+ *
+ * Returning `null` from a handler means "I have nothing special for this
+ * payload" and falls through to the generic renderer — `akm health` uses that
+ * to keep its bespoke tables for the shapes that have them while still
+ * rendering everything else.
+ */
+import { createCommandRegistry } from "./command-registry.js";
+const MD_RENDERER_REGISTRY = createCommandRegistry();
+const HTML_RENDERER_REGISTRY = createCommandRegistry();
+/** Register a Markdown renderer for a command name. */
+export function registerMdRenderer(command, handler) {
+    MD_RENDERER_REGISTRY.register(command, handler);
+}
+/** Register a batch of Markdown renderers in iteration order. */
+export function registerMdRenderers(entries) {
+    MD_RENDERER_REGISTRY.registerAll(entries);
+}
+/** Look up a registered Markdown renderer, or `undefined` when unregistered. */
+export function getMdRendererHandler(command) {
+    return MD_RENDERER_REGISTRY.get(command);
+}
+/** Remove a previously-registered Markdown renderer. Test-only utility. */
+export function deregisterMdRenderer(command) {
+    MD_RENDERER_REGISTRY.deregister(command);
+}
+/** Register an HTML renderer for a command name. */
+export function registerHtmlRenderer(command, handler) {
+    HTML_RENDERER_REGISTRY.register(command, handler);
+}
+/** Register a batch of HTML renderers in iteration order. */
+export function registerHtmlRenderers(entries) {
+    HTML_RENDERER_REGISTRY.registerAll(entries);
+}
+/** Look up a registered HTML renderer, or `undefined` when unregistered. */
+export function getHtmlRendererHandler(command) {
+    return HTML_RENDERER_REGISTRY.get(command);
+}
+/** Remove a previously-registered HTML renderer. Test-only utility. */
+export function deregisterHtmlRenderer(command) {
+    HTML_RENDERER_REGISTRY.deregister(command);
+}