ironmark 1.9.0 → 1.10.0

package/README.md

@@ -138,23 +138,39 @@ await init(wasmUrl);
 const html = parse("# Hello\n\nThis is **fast**.");
 ```
 
-## CLI — `imcat`
+## CLI
 
-`imcat` renders Markdown files as coloured terminal output. It is built from the same ANSI renderer as `renderAnsi()`.
+Render Markdown as coloured terminal output. Two ways to install:
+
+### npm
 
 ```bash
-cargo install ironmark --bin imcat
+npx ironmark --ansi README.md
 ```
 
-```text
-USAGE:
-    imcat [OPTIONS] [FILE...]
+Or install globally:
+
+```bash
+npm install -g ironmark
+ironmark --ansi README.md
+```
+
+### Rust
 
-    When no FILE is given, reads from stdin. Use '-' for stdin explicitly.
+Native binary — faster startup, auto-detects terminal width via `$COLUMNS` / `tput cols`.
 
+```bash
+cargo install ironmark --features cli
+ironmark --ansi README.md
+```
+
+### Options
+
+Both CLIs support the same flags (the npm CLI requires `--ansi` as the first flag):
+
+```text
 OPTIONS:
-    --width N            Terminal column width for word-wrap and heading underlines
-                         (default: auto-detect via $COLUMNS / tput cols, fallback 80)
+    --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
     --no-hard-breaks     Don't turn soft newlines into hard line breaks
@@ -166,16 +182,25 @@ OPTIONS:
     --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 (0 = unlimited)
+    --max-size N         Truncate input to N bytes (Rust only)
     -h, --help           Print this help and exit
     -V, --version        Print version and exit
+```
+
+### Examples
 
-EXAMPLES:
-    imcat README.md
-    imcat --width 120 README.md
-    imcat --no-color README.md | less
-    echo '# Hello' | imcat
-    cat doc.md | imcat --math --wiki-links
+```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
+
+# 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
 ```
 
 ## Rust

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ironmark",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "description": "Very fast markdown parser in Rust, consumable from JavaScript/TypeScript via WebAssembly",
   "keywords": [
     "markdown",
@@ -17,11 +17,15 @@
     "type": "git",
     "url": "https://github.com/ph1p/ironmark.git"
   },
+  "bin": {
+    "ironmark": "wasm/cli.js"
+  },
   "files": [
     "wasm/pkg",
     "wasm/shared.js",
     "wasm/web.js",
     "wasm/node.js",
+    "wasm/cli.js",
     "wasm/index.d.ts",
     "README.md"
   ],

package/wasm/cli.js

@@ -0,0 +1,154 @@
+#!/usr/bin/env node
+import { readFileSync } from "node:fs";
+import { 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
+
+USAGE:
+    ironmark --ansi [OPTIONS] [FILE...]
+
+    When no FILE is given, reads from stdin. Use '-' for stdin explicitly.
+
+OPTIONS:
+    --ansi               Render as ANSI-coloured terminal output (required)
+    --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
+    --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
+`;
+
+const args = process.argv.slice(2);
+const files = [];
+const parseOptions = {};
+const ansiOptions = {};
+let ansiMode = false;
+
+for (let i = 0; i < args.length; i++) {
+  switch (args[i]) {
+    case "-h":
+    case "--help":
+      process.stdout.write(HELP);
+      process.exit(0);
+      break;
+    case "-V":
+    case "--version":
+      console.log(`ironmark ${VERSION}`);
+      process.exit(0);
+      break;
+    case "--ansi":
+      ansiMode = true;
+      break;
+    case "--no-color":
+    case "--no-colour":
+      ansiOptions.color = false;
+      break;
+    case "-n":
+    case "--line-numbers":
+      ansiOptions.lineNumbers = true;
+      break;
+    case "--width": {
+      const val = args[++i];
+      if (val === undefined || Number.isNaN(Number(val))) {
+        console.error("error: --width requires a numeric value");
+        process.exit(2);
+      }
+      ansiOptions.width = Number(val);
+      break;
+    }
+    case "--no-hard-breaks":
+      parseOptions.hardBreaks = false;
+      break;
+    case "--no-tables":
+      parseOptions.enableTables = false;
+      break;
+    case "--no-highlight":
+      parseOptions.enableHighlight = false;
+      break;
+    case "--no-strikethrough":
+      parseOptions.enableStrikethrough = false;
+      break;
+    case "--no-underline":
+      parseOptions.enableUnderline = false;
+      break;
+    case "--no-autolink":
+      parseOptions.enableAutolink = false;
+      break;
+    case "--no-task-lists":
+      parseOptions.enableTaskLists = false;
+      break;
+    case "--math":
+      parseOptions.enableLatexMath = true;
+      break;
+    case "--wiki-links":
+      parseOptions.enableWikiLinks = true;
+      break;
+    default:
+      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");
+          process.exit(2);
+        }
+        ansiOptions.width = val;
+      } else if (args[i].startsWith("-") && args[i] !== "-") {
+        console.error(`error: unknown flag: ${args[i]}`);
+        console.error("Run 'ironmark --help' for usage.");
+        process.exit(2);
+      } else {
+        files.push(args[i]);
+      }
+  }
+}
+
+if (!ansiMode) {
+  console.error("error: --ansi flag is required");
+  console.error("Run 'ironmark --help' for usage.");
+  process.exit(2);
+}
+
+// Auto-detect terminal width
+if (ansiOptions.width === undefined) {
+  ansiOptions.width = process.stdout.columns || 80;
+}
+
+let input = "";
+
+if (files.length === 0) {
+  input = readFileSync(0, "utf8");
+} else {
+  for (const file of files) {
+    if (file === "-") {
+      input += readFileSync(0, "utf8");
+    } else {
+      try {
+        input += readFileSync(file, "utf8");
+      } catch (err) {
+        console.error(`error: ${file}: ${err.message}`);
+        process.exit(1);
+      }
+    }
+  }
+}
+
+process.stdout.write(renderAnsi(input, parseOptions, ansiOptions));