ironmark 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Philip Stapelfeldt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,130 @@
+# ironmark
+
+Fast Markdown-to-HTML parser written in Rust. Fully compliant with [CommonMark 0.31.2](https://spec.commonmark.org/0.31.2/) (652/652 spec tests pass). Available as a Rust crate and as an npm package via WebAssembly.
+
+## Features
+
+- Zero third-party parsing dependencies
+- Headings (`#` through `######`) and setext headings
+- Paragraphs, emphasis, strong emphasis, inline code
+- ~~strikethrough~~, ==highlight==, ++underline++
+- Links, reference links, autolinks (angle-bracket and bare URL/email), images
+- Ordered and unordered lists with nesting, task lists (checkboxes)
+- Blockquotes, horizontal rules
+- Fenced and indented code blocks
+- Tables with alignment
+- Raw HTML passthrough
+- Backslash escapes and HTML entities
+
+## JavaScript / TypeScript
+
+### Install
+
+```bash
+npm install ironmark
+```
+
+### Usage
+
+```ts
+import { parse } from "ironmark";
+
+const html = parse("# Hello\n\nThis is **fast**.");
+
+const bytes = new TextEncoder().encode("# Hello from bytes");
+const html2 = parse(bytes);
+```
+
+### Options
+
+```ts
+import { parse } from "ironmark";
+
+const html = parse("line one\nline two", {
+  hardBreaks: false, // every newline becomes <br /> (default: true)
+  enableHighlight: true, // ==highlight== → <mark> (default: true)
+  enableStrikethrough: true, // ~~strike~~ → <del> (default: true)
+  enableUnderline: true, // ++underline++ → <u> (default: true)
+  enableTables: true, // pipe tables (default: true)
+  enableAutolink: true, // bare URLs & emails → <a> (default: true)
+  enableTaskLists: true, // - [ ] / - [x] checkboxes (default: true)
+});
+```
+
+### Build from source
+
+```bash
+npm run setup:wasm
+npm run build
+```
+
+| Command              | Description            |
+| -------------------- | ---------------------- |
+| `npm run setup:wasm` | Install prerequisites  |
+| `npm run build`      | Release WASM build     |
+| `npm run build:dev`  | Debug WASM build       |
+| `npm run test`       | Run Rust tests         |
+| `npm run check`      | Format check + tests   |
+| `npm run clean`      | Remove build artifacts |
+
+## Rust
+
+### Add to your project
+
+```bash
+cargo add ironmark
+```
+
+### Usage
+
+```rust
+use ironmark::{parse, ParseOptions};
+
+fn main() {
+    let html = parse("# Hello\n\nThis is **fast**.", &ParseOptions::default());
+    println!("{html}");
+}
+```
+
+### With options
+
+```rust
+use ironmark::{parse, ParseOptions};
+
+fn main() {
+    let options = ParseOptions {
+        hard_breaks: true,
+        enable_strikethrough: false, // disable ~~strikethrough~~
+        enable_autolink: true,      // bare URLs & emails → <a>
+        enable_task_lists: true,    // - [ ] / - [x] checkboxes
+        ..Default::default()
+    };
+
+    let html = parse("line one\nline two", &options);
+    println!("{html}");
+}
+```
+
+## Benchmarks
+
+```bash
+cd benchmark
+npm install
+node bench.mjs
+```
+
+## Troubleshooting
+
+### `wasm32-unknown-unknown target not found` with Homebrew Rust
+
+The build scripts prepend `$HOME/.cargo/bin` to `PATH` so that rustup-managed binaries take priority. If the error persists:
+
+```bash
+npm run setup:wasm
+```
+
+### `wasm-bindgen` not found
+
+```bash
+npm run setup:wasm
+```

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "ironmark",
+  "version": "0.1.0",
+  "description": "Very fast markdown parser in Rust, consumable from JavaScript/TypeScript via WebAssembly",
+  "keywords": [
+    "markdown",
+    "parser",
+    "rust",
+    "wasm"
+  ],
+  "homepage": "https://github.com/ph1p/ironmark",
+  "bugs": {
+    "url": "https://github.com/ph1p/ironmark/issues"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ph1p/ironmark.git"
+  },
+  "files": [
+    "wasm/pkg",
+    "wasm/index.js",
+    "wasm/index.d.ts",
+    "README.md"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "main": "wasm/index.js",
+  "types": "wasm/index.d.ts",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@semantic-release/commit-analyzer": "^13.0.1",
+    "@semantic-release/exec": "^7.1.0",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^12.0.6",
+    "@semantic-release/npm": "^13.1.4",
+    "@semantic-release/release-notes-generator": "^14.1.0",
+    "oxfmt": "^0.35.0",
+    "oxlint": "^1.50.0",
+    "semantic-release": "^25.0.3"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "prepack": "npm run build",
+  "scripts": {
+    "build": "npm run build:wasm",
+    "build:dev": "PATH=\"$PWD/.wasm-tools/bin:$HOME/.cargo/bin:$PATH\" cargo build -p ironmark-wasm --target wasm32-unknown-unknown && PATH=\"$PWD/.wasm-tools/bin:$HOME/.cargo/bin:$PATH\" wasm-bindgen --target bundler --out-dir wasm/pkg --out-name ironmark target/wasm32-unknown-unknown/debug/ironmark.wasm",
+    "build:wasm": "PATH=\"$PWD/.wasm-tools/bin:$HOME/.cargo/bin:$PATH\" cargo build -p ironmark-wasm --release --target wasm32-unknown-unknown && PATH=\"$PWD/.wasm-tools/bin:$HOME/.cargo/bin:$PATH\" wasm-bindgen --target bundler --out-dir wasm/pkg --out-name ironmark target/wasm32-unknown-unknown/release/ironmark.wasm && wasm-opt --enable-bulk-memory -O3 wasm/pkg/ironmark_bg.wasm -o wasm/pkg/ironmark_bg.wasm",
+    "check": "cargo fmt --check && cargo test --offline && oxlint && oxfmt --check .",
+    "clean": "rm -rf wasm/pkg .wasm-tools",
+    "fmt": "cargo fmt && oxfmt --write .",
+    "lint": "oxlint",
+    "release": "semantic-release",
+    "release:dry": "semantic-release --dry-run",
+    "setup:wasm": "PATH=\"$HOME/.cargo/bin:$PATH\" rustup target add wasm32-unknown-unknown && TMPDIR=/tmp PATH=\"$HOME/.cargo/bin:$PATH\" cargo install wasm-bindgen-cli --locked --root .wasm-tools",
+    "test": "cargo test --offline"
+  }
+}

package/wasm/index.d.ts

@@ -0,0 +1,27 @@
+export type MarkdownInput = string | Uint8Array | ArrayBuffer | ArrayBufferView;
+
+export interface ParseOptions {
+  /** When true, every newline in a paragraph becomes a hard line break (`<br />`). Default: true. */
+  hardBreaks?: boolean;
+  /** Enable ==highlight== syntax for `<mark>`. Default: true. */
+  enableHighlight?: boolean;
+  /** Enable ~~strikethrough~~ syntax for `<del>`. Default: true. */
+  enableStrikethrough?: boolean;
+  /** Enable ++underline++ syntax for `<u>`. Default: true. */
+  enableUnderline?: boolean;
+  /** Enable pipe table syntax. Default: true. */
+  enableTables?: boolean;
+  /** Automatically detect bare URLs and emails and wrap them in links. Default: true. */
+  enableAutolink?: boolean;
+  /** Enable GitHub-style task lists (`- [ ] unchecked`, `- [x] checked`). Default: true. */
+  enableTaskLists?: boolean;
+}
+
+/**
+ * Parse Markdown to HTML.
+ *
+ * @param markdown - Markdown source (string or binary).
+ * @param options - Optional parsing options.
+ * @returns HTML string.
+ */
+export declare function parse(markdown: MarkdownInput, options?: ParseOptions): string;

package/wasm/index.js

@@ -0,0 +1,27 @@
+import { parse as wasmParse } from "./pkg/ironmark.js";
+
+const decoder = new TextDecoder("utf-8");
+
+function toStr(markdown) {
+  if (typeof markdown === "string") return markdown;
+  if (markdown instanceof Uint8Array) return decoder.decode(markdown);
+  if (markdown instanceof ArrayBuffer) return decoder.decode(new Uint8Array(markdown));
+  if (ArrayBuffer.isView(markdown))
+    return decoder.decode(
+      new Uint8Array(markdown.buffer, markdown.byteOffset, markdown.byteLength),
+    );
+  throw new TypeError("markdown must be a string, Uint8Array, ArrayBuffer, or Buffer");
+}
+
+export function parse(markdown, options) {
+  return wasmParse(
+    toStr(markdown),
+    options?.hardBreaks ?? undefined,
+    options?.enableHighlight ?? undefined,
+    options?.enableStrikethrough ?? undefined,
+    options?.enableUnderline ?? undefined,
+    options?.enableTables ?? undefined,
+    options?.enableAutolink ?? undefined,
+    options?.enableTaskLists ?? undefined,
+  );
+}

package/wasm/pkg/ironmark.d.ts

@@ -0,0 +1,4 @@
+/* tslint:disable */
+/* eslint-disable */
+
+export function parse(markdown: string, hard_breaks?: boolean | null, enable_highlight?: boolean | null, enable_strikethrough?: boolean | null, enable_underline?: boolean | null, enable_tables?: boolean | null, enable_autolink?: boolean | null, enable_task_lists?: boolean | null): string;

package/wasm/pkg/ironmark.js

@@ -0,0 +1,9 @@
+/* @ts-self-types="./ironmark.d.ts" */
+
+import * as wasm from "./ironmark_bg.wasm";
+import { __wbg_set_wasm } from "./ironmark_bg.js";
+__wbg_set_wasm(wasm);
+
+export {
+    parse
+} from "./ironmark_bg.js";

package/wasm/pkg/ironmark_bg.js

@@ -0,0 +1,125 @@
+/**
+ * @param {string} markdown
+ * @param {boolean | null} [hard_breaks]
+ * @param {boolean | null} [enable_highlight]
+ * @param {boolean | null} [enable_strikethrough]
+ * @param {boolean | null} [enable_underline]
+ * @param {boolean | null} [enable_tables]
+ * @param {boolean | null} [enable_autolink]
+ * @param {boolean | null} [enable_task_lists]
+ * @returns {string}
+ */
+export function parse(markdown, hard_breaks, enable_highlight, enable_strikethrough, enable_underline, enable_tables, enable_autolink, enable_task_lists) {
+    let deferred2_0;
+    let deferred2_1;
+    try {
+        const retptr = wasm.__wbindgen_add_to_stack_pointer(-16);
+        const ptr0 = passStringToWasm0(markdown, wasm.__wbindgen_export, wasm.__wbindgen_export2);
+        const len0 = WASM_VECTOR_LEN;
+        wasm.parse(retptr, ptr0, len0, isLikeNone(hard_breaks) ? 0xFFFFFF : hard_breaks ? 1 : 0, isLikeNone(enable_highlight) ? 0xFFFFFF : enable_highlight ? 1 : 0, isLikeNone(enable_strikethrough) ? 0xFFFFFF : enable_strikethrough ? 1 : 0, isLikeNone(enable_underline) ? 0xFFFFFF : enable_underline ? 1 : 0, isLikeNone(enable_tables) ? 0xFFFFFF : enable_tables ? 1 : 0, isLikeNone(enable_autolink) ? 0xFFFFFF : enable_autolink ? 1 : 0, isLikeNone(enable_task_lists) ? 0xFFFFFF : enable_task_lists ? 1 : 0);
+        var r0 = getDataViewMemory0().getInt32(retptr + 4 * 0, true);
+        var r1 = getDataViewMemory0().getInt32(retptr + 4 * 1, true);
+        deferred2_0 = r0;
+        deferred2_1 = r1;
+        return getStringFromWasm0(r0, r1);
+    } finally {
+        wasm.__wbindgen_add_to_stack_pointer(16);
+        wasm.__wbindgen_export3(deferred2_0, deferred2_1, 1);
+    }
+}
+let cachedDataViewMemory0 = null;
+function getDataViewMemory0() {
+    if (cachedDataViewMemory0 === null || cachedDataViewMemory0.buffer.detached === true || (cachedDataViewMemory0.buffer.detached === undefined && cachedDataViewMemory0.buffer !== wasm.memory.buffer)) {
+        cachedDataViewMemory0 = new DataView(wasm.memory.buffer);
+    }
+    return cachedDataViewMemory0;
+}
+
+function getStringFromWasm0(ptr, len) {
+    ptr = ptr >>> 0;
+    return decodeText(ptr, len);
+}
+
+let cachedUint8ArrayMemory0 = null;
+function getUint8ArrayMemory0() {
+    if (cachedUint8ArrayMemory0 === null || cachedUint8ArrayMemory0.byteLength === 0) {
+        cachedUint8ArrayMemory0 = new Uint8Array(wasm.memory.buffer);
+    }
+    return cachedUint8ArrayMemory0;
+}
+
+function isLikeNone(x) {
+    return x === undefined || x === null;
+}
+
+function passStringToWasm0(arg, malloc, realloc) {
+    if (realloc === undefined) {
+        const buf = cachedTextEncoder.encode(arg);
+        const ptr = malloc(buf.length, 1) >>> 0;
+        getUint8ArrayMemory0().subarray(ptr, ptr + buf.length).set(buf);
+        WASM_VECTOR_LEN = buf.length;
+        return ptr;
+    }
+
+    let len = arg.length;
+    let ptr = malloc(len, 1) >>> 0;
+
+    const mem = getUint8ArrayMemory0();
+
+    let offset = 0;
+
+    for (; offset < len; offset++) {
+        const code = arg.charCodeAt(offset);
+        if (code > 0x7F) break;
+        mem[ptr + offset] = code;
+    }
+    if (offset !== len) {
+        if (offset !== 0) {
+            arg = arg.slice(offset);
+        }
+        ptr = realloc(ptr, len, len = offset + arg.length * 3, 1) >>> 0;
+        const view = getUint8ArrayMemory0().subarray(ptr + offset, ptr + len);
+        const ret = cachedTextEncoder.encodeInto(arg, view);
+
+        offset += ret.written;
+        ptr = realloc(ptr, len, offset, 1) >>> 0;
+    }
+
+    WASM_VECTOR_LEN = offset;
+    return ptr;
+}
+
+let cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
+cachedTextDecoder.decode();
+const MAX_SAFARI_DECODE_BYTES = 2146435072;
+let numBytesDecoded = 0;
+function decodeText(ptr, len) {
+    numBytesDecoded += len;
+    if (numBytesDecoded >= MAX_SAFARI_DECODE_BYTES) {
+        cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true, fatal: true });
+        cachedTextDecoder.decode();
+        numBytesDecoded = len;
+    }
+    return cachedTextDecoder.decode(getUint8ArrayMemory0().subarray(ptr, ptr + len));
+}
+
+const cachedTextEncoder = new TextEncoder();
+
+if (!('encodeInto' in cachedTextEncoder)) {
+    cachedTextEncoder.encodeInto = function (arg, view) {
+        const buf = cachedTextEncoder.encode(arg);
+        view.set(buf);
+        return {
+            read: arg.length,
+            written: buf.length
+        };
+    };
+}
+
+let WASM_VECTOR_LEN = 0;
+
+
+let wasm;
+export function __wbg_set_wasm(val) {
+    wasm = val;
+}

package/wasm/pkg/ironmark_bg.wasm.d.ts

@@ -0,0 +1,8 @@
+/* tslint:disable */
+/* eslint-disable */
+export const memory: WebAssembly.Memory;
+export const parse: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number) => void;
+export const __wbindgen_add_to_stack_pointer: (a: number) => number;
+export const __wbindgen_export: (a: number, b: number) => number;
+export const __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
+export const __wbindgen_export3: (a: number, b: number, c: number) => void;