markdansi 0.1.0 → 0.1.1

package/README.md

@@ -1,14 +1,12 @@
-# Markdansi
+# 🎨 Markdansi: Wraps, colors, links - no baggage.
+![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)
 
-🎨 Markdansi: Wraps, colors, links—no baggage.  
-![npm unpublished](https://img.shields.io/badge/npm-unpublished-lightgrey) ![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).
+Published on npm as `markdansi`.
 
 ## Install
 
-> Not yet published to npm (name available as of November 16, 2025). Install from git or local path until released.
-
 ```bash
 pnpm add markdansi
 # or
@@ -60,21 +58,25 @@ console.log(custom('`inline`\n\n```\nblock code\n```'));
 - `width`: used only when `wrap===true`; default TTY columns or 80.
 - `color` (default TTY): `false` removes all ANSI/OSC.
 - `hyperlinks` (default auto): enable/disable OSC‑8 links.
-- `theme`: `default | dim | bright` or custom theme object.
+- `theme`: `default | dim | bright | solarized | monochrome | contrast` or custom theme object.
 - `listIndent`: spaces per nesting level (default 2).
 - `quotePrefix`: blockquote line prefix (default `│ `).
+- `tableBorder`: `unicode` (default) | `ascii` | `none`.
+- `tablePadding`: spaces inside cells (default 1); `tableDense` drops extra separators.
+- `tableTruncate`: cap cells to column width (default `true`, ellipsis `…`).
+- `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.0`  
+Version: `0.1.1` (released)  
 Tests: `pnpm test`  
 License: MIT
 
 ## Notes
 
-- Code blocks never hard‑wrap; long lines may overflow. If `lang` is present, a faint `[lang]` label is shown.
-- Tables are ASCII boxed, align using GFM alignment, and wrap cell text on spaces; very long words may overflow.
+- 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.
+- 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

package/dist/cli.d.ts

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+import type { RenderOptions } from "./types.js";
+type CliArgs = Partial<RenderOptions> & {
+    in?: string;
+    out?: string;
+    help?: boolean;
+};
+/**
+ * Parse CLI arguments into RenderOptions-ish object (plus in/out paths).
+ */
+export declare function parseArgs(argv: string[]): CliArgs;
+export {};

package/dist/cli.js

@@ -0,0 +1,151 @@
+#!/usr/bin/env node
+import fs from "node:fs";
+import path from "node:path";
+import { pathToFileURL } from "node:url";
+import { render } from "./index.js";
+/**
+ * Parse CLI arguments into RenderOptions-ish object (plus in/out paths).
+ */
+export function parseArgs(argv) {
+    const args = {};
+    for (let i = 2; i < argv.length; i += 1) {
+        const a = argv[i];
+        if (!a)
+            continue;
+        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 === "--code-wrap=false")
+            args.codeWrap = false;
+        else if (a === "--code-wrap=true")
+            args.codeWrap = true;
+        else if (a === "--code-box=false")
+            args.codeBox = false;
+        else if (a === "--code-box=true")
+            args.codeBox = true;
+        else if (a === "--code-gutter=true")
+            args.codeGutter = true;
+        else if (a === "--code-gutter=false")
+            args.codeGutter = false;
+        else if (a.startsWith("--table-border=")) {
+            const val = a.split("=")[1];
+            if (val === "unicode" || val === "ascii" || val === "none")
+                args.tableBorder = val;
+        }
+        else if (a === "--table-dense")
+            args.tableDense = true;
+        else if (a === "--table-truncate=false")
+            args.tableTruncate = false;
+        else if (a === "--table-truncate=true")
+            args.tableTruncate = true;
+        else if (a === "--table-padding") {
+            const next = argv[i + 1];
+            if (next)
+                args.tablePadding = Number(next);
+            i += 1;
+        }
+        else if (a === "--table-ellipsis") {
+            const next = argv[i + 1];
+            if (next)
+                args.tableEllipsis = next;
+            i += 1;
+        }
+        else if (a === "--in") {
+            const next = argv[i + 1];
+            if (next)
+                args.in = next;
+            i += 1;
+        }
+        else if (a === "--out") {
+            const next = argv[i + 1];
+            if (next)
+                args.out = next;
+            i += 1;
+        }
+        else if (a === "--width") {
+            const next = argv[i + 1];
+            if (next)
+                args.width = Number(next);
+            i += 1;
+        }
+        else if (a.startsWith("--theme=")) {
+            const themeVal = a.split("=")[1];
+            if (themeVal)
+                args.theme = themeVal;
+        }
+        else if (a === "--list-indent") {
+            const next = argv[i + 1];
+            if (next)
+                args.listIndent = Number(next);
+            i += 1;
+        }
+        else if (a === "--quote-prefix") {
+            const next = argv[i + 1];
+            if (next)
+                args.quotePrefix = next;
+            i += 1;
+        }
+        else if (a === "--help" || a === "-h")
+            args.help = true;
+    }
+    return args;
+}
+/**
+ * CLI entrypoint.
+ */
+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: "│ ")
+  --table-border STR  unicode|ascii|none
+  --table-padding N   Spaces around table cell content
+  --table-dense       Fewer separator rows
+  --table-truncate    Default true; pass --table-truncate=false to disable
+  --table-ellipsis STR  Ellipsis text for truncation
+  --code-wrap[=true|false]   Wrap code lines (default true)
+  --code-box[=true|false]    Box code blocks (default true)
+  --code-gutter[=true|false] Show code line numbers (default false)
+`);
+        process.exit(0);
+    }
+    const input = args.in && args.in !== "-"
+        ? fs.readFileSync(path.resolve(args.in), "utf8")
+        : fs.readFileSync(0, "utf8");
+    const renderOptions = {
+        ...(args.wrap !== undefined ? { wrap: args.wrap } : {}),
+        ...(args.width !== undefined ? { width: args.width } : {}),
+        ...(args.color !== undefined ? { color: args.color } : {}),
+        ...(args.hyperlinks !== undefined ? { hyperlinks: args.hyperlinks } : {}),
+        ...(args.theme !== undefined ? { theme: args.theme } : {}),
+        ...(args.listIndent !== undefined ? { listIndent: args.listIndent } : {}),
+        ...(args.quotePrefix !== undefined
+            ? { quotePrefix: args.quotePrefix }
+            : {}),
+    };
+    const output = render(input, renderOptions);
+    if (args.out) {
+        fs.writeFileSync(path.resolve(args.out), output, "utf8");
+    }
+    else {
+        process.stdout.write(output);
+    }
+}
+// Only run the CLI when executed directly, not when imported for tests.
+const entryHref = process.argv[1]
+    ? pathToFileURL(process.argv[1]).href
+    : undefined;
+if (import.meta.url === entryHref) {
+    main();
+}

package/dist/hyperlink.d.ts

@@ -0,0 +1,9 @@
+import type { WriteStream } from "node:tty";
+/**
+ * Detect OSC-8 hyperlink support for a given stream (defaults to stdout).
+ */
+export declare function hyperlinkSupported(stream?: WriteStream): boolean;
+/**
+ * Build an OSC-8 hyperlink sequence.
+ */
+export declare function osc8(url: string, text: string): string;

package/{src → dist}/hyperlink.js

@@ -1,15 +1,16 @@
 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;
+    const helper = supportsHyperlinks;
+    if (helper.stdout)
+        return helper.stdout(stream);
+    return false;
 }
-
+/**
+ * Build an OSC-8 hyperlink sequence.
+ */
 export function osc8(url, text) {
-	return `\u001B]8;;${url}\u0007${text}\u001B]8;;\u0007`;
+    return `\u001B]8;;${url}\u0007${text}\u001B]8;;\u0007`;
 }

package/dist/index.d.ts

@@ -1,46 +1,9 @@
-export type ColorName = "black" | "red" | "green" | "yellow" | "blue" | "magenta" | "cyan" | "white" | `#${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;
-    highlighter?: Highlighter;
-}
-export declare function render(markdown: string, options?: RenderOptions): string;
-export declare function createRenderer(options?: RenderOptions): (markdown: string) => string;
+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 type { RenderOptions, Theme, ThemeName };
+/**
+ * Render Markdown to plain text (no ANSI, no hyperlinks) while preserving layout/wrapping.
+ */
 export declare function strip(markdown: string, options?: RenderOptions): string;
-export declare const themes: Record<ThemeName | string, Theme>;

package/dist/index.js

@@ -0,0 +1,15 @@
+import { createRenderer, render as renderMarkdown } from "./render.js";
+import { themes } from "./theme.js";
+export { renderMarkdown as render, createRenderer, themes };
+/**
+ * Render Markdown to plain text (no ANSI, no hyperlinks) while preserving layout/wrapping.
+ */
+export function strip(markdown, options = {}) {
+    return renderMarkdown(markdown, {
+        ...options,
+        color: false,
+        hyperlinks: false,
+        // ensure flags like codeWrap/tableTruncate not lost
+        wrap: options.wrap ?? true,
+    });
+}

package/dist/parser.d.ts

@@ -0,0 +1,2 @@
+import type { Root } from "mdast";
+export declare function parse(markdown: string): Root;

package/{src → dist}/parser.js

@@ -1,10 +1,9 @@
 import { fromMarkdown } from "mdast-util-from-markdown";
 import { gfmFromMarkdown } from "mdast-util-gfm";
 import { gfm as gfmSyntax } from "micromark-extension-gfm";
-
 export function parse(markdown) {
-	return fromMarkdown(markdown, {
-		extensions: [gfmSyntax()],
-		mdastExtensions: [gfmFromMarkdown()],
-	});
+    return fromMarkdown(markdown, {
+        extensions: [gfmSyntax()],
+        mdastExtensions: [gfmFromMarkdown()],
+    });
 }

package/dist/render.d.ts

@@ -0,0 +1,9 @@
+import type { RenderOptions } from "./types.js";
+/**
+ * Render Markdown input to an ANSI string.
+ */
+export declare function render(markdown: string, userOptions?: RenderOptions): string;
+/**
+ * Create a reusable renderer with fixed options.
+ */
+export declare function createRenderer(options?: RenderOptions): (md: string) => string;