@cueloop/client 0.1.0-alpha.10 → 0.1.0-alpha.101

package/src/markdown/components/MarkdownThreadEditor.test.tsx

@@ -0,0 +1,98 @@
+import { describe, expect, test } from "bun:test";
+import React from "react";
+import { testRender } from "@opentui/react/test-utils";
+import { DARK } from "../../appearance/theme";
+import { press, settle } from "../../testing/test-support";
+import { MarkdownThreadEditor, type MarkdownEditorHandle } from "./MarkdownThreadEditor";
+
+describe("MarkdownThreadEditor", () => {
+  test("opens on the working copy and shows the caret position and save hint", async () => {
+    const setup = await testRender(
+      <MarkdownThreadEditor
+        initialText={"# Title\n\nbody text here\n"}
+        theme={DARK}
+        onExitEditor={() => {}}
+      />,
+      { width: 50, height: 12 },
+    );
+
+    await settle(setup);
+    const frame = setup.captureCharFrame();
+
+    expect(frame).toContain("Title");
+    expect(frame).toContain("body text here");
+    expect(frame).toContain("Ln 1/4");
+    expect(frame).toContain("save & close");
+    setup.renderer.destroy();
+  });
+
+  test("the exit handle saves the current text and leaves (the header toggle's path)", async () => {
+    const handleRef = React.createRef<MarkdownEditorHandle>();
+    let exitedWith = "";
+    const setup = await testRender(
+      <MarkdownThreadEditor
+        ref={handleRef}
+        initialText={"keep this"}
+        theme={DARK}
+        onExitEditor={(text) => {
+          exitedWith = text;
+        }}
+      />,
+      { width: 40, height: 8 },
+    );
+
+    await settle(setup);
+    handleRef.current?.requestExit();
+
+    expect(exitedWith).toBe("keep this");
+    setup.renderer.destroy();
+  });
+
+  test("highlights align to the exact characters across lines (no newline drift)", async () => {
+    const setup = await testRender(
+      <MarkdownThreadEditor
+        initialText={"# Head\n\nrun `code` now\n"}
+        theme={DARK}
+        onExitEditor={() => {}}
+      />,
+      { width: 40, height: 10 },
+    );
+
+    await settle(setup);
+    const spans = setup.captureSpans().lines.flatMap((line) => line.spans);
+    const hexOf = (color: { toInts: () => number[] }): string =>
+      "#" +
+      color
+        .toInts()
+        .slice(0, 3)
+        .map((part) => part.toString(16).padStart(2, "0"))
+        .join("");
+    // the code highlight must cover exactly `code`, not a drifted slice like "ode` "
+    const codeSpan = spans.find((span) => span.text === "`code`");
+
+    expect(codeSpan).toBeDefined();
+    expect(codeSpan?.fg && hexOf(codeSpan.fg)).toBe(DARK.textDim);
+    setup.renderer.destroy();
+  });
+
+  test("escape is a no-op - it never leaves the editor (IDE convention)", async () => {
+    let exits = 0;
+    const setup = await testRender(
+      <MarkdownThreadEditor
+        initialText={"stay put"}
+        theme={DARK}
+        onExitEditor={() => {
+          exits += 1;
+        }}
+      />,
+      { width: 40, height: 8 },
+    );
+
+    await settle(setup);
+    await press(setup, "escape");
+
+    expect(exits).toBe(0);
+    expect(setup.captureCharFrame()).toContain("save & close");
+    setup.renderer.destroy();
+  });
+});

package/src/markdown/components/MarkdownThreadEditor.tsx

@@ -0,0 +1,160 @@
+/**
+ * The native inline markdown editor for a thread's body: a full-height text area
+ * over the working copy that lightly marks markdown as you type - a heading's
+ * marker dims and its title bolds, links color, inline and fenced code gray -
+ * and reports the caret line and column, replacing the external-editor hand-off so
+ * editing needs no per-user editor configuration. cmd, meta, or ctrl + enter
+ * saves the working copy and closes (loss-free, like the hand-off it replaces),
+ * as does the header edit/normal toggle; plain enter breaks the line. Escape is
+ * a no-op inside the editor, matching a modeless IDE - you leave by an explicit
+ * action, not by escaping the text. The raw markdown stays visible - a concealed
+ * rendered preview is a later layer.
+ */
+
+import React, { forwardRef, useImperativeHandle, useLayoutEffect, useRef, useState } from "react";
+import type { KeyBinding, TextareaRenderable } from "@opentui/core";
+import { type Theme } from "../../appearance/theme";
+import { markdownHighlightRanges } from "../markdown-highlight";
+import { markdownEditorStyle } from "../markdown-editor-syntax-style";
+
+export interface MarkdownThreadEditorProps {
+  initialText: string;
+  theme: Theme;
+  onExitEditor: (text: string) => void;
+}
+
+/** An imperative exit for callers outside the editor (the header edit/normal toggle): save the current text and leave. */
+export interface MarkdownEditorHandle {
+  requestExit: () => void;
+}
+
+// three modifiers cover terminal variance for save-and-close; plain enter is a newline, escape stays unbound
+const MARKDOWN_EDITOR_KEY_BINDINGS: KeyBinding[] = [
+  { name: "return", super: true, action: "submit" },
+  { name: "return", meta: true, action: "submit" },
+  { name: "return", ctrl: true, action: "submit" },
+  { name: "a", super: true, action: "select-all" },
+  { name: "a", meta: true, action: "select-all" },
+  { name: "return", action: "newline" },
+  { name: "return", shift: true, action: "newline" },
+];
+
+/** The caret's 1-based line and column, plus the buffer's total line count, for the status footer. */
+interface MarkdownEditorPosition {
+  line: number;
+  column: number;
+  lineCount: number;
+}
+
+/** For each offset 0..length, the count of newlines before it, mapping a source offset to the buffer's newline-excluded offset. */
+function newlinePrefixCounts(text: string): number[] {
+  const counts = Array.from({ length: text.length + 1 }, () => 0);
+  let seen = 0;
+
+  for (let index = 0; index < text.length; index++) {
+    counts[index] = seen;
+    if (text[index] === "\n") seen += 1;
+  }
+  counts[text.length] = seen;
+
+  return counts;
+}
+
+export const MarkdownThreadEditor = forwardRef<MarkdownEditorHandle, MarkdownThreadEditorProps>(
+  function MarkdownThreadEditor({ initialText, theme, onExitEditor }, handleRef): React.ReactNode {
+    const editorRef = useRef<TextareaRenderable | null>(null);
+    const [position, setPosition] = useState<MarkdownEditorPosition>({
+      line: 1,
+      column: 1,
+      lineCount: initialText.split("\n").length,
+    });
+
+    const exitWithCurrentText = (): void =>
+      onExitEditor(editorRef.current?.plainText ?? initialText);
+
+    useImperativeHandle(handleRef, () => ({ requestExit: exitWithCurrentText }));
+
+    const paintMarkdown = (editor: TextareaRenderable): void => {
+      const { styleIdFor } = markdownEditorStyle(theme);
+      const text = editor.plainText;
+      // addHighlightByCharRange counts offsets with newlines excluded, so map source offsets down by the
+      // newlines before them - otherwise a highlight drifts one cell per preceding line
+      const newlinesBefore = newlinePrefixCounts(text);
+
+      editor.editBuffer.clearAllHighlights();
+      for (const range of markdownHighlightRanges(text)) {
+        editor.editBuffer.addHighlightByCharRange({
+          start: range.start - newlinesBefore[range.start]!,
+          end: range.end - newlinesBefore[range.end]!,
+          styleId: styleIdFor(range.group),
+        });
+      }
+    };
+
+    // paint synchronously at commit so the first frame already shows styled markdown
+    useLayoutEffect(() => {
+      const editor = editorRef.current;
+
+      if (!editor) return;
+      editor.editBuffer.setSyntaxStyle(markdownEditorStyle(theme).style);
+      paintMarkdown(editor);
+      setPosition((prior) => ({ ...prior, lineCount: editor.editBuffer.getLineCount() }));
+      // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, []);
+
+    return (
+      <box style={{ flexDirection: "column", flexGrow: 1, paddingLeft: 2 }}>
+        <textarea
+          ref={editorRef}
+          focused
+          initialValue={initialText}
+          keyBindings={MARKDOWN_EDITOR_KEY_BINDINGS}
+          wrapMode="word"
+          cursorStyle={{ style: "block", blinking: true }}
+          onSubmit={exitWithCurrentText}
+          onCursorChange={(event) =>
+            setPosition((prior) => ({
+              ...prior,
+              line: event.line + 1,
+              column: event.visualColumn + 1,
+            }))
+          }
+          onContentChange={() => {
+            const editor = editorRef.current;
+
+            if (!editor) return;
+            paintMarkdown(editor);
+            setPosition((prior) => ({ ...prior, lineCount: editor.editBuffer.getLineCount() }));
+          }}
+          style={{
+            flexGrow: 1,
+            backgroundColor: "transparent",
+            focusedBackgroundColor: "transparent",
+            textColor: theme.text,
+            focusedTextColor: theme.text,
+          }}
+        />
+        <MarkdownEditorStatus position={position} theme={theme} />
+      </box>
+    );
+  },
+);
+
+/** The one-row footer under the editor: caret line and column, total lines, and the save-and-close hint. */
+function MarkdownEditorStatus({
+  position,
+  theme,
+}: {
+  position: MarkdownEditorPosition;
+  theme: Theme;
+}): React.ReactNode {
+  return (
+    <box style={{ flexDirection: "row", flexShrink: 0 }}>
+      <text
+        fg={theme.textMuted}
+      >{`Ln ${position.line}/${position.lineCount}  Col ${position.column}`}</text>
+      <box style={{ flexGrow: 1 }} />
+      <text fg={theme.textDim}>{"⌃⏎ save & close"}</text>
+    </box>
+  );
+}