markdansi 0.1.4 → 0.1.6

package/README.md

@@ -6,7 +6,7 @@
 
 ![npm](https://img.shields.io/npm/v/markdansi) ![license MIT](https://img.shields.io/badge/license-MIT-blue.svg) ![node >=22](https://img.shields.io/badge/node-%3E%3D22-brightgreen) ![tests vitest](https://img.shields.io/badge/tests-vitest-blue?logo=vitest)
 
-Tiny, dependency-light Markdown → ANSI renderer and CLI for modern Node (>=22). Focuses on readable terminal output with sensible wrapping, GFM support (tables, task lists, strikethrough), optional OSC‑8 hyperlinks, and zero built‑in syntax highlighting (pluggable hook). Written in TypeScript, ships ESM.
+Tiny, dependency-light Markdown → ANSI renderer and CLI for modern Node (>=22). Focuses on readable terminal output with sensible wrapping, GFM support (tables, task lists, strikethrough), optional OSC‑8 hyperlinks, and zero built‑in syntax highlighting (pluggable hook). Includes live in-place terminal rendering for streaming updates (`createLiveRenderer`). Written in TypeScript, ships ESM.
 
 Published on npm as `markdansi`.
 
@@ -46,6 +46,25 @@ const { render } = await import('markdansi');
 console.log(render('# hello'));
 ```
 
+### Live streaming / in-place rendering
+For streaming output (LLM responses, logs, progress), use `createLiveRenderer` to re-render and redraw in-place. Uses terminal “synchronized output” when supported.
+
+```js
+import { createLiveRenderer, render } from 'markdansi';
+
+const live = createLiveRenderer({
+  renderFrame: (markdown) => render(markdown),
+  write: process.stdout.write.bind(process.stdout),
+});
+
+let buffer = '';
+buffer += '# Hello\\n';
+live.render(buffer);
+buffer += '\\nMore…\\n';
+live.render(buffer);
+live.finish();
+```
+
 ```js
 import { render, createRenderer, strip, themes } from 'markdansi';
 

package/dist/index.d.ts

@@ -1,8 +1,11 @@
+import type { LiveRenderer, LiveRendererOptions } from "./live.js";
+import { createLiveRenderer } from "./live.js";
 import { createRenderer, render as renderMarkdown } from "./render.js";
 import { themes } from "./theme.js";
 import type { RenderOptions, Theme, ThemeName } from "./types.js";
-export { renderMarkdown as render, createRenderer, themes };
+export { createLiveRenderer, createRenderer, renderMarkdown as render, themes };
 export type { RenderOptions, Theme, ThemeName };
+export type { LiveRenderer, LiveRendererOptions };
 /**
  * Render Markdown to plain text (no ANSI, no hyperlinks) while preserving layout/wrapping.
  */

package/dist/index.js

@@ -1,6 +1,7 @@
+import { createLiveRenderer } from "./live.js";
 import { createRenderer, render as renderMarkdown } from "./render.js";
 import { themes } from "./theme.js";
-export { renderMarkdown as render, createRenderer, themes };
+export { createLiveRenderer, createRenderer, renderMarkdown as render, themes };
 /**
  * Render Markdown to plain text (no ANSI, no hyperlinks) while preserving layout/wrapping.
  */

package/dist/live.d.ts

@@ -0,0 +1,35 @@
+export type LiveRenderer = {
+    render: (input: string) => void;
+    finish: () => void;
+};
+export type LiveRendererOptions = {
+    /**
+     * Function that converts the current full input into a rendered frame.
+     * Typically this is Markdansi's `render()` or an app-specific wrapper.
+     */
+    renderFrame: (input: string) => string;
+    /**
+     * Where to write ANSI output (usually `process.stdout.write.bind(process.stdout)`).
+     */
+    write: (chunk: string) => void;
+    /**
+     * Enable terminal "synchronized output" framing (DEC private mode 2026).
+     * Most terminals ignore this sequence if unsupported.
+     */
+    synchronizedOutput?: boolean;
+    /**
+     * Hide cursor during live updates.
+     */
+    hideCursor?: boolean;
+    /**
+     * Terminal width in columns used for row accounting.
+     * If omitted, defaults to 80.
+     */
+    width?: number;
+};
+/**
+ * Create a live renderer that repeatedly re-renders the entire buffer and redraws in-place.
+ *
+ * This is intentionally "terminal plumbing" and renderer-agnostic: you inject `renderFrame()`.
+ */
+export declare function createLiveRenderer(options: LiveRendererOptions): LiveRenderer;

package/dist/live.js

@@ -0,0 +1,75 @@
+import stringWidth from "string-width";
+import stripAnsi from "strip-ansi";
+const BSU = "\u001b[?2026h";
+const ESU = "\u001b[?2026l";
+const HIDE_CURSOR = "\u001b[?25l";
+const SHOW_CURSOR = "\u001b[?25h";
+const CLEAR_TO_END = "\u001b[0J";
+function cursorUp(lines) {
+    if (lines <= 0)
+        return "";
+    return `\u001b[${lines}A`;
+}
+/**
+ * Create a live renderer that repeatedly re-renders the entire buffer and redraws in-place.
+ *
+ * This is intentionally "terminal plumbing" and renderer-agnostic: you inject `renderFrame()`.
+ */
+export function createLiveRenderer(options) {
+    let previousRows = 0;
+    let cursorHidden = false;
+    const synchronizedOutput = options.synchronizedOutput !== false;
+    const hideCursor = options.hideCursor !== false;
+    const width = typeof options.width === "number" &&
+        Number.isFinite(options.width) &&
+        options.width > 0
+        ? Math.floor(options.width)
+        : 80;
+    const countRows = (text) => {
+        const lines = text.split("\n");
+        if (lines.length > 0 && lines.at(-1) === "")
+            lines.pop();
+        let rows = 0;
+        for (const line of lines) {
+            const visible = stripAnsi(line);
+            const w = stringWidth(visible);
+            rows += Math.max(1, Math.ceil(Math.max(0, w) / width));
+        }
+        return rows;
+    };
+    const render = (input) => {
+        const renderedRaw = options.renderFrame(input);
+        const rendered = renderedRaw.endsWith("\n")
+            ? renderedRaw
+            : `${renderedRaw}\n`;
+        const lines = rendered.split("\n");
+        if (lines.length > 0 && lines.at(-1) === "")
+            lines.pop();
+        const newRows = countRows(rendered);
+        let frame = "";
+        if (hideCursor && !cursorHidden) {
+            frame += HIDE_CURSOR;
+            cursorHidden = true;
+        }
+        if (synchronizedOutput)
+            frame += BSU;
+        frame += previousRows > 0 ? `${cursorUp(previousRows)}\r` : "\r";
+        frame += CLEAR_TO_END;
+        for (const line of lines) {
+            frame += "\r";
+            frame += line;
+            frame += "\r\n";
+        }
+        if (synchronizedOutput)
+            frame += ESU;
+        options.write(frame);
+        previousRows = newRows;
+    };
+    const finish = () => {
+        if (hideCursor && cursorHidden) {
+            options.write(SHOW_CURSOR);
+            cursorHidden = false;
+        }
+    };
+    return { render, finish };
+}

package/dist/render.js

@@ -322,7 +322,7 @@ function renderNode(node, ctx, indentLevel, isTightList) {
     }
 }
 function renderParagraph(node, ctx, indentLevel) {
-    const text = renderInline(node.children, ctx);
+    const text = normalizeParagraphInlineText(renderInline(node.children, ctx));
     const prefix = " ".repeat(ctx.options.listIndent * indentLevel);
     const rawLines = text.split("\n");
     const normalized = [];
@@ -489,7 +489,7 @@ function renderInline(children, ctx) {
                 out += renderLink(node, ctx);
                 break;
             case "break":
-                out += "\n";
+                out += HARD_BREAK;
                 break;
             default:
                 if ("value" in node && typeof node.value === "string")
@@ -498,6 +498,47 @@ function renderInline(children, ctx) {
     }
     return out;
 }
+const HARD_BREAK = "\u000B";
+function normalizeParagraphInlineText(text) {
+    if (!text.includes("\n") && !text.includes(HARD_BREAK))
+        return text;
+    const segments = [];
+    let current = "";
+    for (let i = 0; i < text.length; i += 1) {
+        const ch = text[i];
+        if (ch === "\n" || ch === HARD_BREAK) {
+            segments.push({
+                text: current,
+                breakAfter: ch === HARD_BREAK ? "hard" : "soft",
+            });
+            current = "";
+            continue;
+        }
+        current += ch;
+    }
+    segments.push({ text: current });
+    const defPattern = /^\[[^\]]+]:\s+\S/;
+    let out = segments[0]?.text ?? "";
+    for (let i = 0; i < segments.length - 1; i += 1) {
+        const kind = segments[i]?.breakAfter ?? "soft";
+        const left = segments[i]?.text ?? "";
+        const right = segments[i + 1]?.text ?? "";
+        if (kind === "hard") {
+            out += "\n";
+            out += right;
+            continue;
+        }
+        const leftTrim = left.trimStart();
+        const rightTrim = right.trimStart();
+        const keepNewline = left === "" ||
+            right === "" ||
+            defPattern.test(leftTrim) ||
+            defPattern.test(rightTrim);
+        out += keepNewline ? "\n" : " ";
+        out += rightTrim;
+    }
+    return out;
+}
 function renderLink(node, ctx) {
     const label = renderInline(node.children, ctx) || node.url;
     const url = node.url || "";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "markdansi",
-	"version": "0.1.4",
+	"version": "0.1.6",
 	"description": "Tiny dependency-light markdown to ANSI converter.",
 	"type": "module",
 	"main": "dist/index.js",
@@ -67,12 +67,17 @@
 		"supports-hyperlinks": "^4.3.0"
 	},
 	"devDependencies": {
-		"@biomejs/biome": "^2.3.5",
+		"@biomejs/biome": "^2.3.10",
 		"@types/mdast": "^4.0.4",
-		"@types/node": "^24.10.1",
-		"@vitest/coverage-v8": "^4.0.9",
-		"tsx": "^4.20.6",
+		"@types/node": "^25.0.3",
+		"@vitest/coverage-v8": "^4.0.16",
+		"tsx": "^4.21.0",
 		"typescript": "^5.9.3",
-		"vitest": "^4.0.9"
+		"vitest": "^4.0.16"
+	},
+	"pnpm": {
+		"onlyBuiltDependencies": [
+			"esbuild"
+		]
 	}
 }