ironmark 1.1.0 → 1.1.2

package/README.md

@@ -1,30 +1,32 @@
 # 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
+[![CI](https://github.com/ph1p/ironmark/actions/workflows/ci.yml/badge.svg)](https://github.com/ph1p/ironmark/actions/workflows/ci.yml) [![npm](https://img.shields.io/npm/v/ironmark)](https://www.npmjs.com/package/ironmark) [![crates.io](https://img.shields.io/crates/v/ironmark)](https://crates.io/crates/ironmark)
 
-## JavaScript / TypeScript
+Fast Markdown-to-HTML parser written in Rust with **zero third-party** parsing dependencies. 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.
+
+## Options
+
+All options default to `true`.
+
+| Option        | JS (`camelCase`)      | Rust (`snake_case`)    | Description                    |
+| ------------- | --------------------- | ---------------------- | ------------------------------ |
+| Hard breaks   | `hardBreaks`          | `hard_breaks`          | Every newline becomes `<br />` |
+| Highlight     | `enableHighlight`     | `enable_highlight`     | `==text==` → `<mark>`          |
+| Strikethrough | `enableStrikethrough` | `enable_strikethrough` | `~~text~~` → `<del>`           |
+| Underline     | `enableUnderline`     | `enable_underline`     | `++text++` → `<u>`             |
+| Tables        | `enableTables`        | `enable_tables`        | Pipe table syntax              |
+| Autolink      | `enableAutolink`      | `enable_autolink`      | Bare URLs & emails → `<a>`     |
+| Task lists    | `enableTaskLists`     | `enable_task_lists`    | `- [ ]` / `- [x]` checkboxes   |
 
-### Install
+## JavaScript / TypeScript
 
 ```bash
 npm install ironmark
+# or
+pnpm add ironmark
 ```
 
-### Usage (Node.js)
+### Node.js
 
 WASM is embedded and loaded synchronously — no `init()` needed:
 
@@ -32,14 +34,11 @@ WASM is embedded and loaded synchronously — no `init()` needed:
 import { parse } from "ironmark";
 
 const html = parse("# Hello\n\nThis is **fast**.");
-
-const bytes = new TextEncoder().encode("# Hello from bytes");
-const html2 = parse(bytes);
 ```
 
-### Usage (Browser / Bundler)
+### Browser / Bundler
 
-Call `init()` once before using `parse()`:
+Call `init()` once before using `parse()`. It's idempotent and optionally accepts a custom `.wasm` URL.
 
 ```ts
 import { init, parse } from "ironmark";
@@ -49,90 +48,59 @@ await init();
 const html = parse("# Hello\n\nThis is **fast**.");
 ```
 
-`init()` is idempotent (safe to call multiple times) and can optionally take a custom URL to the `.wasm` file.
-
-### Options
+#### Vite
 
 ```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)
-});
-```
+import { init, parse } from "ironmark";
+import wasmUrl from "ironmark/ironmark.wasm?url";
 
-### Build from source
+await init(wasmUrl);
 
-```bash
-npm run setup:wasm
-npm run build
+const html = parse("# Hello\n\nThis is **fast**.");
 ```
 
-| 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() {
+    // with defaults
     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
+    // with custom options
+    let html = parse("line one\nline two", &ParseOptions {
+        hard_breaks: false,
+        enable_strikethrough: false,
         ..Default::default()
-    };
-
-    let html = parse("line one\nline two", &options);
-    println!("{html}");
+    });
 }
 ```
 
-## Troubleshooting
+## Development
 
-### `wasm32-unknown-unknown target not found` with Homebrew Rust
+This project uses [pnpm](https://pnpm.io/) for package management.
 
-The build scripts prepend `$HOME/.cargo/bin` to `PATH` so that rustup-managed binaries take priority. If the error persists:
+### Build from source
 
 ```bash
-npm run setup:wasm
+pnpm setup:wasm
+pnpm build
 ```
 
-### `wasm-bindgen` not found
+| Command           | Description            |
+| ----------------- | ---------------------- |
+| `pnpm setup:wasm` | Install prerequisites  |
+| `pnpm build`      | Release WASM build     |
+| `pnpm build:dev`  | Debug WASM build       |
+| `pnpm test`       | Run Rust tests         |
+| `pnpm check`      | Format check           |
+| `pnpm clean`      | Remove build artifacts |
 
-```bash
-npm run setup:wasm
-```
+### Troubleshooting
+
+**`wasm32-unknown-unknown target not found`** or **`wasm-bindgen not found`** — run `pnpm setup:wasm` to install all prerequisites.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ironmark",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "Very fast markdown parser in Rust, consumable from JavaScript/TypeScript via WebAssembly",
   "keywords": [
     "markdown",
@@ -41,7 +41,7 @@
         "default": "./wasm/web.js"
       }
     },
-    "./wasm/*": "./wasm/*"
+    "./ironmark.wasm": "./wasm/pkg/ironmark_bg.wasm"
   },
   "publishConfig": {
     "access": "public",
@@ -51,7 +51,7 @@
     "build": "npm run build:wasm && node wasm/build.mjs",
     "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 && node wasm/build.mjs",
     "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 .",
+    "check": "cargo fmt --check && oxlint && oxfmt --check .",
     "clean": "rm -rf wasm/pkg .wasm-tools",
     "fmt": "cargo fmt && oxfmt --write .",
     "lint": "oxlint",