writr 5.0.0 → 5.0.2

package/README.md

@@ -68,6 +68,7 @@ plugins and working with the processor directly.
   - [Methods that Emit Errors](#methods-that-emit-errors)
   - [Error Event Examples](#error-event-examples)
   - [Event Emitter Methods](#event-emitter-methods)
+- [Benchmarks](#benchmarks)
 - [ESM and Node Version Support](#esm-and-node-version-support)
 - [Code of Conduct and Contributing](#code-of-conduct-and-contributing)
 - [License](#license)
@@ -727,6 +728,17 @@ Since Writr extends Hookified, you have access to standard event emitter methods
 
 For more information about event handling capabilities, see the [Hookified documentation](https://github.com/jaredwray/hookified).
 
+# Benchmarks
+
+The benchmark shows rendering performance via Sync and Async methods with caching enabled and disabled.
+
+|           name            |  summary  |  ops/sec  |  time/op  |  margin  |  samples  |
+|---------------------------|:---------:|----------:|----------:|:--------:|----------:|
+|  render (Sync) (cached)   |    🥇     |      34K  |     30µs  |  ±0.08%  |      33K  |
+|  render (Async) (cached)  |   -1.5%   |      33K  |     31µs  |  ±0.08%  |      33K  |
+|  render (Sync)            |   -93%    |       2K  |    474µs  |  ±0.96%  |      10K  |
+|  render (Async)           |   -93%    |       2K  |    481µs  |  ±0.96%  |      10K  |
+
 # ESM and Node Version Support
 
 This package is ESM only and tested on the current lts version and its previous. Please don't open issues for questions regarding CommonJS / ESM or previous Nodejs versions.

package/dist/writr.d.ts

@@ -16,6 +16,13 @@ declare class WritrCache {
     set(markdown: string, value: string, options?: RenderOptions): void;
     clear(): void;
     hash(markdown: string, options?: RenderOptions): string;
+    /**
+     * Sanitizes render options to only include serializable properties for caching.
+     * This prevents issues with structuredClone when options contain Promises, functions, or circular references.
+     * @param {RenderOptions} [options] The render options to sanitize
+     * @returns {RenderOptions | undefined} A new object with only the known RenderOptions properties
+     */
+    private sanitizeOptions;
 }
 
 /**
@@ -208,9 +215,9 @@ declare class Writr extends Hookified {
      * @returns {void}
      */
     saveToFileSync(filePath: string): void;
+    mergeOptions(current: WritrOptions, options: WritrOptions): WritrOptions;
     private isCacheEnabled;
     private createProcessor;
-    private mergeOptions;
     private mergeRenderOptions;
 }
 

package/dist/writr.js

@@ -19,11 +19,12 @@ import remarkToc from "remark-toc";
 import { unified } from "unified";
 
 // src/writr-cache.ts
-import { Cacheable, CacheableMemory } from "cacheable";
+import { CacheableMemory } from "cacheable";
+import { Hashery } from "hashery";
 var WritrCache = class {
   _store = new CacheableMemory();
   _hashStore = new CacheableMemory();
-  _hash = new Cacheable();
+  _hash = new Hashery();
   get store() {
     return this._store;
   }
@@ -43,15 +44,53 @@ var WritrCache = class {
     this._hashStore.clear();
   }
   hash(markdown, options) {
-    const content = { markdown, options };
+    const sanitizedOptions = this.sanitizeOptions(options);
+    const content = { markdown, options: sanitizedOptions };
     const key = JSON.stringify(content);
-    let result = this._hashStore.get(key);
+    const result = this._hashStore.get(key);
     if (result) {
       return result;
     }
-    result = this._hash.hash(content);
-    this._hashStore.set(key, result);
-    return result;
+    const hash = this._hash.toHashSync(content);
+    this._hashStore.set(key, hash);
+    return hash;
+  }
+  /**
+   * Sanitizes render options to only include serializable properties for caching.
+   * This prevents issues with structuredClone when options contain Promises, functions, or circular references.
+   * @param {RenderOptions} [options] The render options to sanitize
+   * @returns {RenderOptions | undefined} A new object with only the known RenderOptions properties
+   */
+  sanitizeOptions(options) {
+    if (!options) {
+      return void 0;
+    }
+    const sanitized = {};
+    if (options.emoji !== void 0) {
+      sanitized.emoji = options.emoji;
+    }
+    if (options.toc !== void 0) {
+      sanitized.toc = options.toc;
+    }
+    if (options.slug !== void 0) {
+      sanitized.slug = options.slug;
+    }
+    if (options.highlight !== void 0) {
+      sanitized.highlight = options.highlight;
+    }
+    if (options.gfm !== void 0) {
+      sanitized.gfm = options.gfm;
+    }
+    if (options.math !== void 0) {
+      sanitized.math = options.math;
+    }
+    if (options.mdx !== void 0) {
+      sanitized.mdx = options.mdx;
+    }
+    if (options.caching !== void 0) {
+      sanitized.caching = options.caching;
+    }
+    return sanitized;
   }
 };
 
@@ -528,6 +567,16 @@ ${yamlString}---
       }
     }
   }
+  mergeOptions(current, options) {
+    if (options.throwErrors !== void 0) {
+      current.throwErrors = options.throwErrors;
+    }
+    if (options.renderOptions) {
+      current.renderOptions ??= {};
+      this.mergeRenderOptions(current.renderOptions, options.renderOptions);
+    }
+    return current;
+  }
   isCacheEnabled(options) {
     if (options?.caching !== void 0) {
       return options.caching;
@@ -563,16 +612,6 @@ ${yamlString}---
     processor.use(rehypeStringify);
     return processor;
   }
-  mergeOptions(current, options) {
-    if (options.throwErrors !== void 0) {
-      current.throwErrors = options.throwErrors;
-    }
-    if (options.renderOptions) {
-      current.renderOptions ??= {};
-      this.mergeRenderOptions(current.renderOptions, options.renderOptions);
-    }
-    return current;
-  }
   mergeRenderOptions(current, options) {
     if (options.emoji !== void 0) {
       current.emoji = options.emoji;

package/package.json

@@ -1,16 +1,20 @@
 {
   "name": "writr",
-  "version": "5.0.0",
+  "version": "5.0.2",
   "description": "Markdown Rendering Simplified",
   "type": "module",
   "main": "./dist/writr.js",
   "types": "./dist/writr.d.ts",
   "exports": {
     ".": {
+      "types": "./dist/writr.d.ts",
       "import": "./dist/writr.js"
     }
   },
-  "repository": "https://github.com/jaredwray/writr.git",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jaredwray/writr.git"
+  },
   "author": "Jared Wray <me@jaredwray.com>",
   "engines": {
     "node": ">=20"
@@ -44,29 +48,20 @@
     "react-markdown",
     "markdown-to-react"
   ],
-  "scripts": {
-    "clean": "rimraf ./dist ./coverage ./node_modules ./pnpm-lock.yaml ./site/README.md ./site/dist",
-    "build": "rimraf ./dist && tsup src/writr.ts --format esm --dts --clean",
-    "prepare": "pnpm build",
-    "lint": "biome check --write --error-on-warnings",
-    "test": "pnpm lint && vitest run --coverage",
-    "test:ci": "biome check --error-on-warnings && vitest run --coverage",
-    "website:build": "rimraf ./site/README.md ./site/dist && npx docula build -s ./site -o ./site/dist",
-    "website:serve": "rimraf ./site/README.md ./site/dist && npx docula serve -s ./site -o ./site/dist"
-  },
   "dependencies": {
-    "cacheable": "^2.1.1",
-    "hookified": "^1.12.2",
-    "html-react-parser": "^5.2.7",
-    "js-yaml": "^4.1.0",
-    "react": "^19.2.0",
+    "cacheable": "^2.3.1",
+    "hashery": "^1.3.0",
+    "hookified": "^1.14.0",
+    "html-react-parser": "^5.2.10",
+    "js-yaml": "^4.1.1",
+    "react": "^19.2.3",
     "rehype-highlight": "^7.0.2",
     "rehype-katex": "^7.0.1",
     "rehype-slug": "^6.0.0",
     "rehype-stringify": "^10.0.1",
     "remark-emoji": "^5.0.2",
     "remark-gfm": "^4.0.1",
-    "remark-github-blockquote-alert": "^2.0.0",
+    "remark-github-blockquote-alert": "^2.0.1",
     "remark-math": "^6.0.0",
     "remark-mdx": "^3.1.1",
     "remark-parse": "^11.0.0",
@@ -75,21 +70,33 @@
     "unified": "^11.0.5"
   },
   "devDependencies": {
-    "@biomejs/biome": "^2.3.1",
+    "@biomejs/biome": "^2.3.10",
+    "@monstermann/tinybench-pretty-printer": "^0.3.0",
     "@types/js-yaml": "^4.0.9",
-    "@types/node": "^24.9.1",
-    "@types/react": "^19.2.2",
-    "@vitest/coverage-v8": "^4.0.4",
-    "docula": "^0.31.0",
-    "rimraf": "^6.0.1",
-    "ts-node": "^10.9.2",
-    "tsup": "^8.5.0",
+    "@types/node": "^25.0.3",
+    "@types/react": "^19.2.7",
+    "@vitest/coverage-v8": "^4.0.16",
+    "docula": "^0.31.1",
+    "rimraf": "^6.1.2",
+    "tinybench": "^6.0.0",
+    "tsup": "^8.5.1",
+    "tsx": "^4.21.0",
     "typescript": "^5.9.3",
-    "vitest": "^4.0.4"
+    "vitest": "^4.0.16"
   },
   "files": [
     "dist",
     "README.md",
     "LICENSE"
-  ]
-}
+  ],
+  "scripts": {
+    "clean": "rimraf ./dist ./coverage ./node_modules ./pnpm-lock.yaml ./site/README.md ./site/dist",
+    "build": "rimraf ./dist && tsup src/writr.ts --format esm --dts --clean",
+    "lint": "biome check --write --error-on-warnings",
+    "benchmark": "tsx benchmark/benchmark.ts",
+    "test": "pnpm lint && vitest run --coverage",
+    "test:ci": "biome check --error-on-warnings && vitest run --coverage",
+    "website:build": "rimraf ./site/README.md ./site/dist && npx docula build -s ./site -o ./site/dist",
+    "website:serve": "rimraf ./site/README.md ./site/dist && npx docula serve -s ./site -o ./site/dist"
+  }
+}