markdansi 0.1.0 → 0.1.2

package/dist/types.d.ts

@@ -0,0 +1,58 @@
+export type ColorName = "black" | "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | "gray" | `#${string}` | `${number}`;
+export type StyleIntent = {
+    color?: ColorName;
+    bgColor?: ColorName;
+    bold?: boolean;
+    italic?: boolean;
+    underline?: boolean;
+    dim?: boolean;
+    strike?: boolean;
+};
+export type Theme = {
+    heading?: StyleIntent;
+    strong?: StyleIntent;
+    emph?: StyleIntent;
+    inlineCode?: StyleIntent;
+    blockCode?: StyleIntent;
+    code?: StyleIntent;
+    link?: StyleIntent;
+    quote?: StyleIntent;
+    hr?: StyleIntent;
+    listMarker?: StyleIntent;
+    tableHeader?: StyleIntent;
+    tableCell?: StyleIntent;
+};
+export type ThemeName = "default" | "dim" | "bright";
+export type Highlighter = (code: string, lang?: string) => string;
+export interface RenderOptions {
+    wrap?: boolean;
+    width?: number;
+    hyperlinks?: boolean;
+    color?: boolean;
+    theme?: ThemeName | Theme;
+    /**
+     * Spaces per nesting level for lists (default 2).
+     */
+    listIndent?: number;
+    /**
+     * Prefix used for blockquotes (default "│ ").
+     */
+    quotePrefix?: string;
+    /** Table border style: unicode (default), ascii, or none. */
+    tableBorder?: "unicode" | "ascii" | "none";
+    /** Spaces around cell content (default 1). */
+    tablePadding?: number;
+    /** If true, reduces separator rows (default false). */
+    tableDense?: boolean;
+    /** If true, truncates cell content to fit column width (default true). */
+    tableTruncate?: boolean;
+    /** Ellipsis text for truncation (default "…"). */
+    tableEllipsis?: string;
+    /** Draw a box around fenced code blocks (default true). */
+    codeBox?: boolean;
+    /** Show line-number gutter for code blocks (default false). */
+    codeGutter?: boolean;
+    /** Wrap code lines to width; otherwise overflow (default true). */
+    codeWrap?: boolean;
+    highlighter?: Highlighter;
+}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/dist/wrap.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Visible width of a string, ignoring ANSI escape codes.
+ */
+export declare function visibleWidth(text: string): number;
+/**
+ * Wrap a single paragraph string into lines respecting visible width.
+ * Breaks only on spaces. Words longer than width overflow.
+ */
+export declare function wrapText(text: string, width: number, wrap: boolean): string[];
+export declare function wrapWithPrefix(text: string, width: number, wrap: boolean, prefix?: string): string[];

package/dist/wrap.js

@@ -0,0 +1,48 @@
+import stringWidth from "string-width";
+import stripAnsi from "strip-ansi";
+/**
+ * Visible width of a string, ignoring ANSI escape codes.
+ */
+export function visibleWidth(text) {
+    return stringWidth(stripAnsi(text));
+}
+/**
+ * Wrap a single paragraph string into lines respecting visible width.
+ * Breaks only on spaces. Words longer than width overflow.
+ */
+export function wrapText(text, width, wrap) {
+    if (!wrap || width <= 0)
+        return [text];
+    const words = text.split(/(\s+)/).filter((w) => w.length > 0);
+    const lines = [];
+    let current = "";
+    let currentWidth = 0;
+    for (const word of words) {
+        const w = visibleWidth(word);
+        if (current !== "" && currentWidth + w > width && !/^\s+$/.test(word)) {
+            lines.push(current);
+            current = word.replace(/^\s+/, "");
+            currentWidth = visibleWidth(current);
+            continue;
+        }
+        current += word;
+        currentWidth = visibleWidth(current);
+    }
+    if (current !== "")
+        lines.push(current);
+    if (lines.length === 0)
+        lines.push("");
+    return lines;
+}
+export function wrapWithPrefix(text, width, wrap, prefix = "") {
+    if (!wrap)
+        return text.split("\n").map((line) => prefix + line);
+    const out = [];
+    const w = Math.max(1, width - visibleWidth(prefix));
+    for (const line of text.split("\n")) {
+        const parts = wrapText(line, w, wrap);
+        for (const p of parts)
+            out.push(prefix + p);
+    }
+    return out;
+}

package/docs/spec.md

@@ -1,4 +1,4 @@
-# Markdansi v1 – Design Spec
+# Markdansi v0.1.2 – Design Spec
 
 Goal: Tiny, dependency‑light Markdown → ANSI renderer & CLI for Node ≥22, using pnpm. Output is terminal ANSI only (no HTML). Focus on readable defaults, sensible wrapping, and minimal runtime deps.
 
@@ -9,7 +9,7 @@ Goal: Tiny, dependency‑light Markdown → ANSI renderer & CLI for Node ≥22,
 - `strip-ansi`: strip codes for width/wrapping.
 - `supports-hyperlinks`: detect OSC‑8 hyperlink support.
 
-Dev: `vitest`.
+Dev: `vitest`, TypeScript (NodeNext).
 
 ## Surface Area
 ### Library (ESM default, CJS export provided)
@@ -22,12 +22,22 @@ Dev: `vitest`.
 `  width?: number;            // used only when wrap===true; default: TTY cols or 80`
 `  hyperlinks?: boolean;      // default: auto via supports-hyperlinks`
 `  color?: boolean;           // default: true if TTY; if false => no ANSI/OSC at all`
-`  theme?: ThemeName | Theme; // built-ins: default, dim, bright`
+`  theme?: ThemeName | Theme; // built-ins: default, dim, bright, solarized, monochrome, contrast`
+`  listIndent?: number;       // spaces per nesting level; default 2`
+`  quotePrefix?: string;      // blockquote line prefix; default "│ "`
+`  tableBorder?: "unicode" | "ascii" | "none"; // default unicode box drawing`
+`  tablePadding?: number;     // spaces inside cells (L/R); default 1`
+`  tableDense?: boolean;      // reduce separator rows; default false`
+`  tableTruncate?: boolean;   // truncate cells to fit col widths; default true`
+`  tableEllipsis?: string;    // truncation marker; default "…"`
+`  codeBox?: boolean;         // draw a box around fenced code; default true`
+`  codeGutter?: boolean;      // left gutter with line numbers; default false`
+`  codeWrap?: boolean;        // wrap code to width; default true`
 `  highlighter?: (code: string, lang?: string) => string; // hook, must not add newlines`
 `}``
 
-`type Theme = { heading, strong, emph, inlineCode, blockCode, code?, link, quote, hr, listMarker, tableHeader, tableCell }`
-Each theme entry holds simple SGR intents (bold/italic/fg color names). `inlineCode` / `blockCode` are used if present; otherwise `code` acts as a fallback for both.
+`type Theme = { heading, strong, emph, inlineCode, blockCode, code?, link, quote, hr, listMarker, tableHeader, tableCell, tableBorder, tableSeparator }`
+Each theme entry holds simple SGR intents (bold/italic/fg color names). `inlineCode` / `blockCode` are used if present; otherwise `code` acts as a fallback for both. Theme exposes defaults for table borders/separators; caller can override per render via options above.
 
 `strip(markdown: string): string` — convenience: render with `color=false`, `hyperlinks=false`.
 
@@ -41,9 +51,9 @@ Each theme entry holds simple SGR intents (bold/italic/fg color names). `inlineC
 ## Feature Scope (v1)
 - Blocks: paragraphs, headings (1–6), blockquotes, fenced/indented code blocks, HR, tables, unordered/ordered lists, task lists.
 - Inline: strong, emphasis, code spans, autolinks/links, strikethrough (GFM `~~`), backslash escapes.
-- Code blocks: monospace dim box; if `lang` present, show a faint `[lang]` tag. Highlighter hook may recolor text but must not add/remove newlines. Code blocks never hard-wrap; long lines may overflow.
-- Tables: render with simple ASCII borders; align based on GFM alignment; wrap cell text respecting width.
-- Wrapping: word-wrap on spaces; uses `string-width` on stripped text. Preserve hard breaks; words longer than width are allowed to overflow. Code blocks ignore wrap.
+- Code blocks: monospace box (unicode or ascii; `codeBox=false` disables). Optional gutter with 1‑based line numbers when `codeGutter=true`. If `lang` present, show faint header label. Highlighter hook may recolor text but must not add/remove newlines. Code blocks wrap to the available width by default (hard-wrap long tokens); set `codeWrap=false` to allow overflow.
+- Tables: box-drawing (unicode default, ascii or none). Respect GFM alignment per column, pad cells by `tablePadding`, optional dense borders. Can truncate cell text (`tableTruncate=true`, `tableEllipsis` marker) to keep width. Width balancing shrinks columns while possible; if still too wide, cells overflow.
+- Wrapping: word-wrap on spaces; uses `string-width` on stripped text. Preserve hard breaks; words longer than width may overflow. Code blocks wrap by default; turn off with `codeWrap=false`.
 - Hyperlinks: OSC‑8 when supported and allowed; fallback to underlined text plus URL in parentheses.
 - Error handling: never throw on malformed emphasis; leave literals untouched if unmatched.
 
@@ -57,9 +67,12 @@ Each theme entry holds simple SGR intents (bold/italic/fg color names). `inlineC
    - Track active SGR for wrapping splits to re-open styles on new lines.
 
 ## Themes (initial)
-- `default`: bold headings, blue links, cyan code, subtle quotes/hr.
+- `default`: bold headings, blue links, cyan inline code, green block code, yellow table headers, subtle quotes/hr.
 - `dim`: muted colors for low-contrast terminals.
 - `bright`: higher contrast variant.
+- `solarized`: yellow headings, cyan inline, teal block code, blue links, yellow headers.
+- `monochrome`: bold/italic cues only, dim code, underlined links.
+- `contrast`: magenta headings, cyan inline, green block code, yellow headers, bright markers.
 
 ## Testing (vitest)
 - Unit: inline formatting (emph/strong/code/strike), links/hyperlinks on/off, wrap/no-wrap behavior, table alignment and wrapping, task lists, strikethrough.
@@ -77,7 +90,8 @@ Each theme entry holds simple SGR intents (bold/italic/fg color names). `inlineC
 - Color flag: `color=false` removes all ANSI/OSC output (no bold/italic/underline, no hyperlinks); output is plain text.
 - Hyperlinks fallback: inline links render as `label (url)` when OSC‑8 disabled; autolinks render as the URL only. URLs count toward width.
 - Highlighter hook: receives raw code and optional lang; may return ANSI-colored text but must not add or remove newlines. Markdansi owns indentation/padding; code blocks never hard-wrap.
-- Tables width algorithm: compute desired column widths from content (cap at e.g. 40). While total exceeds width, decrement widest columns until it fits; if even minimums won’t fit, allow overflow. Respect GFM alignment per column. Cells with newlines keep those breaks.
+- Tables width algorithm: compute desired column widths from content (cap at e.g. 40). While total exceeds width, decrement widest columns until it fits; if even minimums won’t fit, allow overflow. Respect GFM alignment per column. Cells with newlines keep those breaks. Optional truncation shortens cells before layout with `tableEllipsis`.
 - Lists: honor GFM tight vs loose lists (tight => no blank line between items; loose => blank line). Nesting indent = 2 spaces per level; bullets use `-`; ordered lists use input numbering.
 - Blockquotes: prefix each wrapped line with `│ ` (configurable via `quotePrefix`); quote content wraps accounting for the prefix width.
 - List indent is configurable via `listIndent` (default 2 spaces per level).
+- Reference-style definitions with indented title continuations are merged into a single paragraph (instead of becoming indented code blocks), preventing stray boxed output in copied logs.

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "markdansi",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Tiny dependency-light markdown to ANSI converter.",
   "type": "module",
-  "main": "src/index.js",
+  "main": "dist/index.js",
   "exports": {
     ".": {
-      "import": "./src/index.js"
+      "import": "./dist/index.js"
     },
-    "./cli": "./src/cli.js"
+    "./cli": "./dist/cli.js"
   },
   "bin": {
-    "markdansi": "./src/cli.js"
+    "markdansi": "./dist/cli.js"
   },
   "keywords": [
     "markdown",
@@ -34,14 +34,12 @@
   "license": "MIT",
   "sideEffects": false,
   "files": [
-    "src",
     "dist",
     "README.md",
     "docs/spec.md",
     "package.json",
     "tsconfig.json",
-    ".biome.json",
-    "types"
+    ".biome.json"
   ],
   "types": "dist/index.d.ts",
   "dependencies": {
@@ -57,17 +55,21 @@
   },
   "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",
+    "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"
+    "types": "tsc -p tsconfig.json --emitDeclarationOnly",
+    "compile": "tsc -p tsconfig.json",
+    "markdansi": "tsx src/cli.ts"
   }
 }

package/tsconfig.json

@@ -4,16 +4,14 @@
 		"noUncheckedIndexedAccess": true,
 		"exactOptionalPropertyTypes": true,
 		"noPropertyAccessFromIndexSignature": true,
-		"allowJs": true,
-		"checkJs": true,
 		"declaration": true,
-		"emitDeclarationOnly": true,
 		"outDir": "dist",
+		"rootDir": "src",
 		"module": "NodeNext",
 		"moduleResolution": "NodeNext",
 		"target": "ES2022",
 		"resolveJsonModule": true
 	},
-	"include": ["types/**/*.ts"],
+	"include": ["src/**/*.ts"],
 	"exclude": ["node_modules", "dist", "coverage"]
 }

package/src/cli.js

@@ -1,62 +0,0 @@
-#!/usr/bin/env node
-import fs from "node:fs";
-import path from "node:path";
-import { render } from "./index.js";
-
-function parseArgs(argv) {
-	const args = {};
-	for (let i = 2; i < argv.length; i += 1) {
-		const a = argv[i];
-		if (a === "--no-wrap") args.wrap = false;
-		else if (a === "--no-color") args.color = false;
-		else if (a === "--no-links") args.hyperlinks = false;
-		else if (a === "--in") args.in = argv[++i];
-		else if (a === "--out") args.out = argv[++i];
-		else if (a === "--width") args.width = Number(argv[++i]);
-		else if (a.startsWith("--theme=")) args.theme = a.split("=")[1];
-		else if (a === "--list-indent") args.listIndent = Number(argv[++i]);
-		else if (a === "--quote-prefix") args.quotePrefix = argv[++i];
-		else if (a === "--help" || a === "-h") args.help = true;
-	}
-	return args;
-}
-
-function main() {
-	const args = parseArgs(process.argv);
-	if (args.help) {
-		process.stdout.write(`markdansi options:
-  --in FILE           Input file (default: stdin)
-  --out FILE          Output file (default: stdout)
-  --width N           Wrap width (default: TTY cols or 80)
-  --no-wrap           Disable hard wrapping
-  --no-color          Disable ANSI/OSC output
-  --no-links          Disable OSC-8 hyperlinks
-  --theme NAME        Theme (default|dim|bright)
-  --list-indent N     Spaces per list nesting level (default: 2)
-  --quote-prefix STR  Prefix for blockquotes (default: "│ ")
-`);
-		process.exit(0);
-	}
-	const input =
-		args.in && args.in !== "-"
-			? fs.readFileSync(path.resolve(args.in), "utf8")
-			: fs.readFileSync(0, "utf8");
-
-	const output = render(input, {
-		wrap: args.wrap,
-		width: args.width,
-		color: args.color,
-		hyperlinks: args.hyperlinks,
-		theme: args.theme,
-		listIndent: args.listIndent,
-		quotePrefix: args.quotePrefix,
-	});
-
-	if (args.out) {
-		fs.writeFileSync(path.resolve(args.out), output, "utf8");
-	} else {
-		process.stdout.write(output);
-	}
-}
-
-main();

package/src/hyperlink.js

@@ -1,15 +0,0 @@
-import supportsHyperlinks from "supports-hyperlinks";
-
-/**
- * Detect OSC-8 hyperlink support for a given stream (defaults to stdout).
- */
-export function hyperlinkSupported(stream = process.stdout) {
-	if (supportsHyperlinks && typeof supportsHyperlinks.stdout === "function") {
-		return supportsHyperlinks.stdout(stream);
-	}
-	return false;
-}
-
-export function osc8(url, text) {
-	return `\u001B]8;;${url}\u0007${text}\u001B]8;;\u0007`;
-}

package/src/index.js

@@ -1,12 +0,0 @@
-import { createRenderer, render as renderMarkdown } from "./render.js";
-import { themes } from "./theme.js";
-
-export { renderMarkdown as render, createRenderer, themes };
-
-export function strip(markdown, options = {}) {
-	return renderMarkdown(markdown, {
-		...options,
-		color: false,
-		hyperlinks: false,
-	});
-}