argsbarg 6.1.2 → 6.1.4

package/src/help.test.ts

@@ -0,0 +1,152 @@
+/*
+Help rendering and label formatting tests.
+*/
+
+import { describe, expect, test } from "bun:test";
+import { cliPresentationRoot } from "./builtins/presentation.ts";
+import { type CliOption, CliOptionKind, type CliPositional } from "./core/types.ts";
+import { CLI_NOTES_PROGRAM, cliHelpRender, cliOptionLabel, cliPositionalLabel, cliResolveNotes } from "./help.ts";
+import { testProgram } from "./test/fixtures.ts";
+
+describe("cliOptionLabel", () => {
+  test.each([
+    {
+      name: "string option",
+      option: { name: "out", description: "Output path.", kind: CliOptionKind.String },
+      expected: "--out <string>",
+    },
+    {
+      name: "required enum",
+      option: {
+        name: "format",
+        description: "Format.",
+        kind: CliOptionKind.Enum,
+        choices: ["pdf", "html"],
+        required: true,
+      },
+      expected: "--format <pdf|html>",
+    },
+    {
+      name: "short name",
+      option: {
+        name: "verbose",
+        description: "Verbose.",
+        kind: CliOptionKind.Presence,
+        shortName: "v",
+      },
+      expected: "--verbose, -v",
+    },
+    {
+      name: "json option",
+      option: { name: "body", description: "JSON body.", kind: CliOptionKind.Json },
+      expected: "--body <json>",
+    },
+  ])("$name", ({ option, expected }) => {
+    expect(cliOptionLabel(option as CliOption, false)).toBe(expected);
+  });
+});
+
+describe("cliPositionalLabel", () => {
+  test.each([
+    { positional: { name: "file", description: "File." }, expected: "<file>" },
+    { positional: { name: "file", description: "File.", argMin: 0 }, expected: "[file]" },
+    { positional: { name: "paths", description: "Paths.", argMax: 0 }, expected: "<paths...>" },
+    { positional: { name: "paths", description: "Paths.", argMin: 0, argMax: 0 }, expected: "[paths...]" },
+  ])("$expected", ({ positional, expected }) => {
+    expect(cliPositionalLabel(positional as CliPositional, false)).toBe(expected);
+  });
+});
+
+describe("cliResolveNotes", () => {
+  test("replaces program placeholder", () => {
+    expect(cliResolveNotes(`Run \`${CLI_NOTES_PROGRAM} docs readme\`.`, "myapp")).toBe("Run `myapp docs readme`.");
+  });
+});
+
+describe("cliHelpRender", () => {
+  test("docs help lists schema, cli, and skill subcommands", () => {
+    const root = testProgram({
+      key: "app",
+      version: "1.0.0",
+      description: "demo",
+      docs: {
+        topics: { readme: { text: "# readme\n" } },
+      },
+      commands: [
+        {
+          key: "x",
+          description: "cmd",
+          handler: () => {},
+        },
+      ],
+    });
+    const help = cliHelpRender(cliPresentationRoot(root), ["docs"], false);
+    expect(help).toContain("cli-schema");
+    expect(help).toContain("Print the full CLI command tree as JSON.");
+    expect(help).toContain("cli");
+    expect(help).toContain("markdown");
+    expect(help).toContain("skill");
+    expect(help).toContain("reference agent SKILL");
+  });
+
+  test("root help omits legacy --schema flag", () => {
+    const root = testProgram({
+      key: "app",
+      version: "1.0.0",
+      description: "demo",
+      commands: [
+        {
+          key: "x",
+          description: "cmd",
+          handler: () => {},
+        },
+      ],
+    });
+    const help = cliHelpRender(cliPresentationRoot(root), [], false);
+    expect(help).not.toContain("--schema");
+  });
+
+  test("root help shows agent docs hint when docs enabled", () => {
+    const root = testProgram({
+      key: "myapp",
+      version: "1.0.0",
+      description: "demo",
+      docs: {
+        topics: { readme: { text: "# readme\n" } },
+      },
+      commands: [{ key: "run", description: "Run.", handler: () => {} }],
+    });
+    const help = cliHelpRender(cliPresentationRoot(root), [], false);
+    expect(help).toContain("For AI agents: `myapp docs skill`.");
+    expect(help).not.toContain("install --skill");
+  });
+
+  test("root help omits agent hint when docs disabled", () => {
+    const root = testProgram({
+      key: "myapp",
+      version: "1.0.0",
+      description: "demo",
+      docs: { enabled: false },
+      commands: [{ key: "run", description: "Run.", handler: () => {} }],
+    });
+    const help = cliHelpRender(cliPresentationRoot(root), [], false);
+    expect(help).not.toContain("Agents:");
+    expect(help).not.toContain("docs skill");
+  });
+
+  test("root help includes program notes and agent hint", () => {
+    const root = testProgram({
+      key: "myapp",
+      version: "1.0.0",
+      description: "demo",
+      notes: "See `{argsbarg:program} docs readme` for the user guide.",
+      docs: {
+        topics: { readme: { text: "# readme\n" } },
+      },
+      commands: [{ key: "run", description: "Run.", handler: () => {} }],
+    });
+    const help = cliHelpRender(cliPresentationRoot(root), [], false);
+    expect(help).toContain("See `myapp docs readme` for the user guide.");
+    expect(help).toContain("myapp docs skill");
+  });
+});

package/src/help.ts

@@ -7,7 +7,6 @@ It keeps help formatting shared across help and error paths so users see one con
 style no matter how help is reached.
 */
 
-import { visibleOptions, visibleSubcommands } from "./hidden.ts";
 import {
   type CliNode,
   type CliOption,
@@ -17,7 +16,8 @@ import {
   isCliLeaf,
   isCliRouter,
   isJsonLeaf,
-} from "./types.ts";
+} from "./core/types.ts";
+import { visibleOptions, visibleSubcommands } from "./runtime/exposure.ts";
 
 // ── ANSI Style Helpers ────────────────────────────────────────────────────────
 
@@ -197,7 +197,7 @@ export function cliOptionLabel(o: CliOption, color: boolean): string {
   return `${style.aquaBold(left)} ${style.greenBright(right)}`;
 }
 
-/** Placeholder in `notes` for the root program key (resolved in help, schema, and docs api). */
+/** Placeholder in `notes` for the root program key (resolved in help, schema, and docs cli). */
 export const CLI_NOTES_PROGRAM = "{argsbarg:program}";
 
 /** Replaces `{argsbarg:program}` in notes/help text with the program key. */

package/src/hooks/builtin.ts

@@ -0,0 +1,20 @@
+/*
+Detects built-in command paths so invoke hooks are skipped for framework commands.
+*/
+
+const BUILTIN_ROOTS = new Set(["completion", "version", "http", "mcp", "configure", "docs"]);
+
+/** True when `path` routes to a framework built-in (hooks are skipped). */
+export function isBuiltinInvokePath(path: string[]): boolean {
+  const root = path[0];
+  if (!root || !BUILTIN_ROOTS.has(root)) {
+    return false;
+  }
+  if (root === "http") {
+    return path.length <= 1 || path[1] === "serve";
+  }
+  if (root === "mcp") {
+    return path.length <= 1 || path[1] === "serve" || path[1] === "bundle";
+  }
+  return true;
+}

package/src/hooks/run.ts

@@ -0,0 +1,142 @@
+/*
+Safe async hook runner, failure classification, and invoke error pipeline.
+*/
+
+import type { CliContext } from "~/core/context.ts";
+import { LeafInputError } from "~/core/leaf-inputs.ts";
+import type {
+  ClientErrorOverride,
+  ErrorHookContext,
+  InvokeFailureKind,
+  InvokeHookContext,
+  ServerRuntime,
+} from "~/core/types.ts";
+import { firstErrorLine } from "~/http/result.ts";
+import { type LogEmitter, obscureUnexpectedClientMessage } from "~/log/emitter.ts";
+
+/** Runs a hook without letting hook throws escape uncaught. */
+export async function runHook<T>(hook: (() => T | Promise<T>) | undefined, label: string): Promise<T | undefined> {
+  if (!hook) {
+    return undefined;
+  }
+  try {
+    return await Promise.resolve(hook());
+  } catch (err) {
+    const message = err instanceof Error ? err.message : String(err);
+    throw new Error(`${label} hook failed: ${message}`, { cause: err });
+  }
+}
+
+/** Classifies an invoke failure for status mapping and logging. */
+export function classifyFailureKind(
+  err: unknown,
+  opts: { parseError?: boolean; help?: boolean; missingConfig?: boolean; notReady?: boolean },
+): InvokeFailureKind {
+  if (opts.help) {
+    return "help";
+  }
+  if (opts.missingConfig) {
+    return "missing_config";
+  }
+  if (opts.notReady) {
+    return "not_ready";
+  }
+  if (opts.parseError || err instanceof LeafInputError) {
+    return "validation";
+  }
+  if (err instanceof Error) {
+    return "validation";
+  }
+  return "unexpected";
+}
+
+/** HTTP status for a classified failure kind. */
+export function failureKindHttpStatus(kind: InvokeFailureKind): number {
+  switch (kind) {
+    case "validation":
+    case "help":
+      return 400;
+    case "unknown_route":
+      return 404;
+    case "missing_config":
+    case "not_ready":
+      return 503;
+    case "unexpected":
+      return 500;
+  }
+}
+
+/** Builds {@link InvokeHookContext} from a live {@link CliContext}. */
+export function buildInvokeHookContext(
+  ctx: CliContext,
+  extras: {
+    path: string[];
+    runtime?: ServerRuntime;
+    http?: InvokeHookContext["http"];
+    mcp?: InvokeHookContext["mcp"];
+  },
+): InvokeHookContext {
+  return {
+    invocation: ctx.invocation,
+    path: extras.path,
+    pathParams: { ...ctx.pathParams },
+    opts: ctx.opts,
+    locals: ctx.locals,
+    runtime: extras.runtime,
+    appConfig: ctx.appConfig,
+    http: extras.http,
+    mcp: extras.mcp,
+  };
+}
+
+function defaultClientError(err: unknown, _failureKind: InvokeFailureKind): ClientErrorOverride {
+  const message =
+    err instanceof Error ? err.message : typeof err === "string" ? err : firstErrorLine(String(err)) || "Error";
+  return { message, exitCode: 1 };
+}
+
+export interface ErrorPipelineResult {
+  failureKind: InvokeFailureKind;
+  clientError: ClientErrorOverride;
+  errorMsg: string;
+}
+
+/** Runs formatError → onError → ECS emit for one invoke failure. */
+export async function runErrorPipeline(
+  hookCtx: InvokeHookContext,
+  err: unknown,
+  failureKind: InvokeFailureKind,
+  hooks: import("~/core/types.ts").CliProgramHooks | undefined,
+  emitter: LogEmitter | undefined,
+  obscureUnexpected: boolean,
+): Promise<ErrorPipelineResult> {
+  let clientError = defaultClientError(err, failureKind);
+  if (failureKind === "unexpected" && obscureUnexpected) {
+    clientError = { message: obscureUnexpectedClientMessage(), exitCode: 1 };
+  }
+
+  const errorCtx: ErrorHookContext = {
+    ...hookCtx,
+    failureKind,
+    error: err,
+    clientError: { ...clientError },
+  };
+
+  const formatted = await runHook(() => hooks?.formatError?.(errorCtx), "formatError");
+  if (formatted) {
+    clientError = { ...clientError, ...formatted };
+    errorCtx.clientError = { ...clientError };
+  }
+
+  await runHook(() => hooks?.onError?.(errorCtx), "onError");
+
+  const displayMessage =
+    failureKind === "unexpected" && obscureUnexpected ? obscureUnexpectedClientMessage() : clientError.message;
+
+  emitter?.emitInvokeError(failureKind, err, displayMessage, {
+    invocation: hookCtx.invocation,
+    path: hookCtx.path.join(" "),
+  });
+
+  return { failureKind, clientError, errorMsg: displayMessage };
+}

package/src/http/openapi.ts

@@ -0,0 +1,290 @@
+/*
+Hand-built OpenAPI 3.1 document from exposed HTTP REST routes.
+*/
+
+import { collectOptionDefs } from "~/core/parse.ts";
+import type { CliHttpMethod, CliNode, CliProgram } from "~/core/types.ts";
+import { CliOptionKind, isCliLeaf, isJsonLeaf } from "~/core/types.ts";
+import { collectHttpRoutes, defaultSuccessStatus } from "./routes.ts";
+import { dereferenceJsonSchema } from "./schema-deref.ts";
+
+const JSON_CONTENT_TYPE = "application/json; charset=utf-8";
+
+function defaultErrorSchema(): Record<string, unknown> {
+  return {
+    type: "object",
+    properties: { error: { type: "string" } },
+    required: ["error"],
+  };
+}
+
+function errorResponseSchema(program: CliProgram): Record<string, unknown> {
+  const custom = program.httpServer?.errors?.errorSchema;
+  return custom ? dereferenceJsonSchema(custom) : defaultErrorSchema();
+}
+
+function errorResponseEntry(program: CliProgram, description: string): Record<string, unknown> {
+  return {
+    description,
+    content: {
+      [JSON_CONTENT_TYPE]: {
+        schema: errorResponseSchema(program),
+      },
+    },
+  };
+}
+
+function buildInputSchema(
+  program: CliProgram,
+  route: ReturnType<typeof collectHttpRoutes>[number],
+): Record<string, unknown> {
+  const leaf = route.leaf;
+  if (leaf.inputSchema) {
+    return leaf.inputSchema;
+  }
+  const properties: Record<string, unknown> = {};
+  const required: string[] = [];
+  for (const p of route.paramNames) {
+    properties[p] = { type: "string" };
+    required.push(p);
+  }
+  const argv = route.commandPath.filter((k) => !k.startsWith(":"));
+  for (const opt of collectOptionDefs(program, argv)) {
+    if (opt.kind === CliOptionKind.Json) {
+      continue;
+    }
+    properties[opt.name] = { type: "string", description: opt.description };
+    if (opt.required) {
+      required.push(opt.name);
+    }
+  }
+  for (const p of leaf.positionals ?? []) {
+    properties[p.name] = { type: "string", description: p.description };
+    if ((p.argMin ?? 1) >= 1) {
+      required.push(p.name);
+    }
+  }
+  return {
+    type: "object",
+    properties,
+    ...(required.length > 0 ? { required } : {}),
+  };
+}
+
+/** Builds success response entries for OpenAPI (status → response object). */
+function buildSuccessResponses(route: ReturnType<typeof collectHttpRoutes>[number]): Record<string, unknown> {
+  const contentType = route.leaf.http?.successContentType ?? "application/json";
+  const media: Record<string, unknown> = {};
+  const method = route.method;
+
+  if (contentType.includes("application/json")) {
+    const outputSchema = route.leaf.outputSchema ?? { type: "object" };
+    media[contentType] = {
+      schema: dereferenceJsonSchema(outputSchema),
+    };
+  } else if (contentType.includes("text/html")) {
+    media[contentType] = { schema: { type: "string" } };
+  } else {
+    media[contentType] = { schema: { type: "string", format: "binary" } };
+  }
+
+  const status = String(route.leaf.http?.successStatus ?? defaultSuccessStatus(method, method !== "DELETE"));
+  if (method === "DELETE" && status === "204") {
+    return {
+      "204": { description: "Successful invocation" },
+    };
+  }
+  return {
+    [status]: {
+      description: "Successful invocation",
+      content: media,
+    },
+  };
+}
+
+function methodLower(method: CliHttpMethod): string {
+  return method.toLowerCase();
+}
+
+const HEALTH_TAG = "health";
+
+const livenessResponseSchema = {
+  type: "object",
+  properties: { ok: { type: "boolean", const: true } },
+  required: ["ok"],
+} as const;
+
+const readinessCheckSchema = {
+  type: "object",
+  properties: {
+    ok: { type: "boolean" },
+    error: { type: "string" },
+    missing: { type: "array", items: { type: "string" } },
+  },
+  required: ["ok"],
+} as const;
+
+const readinessResponseSchema = {
+  type: "object",
+  properties: {
+    ok: { type: "boolean" },
+    checks: {
+      type: "object",
+      properties: {
+        config_file: readinessCheckSchema,
+        config_required: readinessCheckSchema,
+        custom: readinessCheckSchema,
+      },
+      required: ["config_file", "config_required", "custom"],
+    },
+  },
+  required: ["ok", "checks"],
+} as const;
+
+function jsonResponseEntry(description: string, schema: Record<string, unknown>): Record<string, unknown> {
+  return {
+    description,
+    content: {
+      [JSON_CONTENT_TYPE]: { schema },
+    },
+  };
+}
+
+function livenessGetOp(operationId: string, summary: string): Record<string, unknown> {
+  return {
+    tags: [HEALTH_TAG],
+    operationId,
+    summary,
+    responses: {
+      "200": jsonResponseEntry("Server is listening", livenessResponseSchema),
+    },
+  };
+}
+
+/** Framework health probe paths served alongside `/api/*` routes. */
+function buildHealthPaths(): Record<string, unknown> {
+  return {
+    "/health": {
+      get: livenessGetOp("health", "Liveness probe (alias of /health/live)"),
+    },
+    "/health/live": {
+      get: livenessGetOp("health_live", "Liveness probe"),
+    },
+    "/health/ready": {
+      get: {
+        tags: [HEALTH_TAG],
+        operationId: "health_ready",
+        summary: "Readiness probe",
+        description: "Config file, required app config, and optional program.readiness checks.",
+        responses: {
+          "200": jsonResponseEntry("Ready to serve traffic", readinessResponseSchema),
+          "503": jsonResponseEntry("Not ready", readinessResponseSchema),
+        },
+      },
+    },
+  };
+}
+
+type HttpRoute = ReturnType<typeof collectHttpRoutes>[number];
+
+/** Top-level command key for OpenAPI grouping (first non-`:param` segment). */
+function topLevelCommandKey(route: HttpRoute, program: CliProgram): string {
+  const key = route.commandPath.find((k) => !k.startsWith(":"));
+  return key ?? program.key;
+}
+
+function findTopLevelCommand(program: CliProgram, key: string): CliNode | undefined {
+  if (isCliLeaf(program)) {
+    return program.key === key ? program : undefined;
+  }
+  return program.commands.find((c) => c.key === key);
+}
+
+/** OpenAPI tags for user `/api/*` routes, one per top-level command. */
+function collectCommandTags(program: CliProgram, routes: HttpRoute[]): { name: string; description?: string }[] {
+  const names = [...new Set(routes.map((route) => topLevelCommandKey(route, program)))].sort();
+  return names.map((name) => {
+    const node = findTopLevelCommand(program, name);
+    return node?.description ? { name, description: node.description } : { name };
+  });
+}
+
+/** Generates an OpenAPI 3.1 document for the program's HTTP routes. */
+export function generateOpenApi(program: CliProgram): Record<string, unknown> {
+  const routes = collectHttpRoutes(program);
+  const paths: Record<string, unknown> = program.httpServer?.enabled ? buildHealthPaths() : {};
+  const commandTags = collectCommandTags(program, routes);
+
+  for (const route of routes) {
+    const pathKey = route.openApiPath;
+    const existing = (paths[pathKey] as Record<string, unknown> | undefined) ?? {};
+    const op: Record<string, unknown> = {
+      tags: [topLevelCommandKey(route, program)],
+      operationId: route.openApiPath.replace(/\//g, "_").replace(/[{}]/g, ""),
+      summary: route.leaf.description ?? route.leaf.key,
+      responses: {
+        ...buildSuccessResponses(route),
+        "400": errorResponseEntry(program, "Invalid arguments or help requested"),
+        "404": errorResponseEntry(program, "Not found"),
+        "500": errorResponseEntry(program, "Handler error"),
+        "503": errorResponseEntry(program, "Not ready or missing required config"),
+      },
+    };
+
+    if (route.paramNames.length > 0) {
+      op.parameters = route.paramNames.map((name) => ({
+        name,
+        in: "path",
+        required: true,
+        schema: { type: "string" },
+      }));
+    }
+
+    const method = methodLower(route.method);
+    if (method === "get" || method === "delete") {
+      op.parameters = [
+        ...((op.parameters as unknown[]) ?? []),
+        ...collectOptionDefs(
+          program,
+          route.commandPath.filter((k) => !k.startsWith(":")),
+        ).map((opt) => ({
+          name: opt.name,
+          in: "query",
+          required: opt.required ?? false,
+          schema: { type: "string" },
+          description: opt.description,
+        })),
+      ];
+    } else {
+      op.requestBody = {
+        required: isJsonLeaf(route.leaf),
+        content: {
+          [JSON_CONTENT_TYPE]: {
+            schema: dereferenceJsonSchema(buildInputSchema(program, route)),
+          },
+        },
+      };
+    }
+
+    existing[method] = op;
+    paths[pathKey] = existing;
+  }
+
+  return {
+    openapi: "3.1.0",
+    info: {
+      title: program.key,
+      version: program.version,
+      description: program.description,
+    },
+    ...(program.httpServer?.enabled
+      ? { tags: [{ name: HEALTH_TAG, description: "Server health probes" }, ...commandTags] }
+      : {}),
+    paths,
+  };
+}
+
+/** Pretty-printed OpenAPI JSON (same document as `GET /openapi.json`). */
+export function openApiJson(program: CliProgram): string {
+  return `${JSON.stringify(generateOpenApi(program), null, 2)}\n`;
+}