markdansi 0.1.2 → 0.1.4

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';
@@ -50,6 +68,39 @@ const custom = createRenderer({
   highlighter: (code, lang) => code.toUpperCase(),
 });
 console.log(custom('`inline`\n\n```\nblock code\n```'));
+
+// Example: real syntax highlighting with Shiki (TS + Swift)
+import { bundledLanguages, bundledThemes, createHighlighter } from 'shiki';
+
+const shiki = await createHighlighter({
+  themes: [bundledThemes['github-dark']],
+  langs: [bundledLanguages.typescript, bundledLanguages.swift],
+});
+
+const highlighted = createRenderer({
+  highlighter: (code, lang) => {
+    if (!lang) return code;
+    const normalized = lang.toLowerCase();
+    if (!['ts', 'typescript', 'swift'].includes(normalized)) return code;
+    const { tokens } = shiki.codeToTokens(code, {
+      lang: normalized === 'swift' ? 'swift' : 'ts',
+      theme: 'github-dark',
+    });
+    return tokens
+      .map((line) =>
+        line
+          .map((token) =>
+            token.color ? `\u001b[38;2;${parseInt(token.color.slice(1, 3), 16)};${parseInt(
+              token.color.slice(3, 5),
+              16,
+            )};${parseInt(token.color.slice(5, 7), 16)}m${token.content}\u001b[39m` : token.content,
+          )
+          .join(''),
+      )
+      .join('\n');
+  },
+});
+console.log(highlighted('```ts\nconst x: number = 1\n```\n```swift\nlet x = 1\n```'));
 ```
 
 ### Options
@@ -67,12 +118,6 @@ console.log(custom('`inline`\n\n```\nblock code\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.
@@ -80,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/render.js

@@ -132,7 +132,100 @@ function normalizeNodes(tree) {
         if (node)
             normalized.push(node);
     }
-    return { ...tree, children: normalized };
+    const mergedCodes = mergeAdjacentCodeBlocks(normalized);
+    const taggedDiffs = mergedCodes.map((child) => tagDiffBlock(child));
+    return { ...tree, children: taggedDiffs };
+}
+function flattenCodeList(list) {
+    if (!list.children.length ||
+        !list.children.every((item) => item.children.length === 1 &&
+            item.children[0]?.type === "code" &&
+            item.children[0].value !== undefined))
+        return null;
+    const codes = list.children.map((item) => item.children[0]);
+    const sameLang = codes.every((c) => c.lang === codes[0]?.lang);
+    const lang = sameLang ? (codes[0]?.lang ?? undefined) : undefined;
+    return {
+        type: "code",
+        lang: lang ?? undefined,
+        value: codes.map((c) => c.value).join("\n"),
+        position: list.position,
+    };
+}
+function mergeAdjacentCodeBlocks(nodes) {
+    const out = [];
+    let pending = null;
+    const flush = () => {
+        if (pending) {
+            out.push(pending);
+            pending = null;
+        }
+    };
+    for (const node of nodes) {
+        if (node?.type === "code") {
+            if (pending &&
+                (pending.lang === node.lang || (!pending.lang && !node.lang))) {
+                const nextValue = `${pending.value}\n${node.value}`;
+                pending = {
+                    type: "code",
+                    lang: pending.lang,
+                    meta: pending.meta,
+                    value: nextValue,
+                    position: pending.position,
+                };
+            }
+            else {
+                flush();
+                pending = node;
+            }
+            continue;
+        }
+        if (node?.type === "list") {
+            const flattened = flattenCodeList(node);
+            if (flattened) {
+                if (pending &&
+                    (pending.lang === flattened.lang ||
+                        (!pending.lang && !flattened.lang))) {
+                    const nextValue = `${pending.value}\n${flattened.value}`;
+                    pending = {
+                        type: "code",
+                        lang: pending.lang,
+                        meta: pending.meta,
+                        value: nextValue,
+                        position: pending.position,
+                    };
+                }
+                else {
+                    flush();
+                    pending = flattened;
+                }
+                continue;
+            }
+        }
+        flush();
+        out.push(node);
+    }
+    flush();
+    return out;
+}
+function looksLikeDiff(text) {
+    const lines = text.split("\n").map((l) => l.trim());
+    if (lines.some((l) => l.startsWith("diff --git") ||
+        l.startsWith("--- a/") ||
+        l.startsWith("+++ b/") ||
+        l.startsWith("@@ ")))
+        return true;
+    const nonEmpty = lines.filter((l) => l !== "");
+    if (nonEmpty.length < 3)
+        return false;
+    const markers = nonEmpty.filter((l) => /^[+\-@]/.test(l)).length;
+    return markers >= Math.max(3, Math.ceil(nonEmpty.length * 0.6));
+}
+function tagDiffBlock(node) {
+    if (node?.type === "code" && !node.lang && looksLikeDiff(node.value)) {
+        return { ...node, lang: "diff" };
+    }
+    return node;
 }
 const HR_WIDTH = 40;
 const MAX_COL = 40;
@@ -320,11 +413,14 @@ function renderDefinition(node, _ctx) {
 function renderCodeBlock(node, ctx) {
     const theme = ctx.options.theme.blockCode || ctx.options.theme.inlineCode;
     const lines = (node.value ?? "").split("\n");
+    const isDiff = node.lang === "diff";
     const gutterWidth = ctx.options.codeGutter
         ? String(lines.length).length + 2
         : 0;
-    const boxPadding = ctx.options.codeBox ? 4 : 0;
-    const wrapLimit = ctx.options.codeWrap && ctx.options.wrap && ctx.options.width
+    const shouldWrap = isDiff ? false : ctx.options.codeWrap;
+    const useBox = ctx.options.codeBox && lines.length > 1;
+    const boxPadding = useBox ? 4 : 0;
+    const wrapLimit = shouldWrap && ctx.options.wrap && ctx.options.width
         ? Math.max(1, ctx.options.width - boxPadding - gutterWidth)
         : undefined; // undefined => no hard wrap limit
     const contentLines = lines.flatMap((line, idx) => {
@@ -340,7 +436,7 @@ function renderCodeBlock(node, ctx) {
             return `${ctx.style(num, { dim: true })} ${highlighted}`;
         });
     });
-    if (!ctx.options.codeBox) {
+    if (!useBox) {
         return [`${contentLines.join("\n")}\n\n`];
     }
     // Boxed block

package/package.json

@@ -1,75 +1,78 @@
 {
-  "name": "markdansi",
-  "version": "0.1.2",
-  "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.4",
+	"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"
+	}
+}