ironmark 1.12.2 → 1.13.0

package/README.md

@@ -195,19 +195,19 @@ const html = parse("# Hello\n\nThis is **fast**.");
 
 ## CLI
 
-Render Markdown as coloured terminal output. Two ways to install:
+Render Markdown as HTML, ANSI terminal output, or an AST. Default format is `html`.
 
 ### npm
 
 ```bash
-npx ironmark --ansi README.md
+npx ironmark README.md
 ```
 
 Or install globally:
 
 ```bash
 npm install -g ironmark
-ironmark --ansi README.md
+ironmark README.md
 ```
 
 ### Rust
@@ -216,47 +216,56 @@ Native binary — faster startup, auto-detects terminal width via `$COLUMNS` / `
 
 ```bash
 cargo install ironmark --features cli
-ironmark --ansi README.md
+ironmark README.md
 ```
 
 ### Options
 
-Both CLIs support the same flags (the npm CLI requires `--ansi` as the first flag):
+Both CLIs support the same flags:
 
 ```text
-OPTIONS:
+OPTIONS (all formats):
+    --format <html|ansi|ast>  Output format; ast also accepts 'json' (default: html)
+    --no-hard-breaks          Don't turn soft newlines into hard line breaks
+    --no-tables               Disable pipe table syntax
+    --no-highlight            Disable ==highlight== syntax
+    --no-strikethrough        Disable ~~strikethrough~~ syntax
+    --no-underline            Disable ++underline++ syntax
+    --no-autolink             Disable bare URL auto-linking
+    --no-task-lists           Disable - [x] task list syntax
+    --math                    Enable $inline$ and $$display$$ math
+    --wiki-links              Enable [[wiki link]] syntax
+    --max-size N              Truncate input to N bytes (Rust only)
+    -h, --help                Print this help and exit
+    -V, --version             Print version and exit
+
+OPTIONS (ansi format only):
     --width N            Terminal column width (default: auto-detect, fallback 80)
-    --padding N          Horizontal padding added to both sides of each line, plus ceil(padding/2) blank lines at the top (default: 0)
+    --padding N          Horizontal padding added to both sides of each line (default: 0)
     --no-color           Disable ANSI escape codes (plain text)
     -n, --line-numbers   Show line numbers in fenced code blocks
-    --no-hard-breaks     Don't turn soft newlines into hard line breaks
-    --no-tables          Disable pipe table syntax
-    --no-highlight       Disable ==highlight== syntax
-    --no-strikethrough   Disable ~~strikethrough~~ syntax
-    --no-underline       Disable ++underline++ syntax
-    --no-autolink        Disable bare URL auto-linking
-    --no-task-lists      Disable - [x] task list syntax
-    --math               Enable $inline$ and $$display$$ math
-    --wiki-links         Enable [[wiki link]] syntax
-    --max-size N         Truncate input to N bytes (Rust only)
-    -h, --help           Print this help and exit
-    -V, --version        Print version and exit
 ```
 
 ### Examples
 
 ```bash
-# npm
-npx ironmark --ansi README.md
-npx ironmark --ansi --width 120 README.md
-echo '# Hello' | npx ironmark --ansi
-npx ironmark --ansi --no-color README.md | less
+# Render as HTML (default)
+echo '# Hello' | npx ironmark
+npx ironmark README.md
+
+# Render as ANSI terminal output
+npx ironmark --format ansi README.md
+npx ironmark --format ansi --width 120 README.md
+npx ironmark --format ansi --no-color README.md | less
+
+# Render as AST (JSON)
+npx ironmark --format ast README.md
 
 # Rust (after cargo install ironmark --features cli)
-ironmark --ansi README.md
-ironmark --ansi --width 120 README.md
-echo '# Hello' | ironmark --ansi
-cat doc.md | ironmark --ansi --math --wiki-links
+echo '# Hello' | ironmark
+ironmark --format ansi README.md
+ironmark --format ansi --width 120 README.md
+cat doc.md | ironmark --format ansi --math --wiki-links
 ```
 
 ## Rust

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ironmark",
-  "version": "1.12.2",
+  "version": "1.13.0",
   "description": "Very fast markdown parser in Rust, consumable from JavaScript/TypeScript via WebAssembly",
   "keywords": [
     "markdown",
@@ -75,8 +75,8 @@
     "conventional-changelog-conventionalcommits": "^9.3.1",
     "markdown-wasm": "^1.2.0",
     "md4w": "^0.2.7",
-    "oxfmt": "^0.43.0",
-    "oxlint": "^1.58.0",
+    "oxfmt": "^0.45.0",
+    "oxlint": "^1.60.0",
     "semantic-release": "^25.0.3"
   },
   "engines": {

package/wasm/cli.js

@@ -1,49 +1,53 @@
 #!/usr/bin/env node
 import { readFileSync } from "node:fs";
-import { renderAnsi } from "./node.js";
+import { parse, parseToAst, renderAnsi } from "./node.js";
 
 const VERSION = JSON.parse(
   readFileSync(new URL("../package.json", import.meta.url), "utf8"),
 ).version;
 
-const HELP = `ironmark — render Markdown as coloured terminal output
+const HELP = `ironmark — render Markdown in various output formats
 
 USAGE:
-    ironmark --ansi [OPTIONS] [FILE...]
+    ironmark [--format <html|ansi|ast>] [OPTIONS] [FILE...]
 
     When no FILE is given, reads from stdin. Use '-' for stdin explicitly.
+    Default format is html.
 
-OPTIONS:
-    --ansi               Render as ANSI-coloured terminal output (required)
+OPTIONS (all formats):
+    --format <html|ansi|ast>  Output format; ast also accepts 'json' (default: html)
+    --no-hard-breaks          Don't turn soft newlines into hard line breaks
+    --no-tables               Disable pipe table syntax
+    --no-highlight            Disable ==highlight== syntax
+    --no-strikethrough        Disable ~~strikethrough~~ syntax
+    --no-underline            Disable ++underline++ syntax
+    --no-autolink             Disable bare URL auto-linking
+    --no-task-lists           Disable - [x] task list syntax
+    --math                    Enable $inline$ and $$display$$ math
+    --wiki-links              Enable [[wiki link]] syntax
+    -h, --help                Print this help and exit
+    -V, --version             Print version and exit
+
+OPTIONS (ansi format only):
     --width N            Terminal column width (default: auto-detect, fallback 80)
     --no-color           Disable ANSI escape codes (plain text)
     -n, --line-numbers   Show line numbers in fenced code blocks
     --padding N          Horizontal padding on both sides of output (default: 0)
-    --no-hard-breaks     Don't turn soft newlines into hard line breaks
-    --no-tables          Disable pipe table syntax
-    --no-highlight       Disable ==highlight== syntax
-    --no-strikethrough   Disable ~~strikethrough~~ syntax
-    --no-underline       Disable ++underline++ syntax
-    --no-autolink        Disable bare URL auto-linking
-    --no-task-lists      Disable - [x] task list syntax
-    --math               Enable $inline$ and $$display$$ math
-    --wiki-links         Enable [[wiki link]] syntax
-    -h, --help           Print this help and exit
-    -V, --version        Print version and exit
 
 EXAMPLES:
-    npx ironmark --ansi README.md
-    npx ironmark --ansi --width 120 README.md
-    npx ironmark --ansi --no-color README.md | less
-    echo '# Hello' | npx ironmark --ansi
-    cat doc.md | npx ironmark --ansi --math --wiki-links
+    echo '# Hello' | npx ironmark
+    echo '# Hello' | npx ironmark --format html
+    npx ironmark --format ansi README.md
+    npx ironmark --format ast README.md
+    npx ironmark --format ansi --width 120 --no-color README.md | less
+    cat doc.md | npx ironmark --format ansi --math --wiki-links
 `;
 
 const args = process.argv.slice(2);
 const files = [];
 const parseOptions = {};
 const ansiOptions = {};
-let ansiMode = false;
+let format = null;
 
 for (let i = 0; i < args.length; i++) {
   switch (args[i]) {
@@ -57,9 +61,15 @@ for (let i = 0; i < args.length; i++) {
       console.log(`ironmark ${VERSION}`);
       process.exit(0);
       break;
-    case "--ansi":
-      ansiMode = true;
+    case "--format": {
+      const val = args[++i];
+      if (val === undefined) {
+        console.error("error: --format requires a value");
+        process.exit(2);
+      }
+      format = val;
       break;
+    }
     case "--no-color":
     case "--no-colour":
       ansiOptions.color = false;
@@ -114,7 +124,9 @@ for (let i = 0; i < args.length; i++) {
       parseOptions.enableWikiLinks = true;
       break;
     default:
-      if (args[i].startsWith("--width=")) {
+      if (args[i].startsWith("--format=")) {
+        format = args[i].slice("--format=".length);
+      } else if (args[i].startsWith("--width=")) {
         const val = Number(args[i].slice("--width=".length));
         if (Number.isNaN(val)) {
           console.error("error: --width requires a numeric value");
@@ -138,13 +150,20 @@ for (let i = 0; i < args.length; i++) {
   }
 }
 
-if (!ansiMode) {
-  console.error("error: --ansi flag is required");
+const fmt = format ?? "html";
+
+if (fmt !== "html" && fmt !== "ansi" && fmt !== "ast" && fmt !== "json") {
+  console.error(`error: unknown format '${fmt}' — use html, ansi, or ast`);
+  process.exit(2);
+}
+
+if (files.length === 0 && process.stdin.isTTY) {
+  console.error("error: no input provided");
   console.error("Run 'ironmark --help' for usage.");
   process.exit(2);
 }
 
-// Auto-detect terminal width
+// Auto-detect terminal width for ansi format
 if (ansiOptions.width === undefined) {
   ansiOptions.width = process.stdout.columns || 80;
 }
@@ -168,4 +187,10 @@ if (files.length === 0) {
   }
 }
 
-process.stdout.write(renderAnsi(input, parseOptions, ansiOptions));
+if (fmt === "html") {
+  process.stdout.write(parse(input, parseOptions));
+} else if (fmt === "ansi") {
+  process.stdout.write(renderAnsi(input, parseOptions, ansiOptions));
+} else {
+  process.stdout.write(JSON.stringify(parseToAst(input, parseOptions), null, 2) + "\n");
+}