@ontrails/trails 1.0.0-beta.14 → 1.0.0-beta.16

package/src/run-completions-install.ts

@@ -0,0 +1,179 @@
+/**
+ * CLI bridge for installing shell completion scripts.
+ *
+ * This is intentionally not a trail: it resolves CLI-local defaults such as
+ * `$SHELL` and the user's home directory, then writes to the user's completion
+ * directory. The surface-agnostic trail remains `completions`, which renders a
+ * script string for any caller.
+ */
+
+import { mkdir } from 'node:fs/promises';
+import { homedir } from 'node:os';
+import { dirname, join } from 'node:path';
+
+import {
+  projectPublicSurfaceError,
+  Result,
+  ValidationError,
+} from '@ontrails/core';
+import type { Command } from 'commander';
+
+import { renderCompletionScript } from './completions.js';
+import type { CompletionShell } from './completions.js';
+
+export const COMPLETIONS_BIN_NAME = 'trails';
+
+const SHELLS = new Set<CompletionShell>(['bash', 'fish', 'zsh']);
+
+const INSTALL_PATH_BY_SHELL: Readonly<Record<CompletionShell, string>> = {
+  bash: '.local/share/bash-completion/completions/trails',
+  fish: '.config/fish/completions/trails.fish',
+  zsh: '.local/share/zsh/site-functions/_trails',
+};
+
+export interface CompletionsInstallOptions {
+  readonly binName?: string | undefined;
+  readonly homeDir?: string | undefined;
+  readonly shell?: string | undefined;
+  readonly shellEnv?: string | undefined;
+}
+
+export interface CompletionsInstallResult {
+  readonly created: boolean;
+  readonly message: string;
+  readonly path: string;
+  readonly shell: CompletionShell;
+}
+
+interface StdoutLike {
+  write(chunk: string): unknown;
+}
+
+export interface AttachCompletionsInstallOptions {
+  readonly binName?: string | undefined;
+  readonly homeDir?: string | undefined;
+  readonly shellEnv?: string | undefined;
+  readonly stdout?: StdoutLike | undefined;
+}
+
+const isCompletionShell = (value: string): value is CompletionShell =>
+  SHELLS.has(value as CompletionShell);
+
+const detectShellFromEnv = (shellEnv: string): CompletionShell | null => {
+  if (shellEnv.length === 0) {
+    return null;
+  }
+  const slashIndex = shellEnv.lastIndexOf('/');
+  const base = slashIndex === -1 ? shellEnv : shellEnv.slice(slashIndex + 1);
+  return isCompletionShell(base) ? base : null;
+};
+
+const unsupportedShellMessage =
+  'Could not detect shell from $SHELL. Pass --shell with one of: bash, zsh, fish.';
+
+const resolveTargetShell = (input: {
+  readonly shell?: string | undefined;
+  readonly shellEnv?: string | undefined;
+}): Result<CompletionShell, ValidationError> => {
+  if (input.shell !== undefined) {
+    if (isCompletionShell(input.shell)) {
+      return Result.ok(input.shell);
+    }
+    return Result.err(
+      new ValidationError(
+        `Unsupported shell "${input.shell}". Pass one of: bash, zsh, fish.`
+      )
+    );
+  }
+  const envValue = input.shellEnv ?? process.env['SHELL'] ?? '';
+  const detected = detectShellFromEnv(envValue);
+  return detected === null
+    ? Result.err(new ValidationError(unsupportedShellMessage))
+    : Result.ok(detected);
+};
+
+const fileExists = async (path: string): Promise<boolean> =>
+  await Bun.file(path).exists();
+
+export const runCompletionsInstall = async (
+  options: CompletionsInstallOptions = {}
+): Promise<Result<CompletionsInstallResult, Error>> => {
+  const shellResult = resolveTargetShell(options);
+  if (shellResult.isErr()) {
+    return Result.err(shellResult.error);
+  }
+
+  const shell = shellResult.value;
+  const home = options.homeDir ?? homedir();
+  const path = join(home, INSTALL_PATH_BY_SHELL[shell]);
+  const scriptResult = renderCompletionScript(
+    shell,
+    options.binName ?? COMPLETIONS_BIN_NAME
+  );
+  if (scriptResult.isErr()) {
+    return Result.err(scriptResult.error);
+  }
+
+  let existed: boolean;
+  try {
+    existed = await fileExists(path);
+    await mkdir(dirname(path), { recursive: true });
+    await Bun.write(path, scriptResult.value);
+  } catch (error) {
+    return Result.err(
+      error instanceof Error ? error : new Error(String(error))
+    );
+  }
+  const created = !existed;
+
+  return Result.ok({
+    created,
+    message: created
+      ? `Installed ${shell} completions to ${path}. Run \`exec $SHELL\` or restart your shell to activate.`
+      : `Updated ${shell} completions at ${path}.`,
+    path,
+    shell,
+  });
+};
+
+const handleCliError = (error: unknown): void => {
+  const err = error instanceof Error ? error : new Error(String(error));
+  const projection = projectPublicSurfaceError('cli', err);
+  process.stderr.write(`Error: ${projection.message}\n`);
+  process.exit(projection.code);
+};
+
+const findCompletionsCommand = (program: Command): Command | undefined =>
+  program.commands.find((command) => command.name() === 'completions');
+
+export const attachCompletionsInstallCommand = (
+  program: Command,
+  options: AttachCompletionsInstallOptions = {}
+): void => {
+  const completionsCommand =
+    findCompletionsCommand(program) ??
+    program
+      .command('completions')
+      .description('Render and install shell completion scripts');
+
+  completionsCommand
+    .command('install')
+    .description('Install a shell completion script for the trails CLI')
+    .option(
+      '-s, --shell <shell>',
+      'Target shell; auto-detected from $SHELL when omitted.'
+    )
+    .action(async (flags: { readonly shell?: string | undefined }) => {
+      const result = await runCompletionsInstall({
+        binName: options.binName,
+        homeDir: options.homeDir,
+        shell: flags.shell,
+        shellEnv: options.shellEnv,
+      });
+      if (result.isErr()) {
+        handleCliError(result.error);
+        return;
+      }
+      (options.stdout ?? process.stdout).write(`${result.value.message}\n`);
+    });
+};

package/src/run-example.ts

@@ -0,0 +1,149 @@
+/**
+ * CLI-surface bridge for the `run.example` trail.
+ *
+ * `run.example` resolves the named example on the target trail, executes it
+ * through the full pipeline, and packages an actual-vs-expected comparison
+ * into a structured envelope on the trail's outer `Result.ok(...)`. This module
+ * owns the surface decision of how to render that envelope:
+ *
+ * - Text mode (default): a compact summary on match, an `input / expected /
+ *   actual / diff` block on mismatch.
+ * - JSON / JSONL: emits the full {@link RunExampleComparison} envelope so
+ *   downstream consumers can parse the comparison shape directly.
+ *
+ * Match/mismatch is a comparison outcome, not an execution error: the trail
+ * always returns `Result.ok(envelope)`. This helper maps mismatch onto a
+ * non-zero exit code by throwing a `ValidationError` (category `validation`,
+ * exit 1) so Commander's error path runs.
+ *
+ * Outer Err on the run trail (NotFound, Ambiguous, Validation) is unaffected
+ * by `run.example`: this helper defers to the default handler so existing
+ * exit-code mapping and recovery hooks stay intact.
+ */
+
+import type { ActionResultContext } from '@ontrails/cli';
+import { deriveOutputMode, output } from '@ontrails/cli';
+import { ValidationError } from '@ontrails/core';
+
+import { runExampleComparisonSchema } from './trails/run-example.js';
+import type { RunExampleComparison } from './trails/run-example.js';
+
+// ---------------------------------------------------------------------------
+// Detection
+// ---------------------------------------------------------------------------
+
+const isExampleRunCtx = (ctx: ActionResultContext): boolean =>
+  ctx.trail.id === 'run.example';
+
+// ---------------------------------------------------------------------------
+// Text formatting
+// ---------------------------------------------------------------------------
+
+const formatJson = (value: unknown): string => {
+  try {
+    const encoded = JSON.stringify(value, null, 2);
+    return encoded === undefined ? String(value) : encoded;
+  } catch {
+    return String(value);
+  }
+};
+
+const formatMatchText = (envelope: RunExampleComparison): string =>
+  [
+    `OK  ${envelope.trailId} :: ${envelope.exampleName}`,
+    `mode: ${envelope.mode}`,
+    'actual matches expected.',
+  ].join('\n');
+
+const formatMismatchText = (envelope: RunExampleComparison): string => {
+  const diffBlock =
+    envelope.diff !== undefined && envelope.diff.length > 0
+      ? envelope.diff.map((line) => `  - ${line}`).join('\n')
+      : '  - <no diff lines>';
+
+  return [
+    `MISMATCH  ${envelope.trailId} :: ${envelope.exampleName}`,
+    `mode: ${envelope.mode}`,
+    'input:',
+    formatJson(envelope.input),
+    'expected:',
+    formatJson(envelope.expected),
+    'actual:',
+    formatJson(envelope.actual),
+    'diff:',
+    diffBlock,
+  ].join('\n');
+};
+
+// ---------------------------------------------------------------------------
+// Entry point
+// ---------------------------------------------------------------------------
+
+/**
+ * Return value:
+ * - `false` — `run.example` did not apply; caller should fall through to its
+ *   default handler.
+ * - `true` — `run.example` handled the result and wrote output. Caller should
+ *   not invoke the default handler.
+ *
+ * Throws a {@link ValidationError} on mismatch so Commander's error path runs
+ * and the run trail surface exits with the validation category exit code.
+ */
+export const tryExampleRunOutput = (ctx: ActionResultContext): boolean => {
+  if (!isExampleRunCtx(ctx)) {
+    return false;
+  }
+
+  // Outer Err on the run.example trail (NotFound, Ambiguous, Validation) is not
+  // in scope here: defer to the default handler so existing
+  // exit-code mapping and recovery hooks stay intact.
+  if (ctx.result.isErr()) {
+    return false;
+  }
+
+  const envelope = runExampleComparisonSchema.safeParse(ctx.result.value);
+  if (!envelope.success) {
+    // Defensive fallback: the trail owns the output schema, so this branch is
+    // unreachable in practice. Defer to the default handler if anything else
+    // slips through.
+    return false;
+  }
+  const comparison = envelope.data;
+
+  const { mode } = deriveOutputMode(ctx.flags, ctx.topoName);
+
+  if (mode === 'text') {
+    if (comparison.match) {
+      output(formatMatchText(comparison), mode);
+      return true;
+    }
+    process.stderr.write(`${formatMismatchText(comparison)}\n`);
+    throw new ValidationError(
+      `Example '${comparison.exampleName}' on trail '${comparison.trailId}' did not match expected outcome.`,
+      {
+        context: {
+          exampleName: comparison.exampleName,
+          mode: comparison.mode,
+          trailId: comparison.trailId,
+        },
+      }
+    );
+  }
+
+  // JSON / JSONL: emit the full envelope so downstream consumers can parse
+  // the comparison shape directly.
+  output(comparison, mode);
+  if (!comparison.match) {
+    throw new ValidationError(
+      `Example '${comparison.exampleName}' on trail '${comparison.trailId}' did not match expected outcome.`,
+      {
+        context: {
+          exampleName: comparison.exampleName,
+          mode: comparison.mode,
+          trailId: comparison.trailId,
+        },
+      }
+    );
+  }
+  return true;
+};

package/src/run-examples.ts

@@ -0,0 +1,148 @@
+/**
+ * CLI-surface bridge for the `run.examples` trail.
+ *
+ * `run.examples` is a pure metadata read: the trail returns a
+ * {@link RunExamplesListing} on its outer Ok value.
+ * This module owns the surface decision of how to render that listing:
+ *
+ * - Text mode (default): a table-like list with `name`, truncated `input`,
+ *   and outcome (`ok` / `error: <code>`). Empty listings print
+ *   `No examples defined`.
+ * - JSON / JSONL: the structured `examples` array is emitted directly via
+ *   the resolved output mode, so agents and downstream consumers can parse
+ *   the full structured shape (`name`, `input`, `expected`, `expectedMatch`,
+ *   `error`, `signals`, `kind`, `provenance`).
+ *
+ * Errors at the outer layer (NotFoundError, AmbiguousError, ValidationError)
+ * are unaffected by `run.examples`: we always defer to the supplied default
+ * handler so the existing exit-code mapping and recovery hooks stay intact.
+ */
+
+import type { ActionResultContext } from '@ontrails/cli';
+import { deriveOutputMode, output } from '@ontrails/cli';
+import type { StructuredTrailExample } from '@ontrails/core';
+
+import { runExamplesListingSchema } from './trails/run-examples.js';
+import type { RunExamplesListing } from './trails/run-examples.js';
+
+// ---------------------------------------------------------------------------
+// Detection
+// ---------------------------------------------------------------------------
+
+const isExamplesRunCtx = (ctx: ActionResultContext): boolean =>
+  ctx.trail.id === 'run.examples';
+
+// ---------------------------------------------------------------------------
+// Text formatting
+// ---------------------------------------------------------------------------
+
+const INPUT_PREVIEW_LIMIT = 60;
+
+const truncate = (value: string, limit: number): string =>
+  value.length <= limit ? value : `${value.slice(0, limit - 1)}…`;
+
+const formatInputPreview = (input: unknown): string => {
+  if (input === undefined) {
+    return '';
+  }
+  let encoded: string;
+  try {
+    encoded = JSON.stringify(input) ?? '';
+  } catch {
+    encoded = String(input);
+  }
+  return truncate(encoded, INPUT_PREVIEW_LIMIT);
+};
+
+const formatOutcome = (example: StructuredTrailExample): string => {
+  if (example.kind === 'error') {
+    const code = example.error;
+    return code === undefined || code.length === 0 ? 'error' : `error: ${code}`;
+  }
+  return 'ok';
+};
+
+interface ExampleRow {
+  readonly name: string;
+  readonly input: string;
+  readonly outcome: string;
+}
+
+const buildRows = (
+  examples: readonly StructuredTrailExample[]
+): readonly ExampleRow[] =>
+  examples.map((example) => ({
+    input: formatInputPreview(example.input),
+    name: example.name,
+    outcome: formatOutcome(example),
+  }));
+
+const padRight = (value: string, width: number): string =>
+  value.length >= width ? value : value + ' '.repeat(width - value.length);
+
+const formatTable = (rows: readonly ExampleRow[]): string => {
+  const headers = { input: 'INPUT', name: 'NAME', outcome: 'OUTCOME' };
+  const allRows: readonly ExampleRow[] = [headers, ...rows];
+
+  const widths = {
+    input: Math.max(...allRows.map((row) => row.input.length)),
+    name: Math.max(...allRows.map((row) => row.name.length)),
+    outcome: Math.max(...allRows.map((row) => row.outcome.length)),
+  };
+
+  const formatRow = (row: ExampleRow): string =>
+    `${padRight(row.name, widths.name)}  ${padRight(row.input, widths.input)}  ${row.outcome}`;
+
+  return allRows.map(formatRow).join('\n');
+};
+
+const formatTextListing = (listing: RunExamplesListing): string => {
+  if (listing.examples.length === 0) {
+    return 'No examples defined';
+  }
+  return formatTable(buildRows(listing.examples));
+};
+
+// ---------------------------------------------------------------------------
+// Entry point
+// ---------------------------------------------------------------------------
+
+/**
+ * Return value:
+ * - `false` — `run.examples` did not apply; caller should fall through to its
+ *   default handler.
+ * - `true` — `run.examples` handled the result and wrote output. Caller should
+ *   not invoke the default handler.
+ */
+export const tryExamplesRunOutput = (ctx: ActionResultContext): boolean => {
+  if (!isExamplesRunCtx(ctx)) {
+    return false;
+  }
+
+  // Outer Err on `run.examples` (NotFound, Ambiguous, Validation) is not in
+  // scope for this renderer: defer to the default handler so existing
+  // exit-code mapping and recovery hooks stay intact.
+  if (ctx.result.isErr()) {
+    return false;
+  }
+
+  const listing = runExamplesListingSchema.safeParse(ctx.result.value);
+  if (!listing.success) {
+    // Defensive fallback: the trail owns the output schema, so this branch is
+    // unreachable in practice. Defer to the default handler if anything else
+    // slips through.
+    return false;
+  }
+
+  const { mode } = deriveOutputMode(ctx.flags, ctx.topoName);
+
+  if (mode === 'text') {
+    output(formatTextListing(listing.data), mode);
+    return true;
+  }
+
+  // JSON / JSONL: emit the structured examples array directly so downstream
+  // consumers can parse the full structured shape per example.
+  output(listing.data.examples, mode);
+  return true;
+};

package/src/run-quiet.ts

@@ -0,0 +1,75 @@
+/**
+ * CLI-surface bridge for the `run` trail's `--quiet` flag.
+ *
+ * The `run` trail returns an `inner-trail-result` envelope as the `value` of
+ * its own outer `Result.ok(...)`. The default CLI on-result handler unwraps
+ * once, leaving stdout as `{ "kind": "inner-trail-result", "trailId": "...",
+ * "value": ... }` — useful when a caller wants provenance, but noisy when the
+ * caller only wants the inner value to feed downstream pipes.
+ *
+ * `--quiet` strips that envelope:
+ *
+ * - Inner result envelope → write the inner value to stdout via the resolved
+ *   output mode.
+ *
+ * Errors at the outer layer (the run trail itself failing — `NotFoundError`,
+ * `AmbiguousError`, `ValidationError` from input) are unaffected by `--quiet`:
+ * we always defer to the supplied default handler so collision-recovery and
+ * the existing error surface stay intact.
+ */
+
+import type { ActionResultContext } from '@ontrails/cli';
+import { deriveOutputMode, output } from '@ontrails/cli';
+
+import { INNER_TRAIL_RESULT_KIND } from './trails/run.js';
+
+interface InnerTrailResultEnvelope {
+  readonly kind: typeof INNER_TRAIL_RESULT_KIND;
+  readonly trailId: string;
+  readonly value: unknown;
+}
+
+const isInnerTrailResultEnvelope = (
+  value: unknown
+): value is InnerTrailResultEnvelope =>
+  typeof value === 'object' &&
+  value !== null &&
+  (value as { readonly kind?: unknown }).kind === INNER_TRAIL_RESULT_KIND &&
+  typeof (value as { readonly trailId?: unknown }).trailId === 'string' &&
+  'value' in value;
+
+const isQuietRunCtx = (ctx: ActionResultContext): boolean =>
+  ctx.trail.id === 'run' && ctx.flags['quiet'] === true;
+
+/**
+ * Return value:
+ * - `false` — `--quiet` did not apply; caller should fall through to its
+ *   default handler.
+ * - `true` — `--quiet` handled the result and wrote output. Caller should not
+ *   invoke the default handler.
+ *
+ */
+export const tryQuietRunOutput = async (
+  ctx: ActionResultContext
+): Promise<boolean> => {
+  if (!isQuietRunCtx(ctx)) {
+    return false;
+  }
+
+  // Outer Err on the run trail (collision, not-found, validation) is not in
+  // scope for --quiet: defer to the default handler so existing exit-code
+  // mapping and recovery hooks stay intact.
+  if (ctx.result.isErr()) {
+    return false;
+  }
+
+  const inner: unknown = ctx.result.value;
+  if (!isInnerTrailResultEnvelope(inner)) {
+    return false;
+  }
+
+  const { mode } = deriveOutputMode(ctx.flags, ctx.topoName);
+  const value = inner.value === undefined ? null : inner.value;
+  output(value, mode);
+  return true;
+};