@ontrails/trails 1.0.0-beta.4 → 1.0.0-beta.41

package/src/retired-topo-command.ts

@@ -0,0 +1,36 @@
+const retiredTopoCommandReplacements = {
+  check: 'trails validate',
+  compile: 'trails compile',
+  verify: 'trails validate',
+} as const;
+
+export type RetiredTopoCommand = keyof typeof retiredTopoCommandReplacements;
+
+export interface RetiredTopoCommandDiagnostic {
+  readonly attempted: `trails topo ${RetiredTopoCommand}`;
+  readonly message: string;
+  readonly replacement: (typeof retiredTopoCommandReplacements)[RetiredTopoCommand];
+}
+
+const isRetiredTopoCommand = (
+  command: string | undefined
+): command is RetiredTopoCommand =>
+  command !== undefined && command in retiredTopoCommandReplacements;
+
+export const getRetiredTopoCommandDiagnostic = (
+  argv: readonly string[]
+): RetiredTopoCommandDiagnostic | null => {
+  const [command, subcommand] = argv.slice(2);
+  if (command !== 'topo' || !isRetiredTopoCommand(subcommand)) {
+    return null;
+  }
+
+  const replacement = retiredTopoCommandReplacements[subcommand];
+  const attempted = `trails topo ${subcommand}` as const;
+
+  return {
+    attempted,
+    message: `"${attempted}" was retired. Use "${replacement}" instead.\nTopography artifact commands now live at the top level: "trails compile", "trails validate", and "trails diff". "trails topo" is for topo-store history, pin, and unpin.`,
+    replacement,
+  };
+};

package/src/run-adapter-check.ts

@@ -0,0 +1,76 @@
+import type { ActionResultContext } from '@ontrails/cli';
+import { deriveOutputMode } from '@ontrails/cli';
+
+interface AdapterCheckResultValue {
+  readonly formatted: string;
+  readonly passed: boolean;
+}
+
+const isAdapterCheckResultValue = (
+  value: unknown
+): value is AdapterCheckResultValue => {
+  if (typeof value !== 'object' || value === null) {
+    return false;
+  }
+  const candidate = value as Record<string, unknown>;
+  return (
+    typeof candidate['formatted'] === 'string' &&
+    typeof candidate['passed'] === 'boolean'
+  );
+};
+
+const wantsStructuredOutput = (ctx: ActionResultContext): boolean =>
+  deriveOutputMode(ctx.flags, ctx.topoName).mode !== 'text';
+
+const isAdapterCheckTrail = (ctx: ActionResultContext): boolean =>
+  ctx.trail.id === 'adapter.check';
+
+const readAdapterCheckResultValue = (
+  ctx: ActionResultContext
+): AdapterCheckResultValue | undefined => {
+  if (!isAdapterCheckTrail(ctx) || ctx.result.isErr()) {
+    return undefined;
+  }
+
+  return isAdapterCheckResultValue(ctx.result.value)
+    ? ctx.result.value
+    : undefined;
+};
+
+export const applyAdapterCheckExitCode = (
+  ctx: ActionResultContext
+): boolean => {
+  if (!isAdapterCheckTrail(ctx)) {
+    return false;
+  }
+
+  if (ctx.result.isErr()) {
+    process.exitCode = 1;
+    return true;
+  }
+
+  const value = readAdapterCheckResultValue(ctx);
+  if (!value) {
+    return false;
+  }
+
+  process.exitCode = value.passed ? 0 : 1;
+  return true;
+};
+
+export const tryAdapterCheckOutput = (ctx: ActionResultContext): boolean => {
+  const value = readAdapterCheckResultValue(ctx);
+  if (!value) {
+    return false;
+  }
+
+  applyAdapterCheckExitCode(ctx);
+  if (wantsStructuredOutput(ctx)) {
+    return false;
+  }
+
+  if (value.formatted.length > 0) {
+    process.stdout.write(`${value.formatted}\n`);
+  }
+  return true;
+};

package/src/run-collision.ts

@@ -0,0 +1,126 @@
+/**
+ * CLI-surface bridge for the `run` trail's collision UX.
+ *
+ * The `run` trail is surface-agnostic: when a trail id collides across two or
+ * more workspace apps and no `--app` override is provided, the trail returns
+ * `Result.err(AmbiguousError)` with the candidate app names in `error.context`.
+ *
+ * The CLI surface decides whether to prompt the user (TTY) or surface the
+ * error verbatim (non-TTY). This module owns that surface decision so the
+ * trail itself never reads `process.stdin.isTTY` or imports a prompt library.
+ */
+
+import type { ActionResultContext } from '@ontrails/cli';
+import { AmbiguousError, executeTrail, isPlainObject } from '@ontrails/core';
+import type { Result, Topo } from '@ontrails/core';
+import * as clack from '@clack/prompts';
+
+/** Runtime dependencies the wrapper resolves through; injectable for tests. */
+export interface RunCollisionDeps {
+  readonly graph: Topo;
+  readonly isTTY?: () => boolean;
+  readonly promptForApp?: (
+    candidates: readonly string[],
+    trailId: string
+  ) => Promise<string | undefined>;
+}
+
+const defaultIsTTY = (): boolean => process.stdin.isTTY === true;
+
+const defaultPromptForApp = async (
+  candidates: readonly string[],
+  trailId: string
+): Promise<string | undefined> => {
+  const choice = await clack.select({
+    message: `Trail ID '${trailId}' is exposed by multiple apps. Choose one:`,
+    options: candidates.map((appName) => ({
+      label: appName,
+      value: appName,
+    })),
+  });
+  return clack.isCancel(choice) ? undefined : (choice as string);
+};
+
+const isAmbiguousCollision = (
+  ctx: ActionResultContext
+): ctx is ActionResultContext & {
+  readonly result: { readonly error: AmbiguousError };
+} =>
+  ctx.trail.id === 'run' &&
+  ctx.result.isErr() &&
+  ctx.result.error instanceof AmbiguousError;
+
+const readCandidates = (error: AmbiguousError): readonly string[] => {
+  const ctx = error.context;
+  if (!isPlainObject(ctx)) {
+    return [];
+  }
+  const raw = ctx['candidates'];
+  if (!Array.isArray(raw)) {
+    return [];
+  }
+  return raw.filter((entry): entry is string => typeof entry === 'string');
+};
+
+const readTrailId = (error: AmbiguousError): string | undefined => {
+  const ctx = error.context;
+  if (!isPlainObject(ctx)) {
+    return;
+  }
+  const raw = ctx['trailId'];
+  return typeof raw === 'string' ? raw : undefined;
+};
+
+const hasAppOverride = (input: unknown): boolean =>
+  isPlainObject(input) && typeof input['app'] === 'string';
+
+const mergeAppOverride = (
+  input: unknown,
+  app: string
+): Record<string, unknown> => ({
+  ...(isPlainObject(input) ? input : {}),
+  app,
+});
+
+/**
+ * Try to recover from an ambiguous-trail-id collision on the run trail.
+ *
+ * Returns the re-execution result when a TTY prompt yielded a chosen app, or
+ * `undefined` when there is nothing to recover (non-TTY, non-collision, or the
+ * user cancelled). The caller forwards `undefined` to the default result
+ * handler, which surfaces the error verbatim and maps it to exit code 1.
+ */
+export const tryRecoverFromRunCollision = async (
+  ctx: ActionResultContext,
+  deps: RunCollisionDeps
+): Promise<Result<unknown, Error> | undefined> => {
+  if (!isAmbiguousCollision(ctx)) {
+    return;
+  }
+  if (hasAppOverride(ctx.input)) {
+    return;
+  }
+
+  const isTTY = deps.isTTY ?? defaultIsTTY;
+  if (!isTTY()) {
+    return;
+  }
+
+  const { error } = ctx.result;
+  const candidates = readCandidates(error);
+  const trailId = readTrailId(error);
+  if (candidates.length === 0 || trailId === undefined) {
+    return;
+  }
+
+  const promptForApp = deps.promptForApp ?? defaultPromptForApp;
+  const chosen = await promptForApp(candidates, trailId);
+  if (chosen === undefined) {
+    return;
+  }
+
+  return await executeTrail(ctx.trail, mergeAppOverride(ctx.input, chosen), {
+    ctx: ctx.permit === undefined ? {} : { permit: ctx.permit },
+    topo: deps.graph,
+  });
+};

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 shellResult;
+  }
+
+  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 scriptResult;
+  }
+
+  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;
+};