/**
 * One thing the doctor looked at. A problem carries the fix as a sentence and,
 * where one exists, the exact command — so a later `--fix` can run it and an
 * agent reading `--json` can propose it.
 */

export type Severity = "fail" | "warn" | "optional" | "ok";

/** `external`: the command belongs to another tool, so PAL leaves running it to you. */
export type Fix =
  | { say: string; command?: undefined }
  | { say: string; command: string; external: boolean };

export type Group = "Environment" | "Agents" | "Inference" | "State";

export interface Finding {
  id: string;
  severity: Severity;
  title: string;
  fix?: Fix;
  group?: Group;
  /** The few words a passing check takes up when its agent's checks share one line. */
  brief?: string;
}

export function passed(id: string, title: string, brief?: string): Finding {
  return brief ? { id, severity: "ok", title, brief } : { id, severity: "ok", title };
}

export function failing(id: string, title: string, fix?: Fix): Finding {
  return { id, severity: "fail", title, fix };
}

export function warning(id: string, title: string, fix?: Fix): Finding {
  return { id, severity: "warn", title, fix };
}

export function optional(id: string, title: string, fix: Fix): Finding {
  return { id, severity: "optional", title, fix };
}