omp-conductor 0.16.2 → 0.17.0

package/src/ui/progress.ts

@@ -0,0 +1,32 @@
+/** Whether the CLI owns an interactive terminal rather than a pipe or plain-UI session. */
+export function interactiveUi(): boolean {
+  return Boolean(
+    process.stdin.isTTY &&
+      process.stdout.isTTY &&
+      !process.env.OMP_CONDUCTOR_PLAIN_UI,
+  );
+}
+
+/** Run one long, silent operation with safe Clack progress on an interactive TTY. */
+export async function withProgress<T>(
+  message: string,
+  success: string,
+  operation: () => Promise<T>,
+  options: { plainMessage?: boolean } = {},
+): Promise<T> {
+  if (!interactiveUi()) {
+    if (options.plainMessage) process.stdout.write(`${message}\n`);
+    return operation();
+  }
+
+  const { log } = await import("@clack/prompts");
+  log.step(message);
+  try {
+    const result = await operation();
+    log.success(success);
+    return result;
+  } catch (err) {
+    log.error(`${message} failed`);
+    throw err;
+  }
+}

package/src/ui/style.ts

@@ -0,0 +1,11 @@
+import { styleText } from "node:util";
+
+function styled(format: Parameters<typeof styleText>[0], text: string): string {
+  return process.stdout.isTTY ? styleText(format, text) : text;
+}
+
+export const heading = (text: string): string => styled(["bold", "cyan"], text);
+export const ok = (text: string): string => styled("green", text);
+export const warn = (text: string): string => styled("yellow", text);
+export const fail = (text: string): string => styled("red", text);
+export const dim = (text: string): string => styled("dim", text);

package/src/wizard-ui.ts

@@ -24,6 +24,15 @@
  * (`Cancelled`). The terminal UI guarantees the readline interface is closed on
  * every exit path so the verb cannot hang the terminal.
  */
+export interface PromptOptions {
+  /** Stable answer-file key. This is a permanent CLI API, not display copy. */
+  key: string;
+}
+
+export interface SelectOptions extends PromptOptions {
+  initialIndex?: number;
+}
+
 export interface WizardUi {
   notify(message: string, type?: "info" | "warning" | "error"): void;
   /**
@@ -32,17 +41,17 @@ export interface WizardUi {
    * `Cancelled` and abandons the run. Collapsing the two is how Ctrl-C at a
    * confirm used to record a silent "no" and carry on to the next question.
    */
-  confirm(title: string, message: string): Promise<boolean | undefined>;
+  confirm(title: string, message: string, promptOptions: PromptOptions): Promise<boolean | undefined>;
   /** Single-line text prompt. `undefined` dismisses it; an empty submit accepts
    *  the placeholder. */
-  input(title: string, placeholder?: string): Promise<string | undefined>;
+  input(title: string, placeholder: string | undefined, promptOptions: PromptOptions): Promise<string | undefined>;
   /** Single-choice list. On an interactive TTY the current option is rendered
    *  inline and moved with ↑/↓ or j/k; on a pipe it stays the numbered wall.
    *  Resolves the chosen option's label, or `undefined` when dismissed. */
   select(
     title: string,
     options: { label: string; description?: string }[],
-    dialogOptions?: { initialIndex?: number },
+    dialogOptions: SelectOptions,
   ): Promise<string | undefined>;
 }
 
@@ -83,8 +92,8 @@ import type { Readable, Writable } from "node:stream";
  * rather than only through a spawned CLI; production callers pass nothing.
  */
 export interface TerminalUi extends WizardUi {
-  /** Releases stdin. Idempotent; call it from a `finally`. */
-  close(): void;
+  /** Releases stdin; interactive drivers may render the outcome message. Idempotent. */
+  close(message?: string): void;
 }
 
 export function terminalUi(io: { input?: Readable; output?: Writable } = {}): TerminalUi {