@cueloop/client 0.1.0-alpha.19 → 0.1.0-alpha.20

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@cueloop/client",
-  "version": "0.1.0-alpha.19",
+  "version": "0.1.0-alpha.20",
   "license": "Apache-2.0",
   "type": "module",
   "exports": {
     ".": "./src/index.ts"
   },
   "dependencies": {
-    "@cueloop/daemon": "0.1.0-alpha.19",
-    "@cueloop/extension-api": "0.1.0-alpha.19",
-    "@cueloop/integration-obsidian": "0.1.0-alpha.19",
-    "@cueloop/schema": "0.1.0-alpha.19",
+    "@cueloop/daemon": "0.1.0-alpha.20",
+    "@cueloop/extension-api": "0.1.0-alpha.20",
+    "@cueloop/integration-obsidian": "0.1.0-alpha.20",
+    "@cueloop/schema": "0.1.0-alpha.20",
     "@opentui/core": "^0.5.1",
     "@opentui/keymap": "0.5.1",
     "@opentui/react": "^0.5.1",

package/src/App.plan-review.test.tsx

@@ -142,7 +142,9 @@ describe("inline compose keeps the anchor painted", () => {
     const stored = server.core.sessionGet(session.id);
     expect(stored.annotations.length).toBe(1);
     expect(backgroundsOf(setup, stored.annotations[0]!.anchor.quote.slice(0, 20))).toContain(T.markCommentBg);
-  });
+    // renderApp plus this many frame-waits grazes the 5s default on a loaded CI
+    // runner; the sibling walk resume test carries the same budget.
+  }, 15_000);
 });
 
 describe("the document selects, the rail edits", () => {

package/src/config.test.ts

@@ -57,6 +57,31 @@ describe("loadConfig", () => {
       rmSync(dir, { recursive: true, force: true });
     }
   });
+
+  test("[ui] parses auto_close and the editor override", () => {
+    const dir = mkdtempSync(join(tmpdir(), "cueloop-cfg4-"));
+    const path = join(dir, "config.toml");
+    writeFileSync(path, `[ui]\nauto_close = 3\neditor = "code --wait"\n`);
+    try {
+      const config = loadConfig({ userConfigPath: path });
+      expect(config.ui.autoClose).toBe(3);
+      expect(config.ui.editor).toBe("code --wait");
+    } finally {
+      rmSync(dir, { recursive: true, force: true });
+    }
+  });
+
+  test("[ui] editor defaults to undefined and ignores a blank value", () => {
+    const dir = mkdtempSync(join(tmpdir(), "cueloop-cfg5-"));
+    const path = join(dir, "config.toml");
+    writeFileSync(path, `[ui]\neditor = "   "\n`);
+    try {
+      expect(loadConfig({ userConfigPath: "/nonexistent/config.toml" }).ui.editor).toBeUndefined();
+      expect(loadConfig({ userConfigPath: path }).ui.editor).toBeUndefined();
+    } finally {
+      rmSync(dir, { recursive: true, force: true });
+    }
+  });
 });
 
 describe("integrations.obsidian config", () => {

package/src/config.ts

@@ -1,7 +1,8 @@
 /**
  * Layered TOML config: built-in defaults → user config → trusted repo
  * config → env. Sections: [keys] action = "combo" (every action rebindable),
- * [theme] per-token overrides, [integrations.obsidian] notes-vault export.
+ * [theme] per-token overrides, [ui] auto_close + editor, [integrations.obsidian]
+ * notes-vault export.
  */
 
 import { existsSync, readFileSync } from "node:fs";
@@ -26,7 +27,7 @@ export type AutoClose = "off" | number;
 export interface CueloopConfig {
   keys: Record<string, string[]>;
   theme: Theme;
-  ui: { autoClose: AutoClose };
+  ui: { autoClose: AutoClose; editor?: string };
   integrations: IntegrationsConfig;
 }
 
@@ -67,11 +68,12 @@ function layer(base: CueloopConfig, raw: Record<string, unknown>): CueloopConfig
       out.keys[action] = Array.isArray(combo) ? combo : [combo];
     }
   }
-  const ui = raw["ui"] as { auto_close?: unknown } | undefined;
+  const ui = raw["ui"] as { auto_close?: unknown; editor?: unknown } | undefined;
   if (ui && ui.auto_close !== undefined) {
     if (ui.auto_close === "off") out.ui.autoClose = "off";
     else if (typeof ui.auto_close === "number" && ui.auto_close >= 0) out.ui.autoClose = ui.auto_close;
   }
+  if (ui && typeof ui.editor === "string" && ui.editor.trim()) out.ui.editor = ui.editor.trim();
   const theme = raw["theme"] as Partial<Record<keyof Theme, string>> | undefined;
   if (theme) {
     for (const [token, value] of Object.entries(theme)) {

package/src/editor.test.ts

@@ -0,0 +1,110 @@
+import { afterEach, beforeEach, describe, expect, test } from "bun:test";
+import { chmodSync, mkdtempSync, rmSync, writeFileSync } from "node:fs";
+import { tmpdir } from "node:os";
+import { join } from "node:path";
+import { editInEditor, resolveEditor, resolveEditorCommand } from "./editor";
+
+describe("resolveEditor", () => {
+  test("a clean environment falls back to nano so editing always works", () => {
+    expect(resolveEditor(undefined, {})).toBe("nano");
+  });
+
+  test("the environment chain wins in order: CUELOOP_EDITOR, VISUAL, EDITOR", () => {
+    expect(resolveEditor(undefined, { EDITOR: "vim", VISUAL: "code", CUELOOP_EDITOR: "hx" })).toBe("hx");
+    expect(resolveEditor(undefined, { EDITOR: "vim", VISUAL: "code" })).toBe("code");
+    expect(resolveEditor(undefined, { EDITOR: "vim" })).toBe("vim");
+  });
+
+  test("the [ui] editor config overrides the environment", () => {
+    expect(resolveEditor("code --wait", { EDITOR: "vim" })).toBe("code --wait");
+  });
+});
+
+describe("resolveEditorCommand", () => {
+  test("a known GUI editor gets its wait flag appended and is trusted to wait", () => {
+    expect(resolveEditorCommand("code")).toEqual({ argv: ["code", "--wait"], waits: true });
+    expect(resolveEditorCommand("subl")).toEqual({ argv: ["subl", "--new-window", "--wait"], waits: true });
+  });
+
+  test("an existing wait flag is not duplicated", () => {
+    expect(resolveEditorCommand("code --wait").argv).toEqual(["code", "--wait"]);
+  });
+
+  test("a terminal editor is left alone and trusted to hold the tty", () => {
+    expect(resolveEditorCommand("vim")).toEqual({ argv: ["vim"], waits: true });
+  });
+
+  test("an unknown editor is neither flagged nor trusted to wait", () => {
+    expect(resolveEditorCommand("my-editor")).toEqual({ argv: ["my-editor"], waits: false });
+  });
+});
+
+describe("editInEditor", () => {
+  let dir: string;
+  beforeEach(() => {
+    dir = mkdtempSync(join(tmpdir(), "cueloop-edit-test-"));
+  });
+  afterEach(() => {
+    rmSync(dir, { recursive: true, force: true });
+  });
+
+  /** A runnable editor stub with a chosen base name and body. */
+  function stubEditor(name: string, body: string): string {
+    const script = join(dir, name);
+    writeFileSync(script, `#!/bin/sh\n${body}\n`);
+    chmodSync(script, 0o755);
+    return script;
+  }
+
+  const instant = (): (() => number) => {
+    let value = 0;
+    return () => (value += 5);
+  };
+
+  test("an editor that changes the file reports the new content", () => {
+    const result = editInEditor("old", "plan.md", { editor: stubEditor("writer.sh", `printf 'new' > "$1"`) });
+    expect(result).toEqual({ content: "new", changed: true });
+  });
+
+  test("a fast, unchanged return opens the gate; confirming re-reads the saved file", () => {
+    let askedLabel = "";
+    const result = editInEditor("keep", "plan.md", {
+      editor: stubEditor("gui-like.sh", "exit 0"),
+      now: instant(),
+      confirmSaved: (label, path) => {
+        askedLabel = label;
+        writeFileSync(path, "saved in the GUI");
+        return true;
+      },
+    });
+    expect(askedLabel).toContain("gui-like.sh");
+    expect(result).toEqual({ content: "saved in the GUI", changed: true });
+  });
+
+  test("declining the gate keeps the original content", () => {
+    const result = editInEditor("keep", "plan.md", {
+      editor: stubEditor("gui-like.sh", "exit 0"),
+      now: instant(),
+      confirmSaved: () => false,
+    });
+    expect(result).toEqual({ content: "keep", changed: false });
+  });
+
+  test("a terminal editor that makes no change never opens the gate", () => {
+    let asked = false;
+    const result = editInEditor("keep", "plan.md", {
+      editor: stubEditor("vi", "exit 0"),
+      now: instant(),
+      confirmSaved: () => {
+        asked = true;
+        return true;
+      },
+    });
+    expect(asked).toBeFalse();
+    expect(result).toEqual({ content: "keep", changed: false });
+  });
+
+  test("a nonzero editor exit throws", () => {
+    expect(() => editInEditor("x", "plan.md", { editor: stubEditor("fail.sh", "exit 3") })).toThrow("editor exited 3");
+  });
+});

package/src/editor.ts

@@ -1,7 +1,11 @@
 /**
- * File-level edit mode = the $EDITOR hand-off: write the working
- * copy to a temp file, run the user's editor on it, read the result back.
- * Tests point CUELOOP_EDITOR at a non-interactive command.
+ * File-level edit mode = the editor hand-off: write the working copy to a temp
+ * file, run the reviewer's editor on it, read the result back. Editing must
+ * work with zero configuration, so the resolution chain ends in a terminal
+ * fallback that is always present. A GUI editor launched without a wait flag
+ * forks and returns instantly, losing the edit silently; known GUI editors get
+ * their wait flag applied, and any editor that still returns right away with an
+ * untouched file drops to a confirm gate rather than discarding the work.
  */
 
 import { mkdtempSync, readFileSync, rmSync, writeFileSync } from "node:fs";
@@ -13,20 +17,104 @@ export interface EditResult {
   changed: boolean;
 }
 
-export function editInEditor(content: string, filename = "plan.md"): EditResult {
-  const editor = process.env.CUELOOP_EDITOR ?? process.env.VISUAL ?? process.env.EDITOR;
-  if (!editor) throw new Error("no editor: set $EDITOR (or $CUELOOP_EDITOR)");
+/** Present on every POSIX system, so a clean shell can still edit. */
+const DEFAULT_EDITOR = "nano";
+
+/** GUI editors fork and return immediately unless given their wait flag. */
+const GUI_WAIT_FLAGS: Record<string, string[]> = {
+  code: ["--wait"],
+  "code-insiders": ["--wait"],
+  codium: ["--wait"],
+  cursor: ["--wait"],
+  windsurf: ["--wait"],
+  subl: ["--new-window", "--wait"],
+  sublime_text: ["--new-window", "--wait"],
+  zed: ["--wait"],
+  bbedit: ["--wait"],
+  mate: ["--wait"],
+  gedit: ["--wait"],
+  kate: ["--block"],
+  idea: ["--wait"],
+  webstorm: ["--wait"],
+};
+
+/** Editors that hold the terminal themselves - never GUI, never a wait gate. */
+const TERMINAL_EDITORS = new Set([
+  "vi", "vim", "nvim", "nano", "pico", "emacs", "emacsclient", "micro", "hx", "helix", "kak", "ed", "joe", "mcedit",
+]);
+
+export interface ResolvedEditor {
+  argv: string[];
+  /** True when this editor blocks the hand-off until the file is closed - a
+   * terminal editor, or a known GUI editor with its wait flag applied. */
+  waits: boolean;
+}
+
+/** The editor to run: [ui] editor, then the environment chain, then nano. */
+export function resolveEditor(configuredEditor: string | undefined, env: Record<string, string | undefined> = process.env): string {
+  const candidates = [configuredEditor, env.CUELOOP_EDITOR, env.VISUAL, env.EDITOR];
+  return candidates.find((candidate) => candidate && candidate.trim())?.trim() ?? DEFAULT_EDITOR;
+}
+
+function editorBaseName(command: string): string {
+  return (command.split(/[\\/]/).pop() ?? command).toLowerCase();
+}
+
+/** Split the editor string and apply a GUI wait flag when we know one. */
+export function resolveEditorCommand(rawEditor: string): ResolvedEditor {
+  const parts = rawEditor.trim().split(/\s+/);
+  const base = editorBaseName(parts[0] ?? "");
+  if (TERMINAL_EDITORS.has(base)) return { argv: parts, waits: true };
+  const waitFlags = GUI_WAIT_FLAGS[base];
+  if (waitFlags) {
+    const alreadyWaits = parts.some((part) => part === "--wait" || part === "-w" || part === "--block");
+    return { argv: alreadyWaits ? parts : [...parts, ...waitFlags], waits: true };
+  }
+  return { argv: parts, waits: false };
+}
+
+/** A fast return with an untouched file means the editor probably did not wait. */
+const NO_WAIT_THRESHOLD_MS = 1000;
+
+function suspectsNoWait(resolved: ResolvedEditor, elapsedMs: number, unchanged: boolean): boolean {
+  if (resolved.waits) return false; // holds the terminal or has a wait flag - trust the exit
+  if (!unchanged) return false; // edits landed, so it waited after all
+  return elapsedMs < NO_WAIT_THRESHOLD_MS;
+}
+
+export interface EditHandOff {
+  /** Editor from [ui] editor config; overrides the environment. */
+  editor?: string;
+  env?: Record<string, string | undefined>;
+  /** Confirm gate for a suspected no-wait return; true re-reads the file. */
+  confirmSaved?: (editorLabel: string, path: string) => boolean;
+  now?: () => number;
+}
+
+/** Prompt on the released terminal during the suspend window. */
+function promptSaved(editorLabel: string, path: string): boolean {
+  const answer = prompt(
+    `${editorLabel} returned immediately and the plan is unchanged - a GUI editor needs its wait flag. Save and close ${path}, then press Enter to load your edits (or type n to skip):`,
+  );
+  return answer !== null && answer.trim().toLowerCase() !== "n";
+}
+
+export function editInEditor(content: string, filename = "plan.md", handOff: EditHandOff = {}): EditResult {
+  const env = handOff.env ?? process.env;
+  const now = handOff.now ?? Date.now;
+  const resolved = resolveEditorCommand(resolveEditor(handOff.editor, env));
   const dir = mkdtempSync(join(tmpdir(), "cueloop-edit-"));
   const path = join(dir, filename);
   writeFileSync(path, content);
   try {
-    const proc = Bun.spawnSync([...editor.split(" "), path], {
-      stdin: "inherit",
-      stdout: "inherit",
-      stderr: "inherit",
-    });
-    if (proc.exitCode !== 0) throw new Error(`editor exited ${proc.exitCode}`);
-    const next = readFileSync(path, "utf8");
+    const startedAt = now();
+    const editorProcess = Bun.spawnSync([...resolved.argv, path], { stdin: "inherit", stdout: "inherit", stderr: "inherit" });
+    if (editorProcess.exitCode !== 0) throw new Error(`editor exited ${editorProcess.exitCode}`);
+    let next = readFileSync(path, "utf8");
+    if (suspectsNoWait(resolved, now() - startedAt, next === content)) {
+      const confirm = handOff.confirmSaved ?? promptSaved;
+      if (confirm(resolved.argv[0] ?? "the editor", path)) next = readFileSync(path, "utf8");
+    }
     return { content: next, changed: next !== content };
   } finally {
     rmSync(dir, { recursive: true, force: true });

package/src/session-controller.ts

@@ -140,6 +140,7 @@ class Controller implements ReviewController {
   };
   private listeners = new Set<() => void>();
   private autoClose: AutoClose = "off";
+  private editor: string | undefined;
   private exporters: BundledExporter[] = [];
   private readonly clock: Clock;
   private countdown: TimerHandle | undefined;
@@ -205,6 +206,7 @@ class Controller implements ReviewController {
 
   applyConfig(config: CueloopConfig): void {
     this.autoClose = config.ui.autoClose;
+    this.editor = config.ui.editor;
     void loadBundledExporters(config.integrations).then((exporters) => {
       this.exporters = exporters;
     });
@@ -304,7 +306,7 @@ class Controller implements ReviewController {
     const session = this.snapshot.session;
     if (!session || session.status === "resolved") return;
     try {
-      const result = editInEditor(this.working(), "plan.md");
+      const result = editInEditor(this.working(), "plan.md", { editor: this.editor });
       if (result.changed) {
         this.setWorkingCopy(result.content);
         this.reconcileAnnotations(session, result.content);