markdansi 0.1.3 → 0.1.5

package/README.md

@@ -1,4 +1,9 @@
 # 🎨 Markdansi: Wraps, colors, links—no baggage.
+
+<p align="center">
+  <img src="./markdansi.png" alt="Markdansi README header" width="1100">
+</p>
+
 ![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.
@@ -6,14 +11,18 @@ Tiny, dependency-light Markdown → ANSI renderer and CLI for modern Node (>=22)
 Published on npm as `markdansi`.
 
 ## Install
+Grab it from npm; no native deps, so install is instant on Node 22+.
 
 ```bash
+bun add markdansi
+# or
 pnpm add markdansi
 # or
 npm install markdansi
 ```
 
 ## CLI
+Quick one-shot renderer: pipe Markdown in, ANSI comes out. Flags let you pick width, wrap, colors, links, and table/list styling.
 
 ```bash
 markdansi [--in FILE] [--out FILE] [--width N] [--no-wrap] [--no-color] [--no-links] [--theme default|dim|bright]
@@ -27,6 +36,15 @@ markdansi [--in FILE] [--out FILE] [--width N] [--no-wrap] [--no-color] [--no-li
 - Lists/quotes: `--list-indent` sets spaces per nesting level (default 2); `--quote-prefix` sets blockquote prefix (default `│ `).
 
 ## Library
+Use the renderer directly in Node/TS for customizable theming, optional syntax highlighting hooks, and OSC‑8 link control.
+
+### ESM / CommonJS
+Markdansi ships ESM (`"type":"module"`). If you’re in CommonJS (or a tool like `tsx` running your script as CJS), prefer dynamic import:
+
+```js
+const { render } = await import('markdansi');
+console.log(render('# hello'));
+```
 
 ```js
 import { render, createRenderer, strip, themes } from 'markdansi';
@@ -100,12 +118,6 @@ console.log(highlighted('```ts\nconst x: number = 1\n```\n```swift\nlet x = 1\n`
 - `codeBox`: draw a box around fenced code (default true); `codeGutter` shows line numbers; `codeWrap` wraps code lines by default.
 - `highlighter(code, lang)`: optional hook to recolor code blocks; must not add/remove newlines.
 
-## Status
-
-Version: `0.1.2` (released)  
-Tests: `pnpm test`  
-License: MIT
-
 ## Notes
 
 - Code blocks wrap to the render width by default; disable with `codeWrap=false`. If `lang` is present, a faint `[lang]` label is shown and boxes use unicode borders.
@@ -113,4 +125,8 @@ License: MIT
 - Tables use unicode borders by default, include padding, respect GFM alignment, and truncate long cells with `…` so layouts stay tidy. Turn off truncation with `tableTruncate=false`.
 - Tight vs loose lists follow GFM; task items render `[ ]` / `[x]`.
 
-See `docs/spec.md` for full behavior details.*** End Patch
+See [`docs/spec.md`](docs/spec.md) for full behavior details.
+
+Looking for the Swift port? Check out [Swiftdansi](https://github.com/steipete/Swiftdansi).
+
+MIT license.

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/package.json

@@ -1,75 +1,78 @@
 {
-  "name": "markdansi",
-  "version": "0.1.3",
-  "description": "Tiny dependency-light markdown to ANSI converter.",
-  "type": "module",
-  "main": "dist/index.js",
-  "exports": {
-    ".": {
-      "import": "./dist/index.js"
-    },
-    "./cli": "./dist/cli.js"
-  },
-  "bin": {
-    "markdansi": "./dist/cli.js"
-  },
-  "keywords": [
-    "markdown",
-    "ansi",
-    "terminal",
-    "cli"
-  ],
-  "engines": {
-    "node": ">=22"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/steipete/Markdansi.git"
-  },
-  "bugs": {
-    "url": "https://github.com/steipete/Markdansi/issues"
-  },
-  "homepage": "https://github.com/steipete/Markdansi#readme",
-  "author": "Peter Steinberger",
-  "license": "MIT",
-  "sideEffects": false,
-  "files": [
-    "dist",
-    "README.md",
-    "docs/spec.md",
-    "package.json",
-    "tsconfig.json",
-    ".biome.json"
-  ],
-  "types": "dist/index.d.ts",
-  "dependencies": {
-    "chalk": "^5.6.2",
-    "mdast-util-from-markdown": "^2.0.2",
-    "mdast-util-gfm": "^3.1.0",
-    "micromark": "^4.0.2",
-    "micromark-extension-gfm": "^3.0.0",
-    "micromark-util-combine-extensions": "^2.0.1",
-    "string-width": "^8.1.0",
-    "strip-ansi": "^7.1.2",
-    "supports-hyperlinks": "^4.3.0"
-  },
-  "devDependencies": {
-    "@biomejs/biome": "^2.3.5",
-    "@types/mdast": "^4.0.4",
-    "@types/node": "^24.10.1",
-    "@vitest/coverage-v8": "^4.0.9",
-    "tsx": "^4.20.6",
-    "typescript": "^5.9.3",
-    "vitest": "^4.0.9"
-  },
-  "scripts": {
-    "build": "pnpm lint && pnpm test && pnpm compile",
-    "clean": "rm -rf dist",
-    "lint": "rm -rf dist coverage && biome check .",
-    "test": "vitest run",
-    "test:coverage": "vitest run --coverage",
-    "types": "tsc -p tsconfig.json --emitDeclarationOnly",
-    "compile": "tsc -p tsconfig.json",
-    "markdansi": "tsx src/cli.ts"
-  }
-}
+	"name": "markdansi",
+	"version": "0.1.5",
+	"description": "Tiny dependency-light markdown to ANSI converter.",
+	"type": "module",
+	"main": "dist/index.js",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"import": "./dist/index.js",
+			"default": "./dist/index.js"
+		},
+		"./cli": "./dist/cli.js"
+	},
+	"bin": {
+		"markdansi": "dist/cli.js"
+	},
+	"scripts": {
+		"build": "pnpm lint && pnpm test && pnpm compile",
+		"clean": "rm -rf dist",
+		"lint": "rm -rf dist coverage && biome check .",
+		"test": "vitest run",
+		"test:coverage": "vitest run --coverage",
+		"types": "tsc -p tsconfig.json --emitDeclarationOnly",
+		"compile": "tsc -p tsconfig.json",
+		"prepare": "pnpm compile",
+		"markdansi": "tsx src/cli.ts"
+	},
+	"keywords": [
+		"markdown",
+		"ansi",
+		"terminal",
+		"cli"
+	],
+	"engines": {
+		"node": ">=22"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/steipete/Markdansi.git"
+	},
+	"bugs": {
+		"url": "https://github.com/steipete/Markdansi/issues"
+	},
+	"homepage": "https://github.com/steipete/Markdansi#readme",
+	"author": "Peter Steinberger",
+	"license": "MIT",
+	"sideEffects": false,
+	"files": [
+		"dist",
+		"README.md",
+		"docs/spec.md",
+		"package.json",
+		"tsconfig.json",
+		".biome.json"
+	],
+	"types": "dist/index.d.ts",
+	"dependencies": {
+		"chalk": "^5.6.2",
+		"mdast-util-from-markdown": "^2.0.2",
+		"mdast-util-gfm": "^3.1.0",
+		"micromark": "^4.0.2",
+		"micromark-extension-gfm": "^3.0.0",
+		"micromark-util-combine-extensions": "^2.0.1",
+		"string-width": "^8.1.0",
+		"strip-ansi": "^7.1.2",
+		"supports-hyperlinks": "^4.3.0"
+	},
+	"devDependencies": {
+		"@biomejs/biome": "^2.3.5",
+		"@types/mdast": "^4.0.4",
+		"@types/node": "^24.10.1",
+		"@vitest/coverage-v8": "^4.0.9",
+		"tsx": "^4.20.6",
+		"typescript": "^5.9.3",
+		"vitest": "^4.0.9"
+	}
+}