writr 4.2.0 → 4.4.0

package/README.md

@@ -22,7 +22,7 @@
   - [`.engine`](#engine)
   - [`.render(options?: RenderOptions): Promise<string>`](#renderoptions-renderoptions-promisestring)
   - [`.renderSync(options?: RenderOptions): string`](#rendersyncoptions-renderoptions-string)
-  - [`.renderToFile(filePath: string, options?: RenderOptions): Promise<void>`](#rendertofilefilepath-string-options-renderoptions-promisevoid)
+  - [`.renderToFile(filePath: string, options?: RenderOptions)`](#rendertofilefilepath-string-options-renderoptions)
   - [`.renderToFileSync(filePath: string, options?: RenderOptions): void`](#rendertofilesyncfilepath-string-options-renderoptions-void)
   - [`.renderReact(options?: RenderOptions, reactOptions?: HTMLReactParserOptions): Promise<React.JSX.Element />`](#renderreactoptions-renderoptions-reactoptions-htmlreactparseroptions-promise-reactjsxelement-)
   - [`.renderReactSync( options?: RenderOptions, reactOptions?: HTMLReactParserOptions): React.JSX.Element`](#renderreactsync-options-renderoptions-reactoptions-htmlreactparseroptions-reactjsxelement)
@@ -30,6 +30,7 @@
   - [`.loadFromFileSync(filePath: string): void`](#loadfromfilesyncfilepath-string-void)
   - [`.saveToFile(filePath: string): Promise<void>`](#savetofilefilepath-string-promisevoid)
   - [`.saveToFileSync(filePath: string): void`](#savetofilesyncfilepath-string-void)
+- [Hooks](#hooks)
 - [Code of Conduct and Contributing](#code-of-conduct-and-contributing)
 - [License](#license)
 
@@ -47,6 +48,7 @@
 * Github Flavor Markdown (remark-gfm).
 * Emoji Support (remark-emoji).
 * MDX Support (remark-mdx).
+* Built in Hooks for adding code to render pipeline.
 
 # ESM and Node Version Support
 
@@ -252,7 +254,7 @@ const writr = new Writr(`# Hello World ::-):\n\n This is a test.`);
 const html = writr.renderSync(); // <h1>Hello World 🙂</h1><p>This is a test.</p>
 ```
 
-## '.renderToFile(filePath: string, options?: RenderOptions): Promise<void>'
+## '.renderToFile(filePath: string, options?: RenderOptions)'
 
 Rendering markdown to a file. The options are based on RenderOptions.
 
@@ -347,9 +349,62 @@ writr.cache.store.lruSize = 100;
 writr.cache.store.ttl = '5m'; // setting it to 5 minutes
 ```
 
+# Hooks
+
+Hooks are a way to add additional parsing to the render pipeline. You can add hooks to the the Writr instance. Here is an example of adding a hook to the instance of Writr:
+
+```javascript
+import { Writr, WritrHooks } from 'writr';
+const writr = new Writr(`# Hello World ::-):\n\n This is a test.`);
+writr.onHook(WritrHooks.beforeRender, data => {
+  data.body = 'Hello, Universe!';
+});
+const result = await writr.render();
+console.log(result); // Hello, Universe!
+```
+
+For `beforeRender` the data object is a `renderData` object. Here is the interface for `renderData`:
+
+```typescript
+export type renderData = {
+  body: string
+  options: RenderOptions;
+}
+```
+
+For `afterRender` the data object is a `resultData` object. Here is the interface for `resultData`:
+
+```typescript
+export type resultData = {
+  result: string;
+}
+```
+
+For `beforeSaveToFile` the data object is an object with the `filePath` and `content`. Here is the interface for `saveToFileData`:
+
+```typescript
+export type saveToFileData = {
+  filePath: string;
+  content: string;
+}
+```
+
+This is called when you call `saveToFile`, `saveToFileSync`.
+
+For `beforeRenderToFile` the data object is an object with the `filePath` and `content`. Here is the interface for `renderToFileData`:
+
+```typescript
+export type renderToFileData = {
+  filePath: string;
+  content: string;
+}
+```
+
+This is called when you call `renderToFile`, `renderToFileSync`.
+
 # Code of Conduct and Contributing
 [Code of Conduct](CODE_OF_CONDUCT.md) and [Contributing](CONTRIBUTING.md) guidelines.
 
 # License
 
-MIT © [Jared Wray](https://jaredwray.com)
+[MIT](LICENSE) & © [Jared Wray](https://jaredwray.com)

package/dist/writr.d.ts

@@ -49,6 +49,14 @@ type RenderOptions = {
     mdx?: boolean;
     caching?: boolean;
 };
+declare enum WritrHooks {
+    beforeRender = "beforeRender",
+    afterRender = "afterRender",
+    beforeSaveToFile = "beforeSaveToFile",
+    beforeRenderToFile = "beforeRenderToFile",
+    beforeLoadFromFile = "beforeLoadFromFile",
+    afterLoadFromFile = "afterLoadFromFile"
+}
 declare class Writr extends Hookified {
     engine: unified.Processor<mdast.Root, mdast.Root, hast.Root, hast.Root, string>;
     private readonly _options;
@@ -182,4 +190,4 @@ declare class Writr extends Hookified {
     private mergeRenderOptions;
 }
 
-export { type RenderOptions, Writr, type WritrOptions };
+export { type RenderOptions, Writr, WritrHooks, type WritrOptions };

package/dist/writr.js

@@ -54,6 +54,15 @@ var WritrCache = class {
 };
 
 // src/writr.ts
+var WritrHooks = /* @__PURE__ */ ((WritrHooks2) => {
+  WritrHooks2["beforeRender"] = "beforeRender";
+  WritrHooks2["afterRender"] = "afterRender";
+  WritrHooks2["beforeSaveToFile"] = "beforeSaveToFile";
+  WritrHooks2["beforeRenderToFile"] = "beforeRenderToFile";
+  WritrHooks2["beforeLoadFromFile"] = "beforeLoadFromFile";
+  WritrHooks2["afterLoadFromFile"] = "afterLoadFromFile";
+  return WritrHooks2;
+})(WritrHooks || {});
 var Writr = class extends Hookified {
   engine = unified().use(remarkParse).use(remarkGfm).use(remarkToc).use(remarkEmoji).use(remarkRehype).use(rehypeSlug).use(remarkMath).use(rehypeKatex).use(rehypeHighlight).use(remarkMDX).use(rehypeStringify);
   // Stringify HTML
@@ -201,24 +210,33 @@ ${yamlString}---
    */
   async render(options) {
     try {
-      let result = "";
-      if (this.isCacheEnabled(options)) {
-        const cached = this._cache.get(this._content, options);
-        if (cached) {
-          return cached;
-        }
-      }
       let { engine } = this;
       if (options) {
         options = { ...this._options.renderOptions, ...options };
         engine = this.createProcessor(options);
       }
-      const file = await engine.process(this.body);
-      result = String(file);
-      if (this.isCacheEnabled(options)) {
-        this._cache.set(this._content, result, options);
+      const renderData = {
+        content: this._content,
+        body: this.body,
+        options
+      };
+      await this.hook("beforeRender" /* beforeRender */, renderData);
+      const resultData = {
+        result: ""
+      };
+      if (this.isCacheEnabled(renderData.options)) {
+        const cached = this._cache.get(renderData.content, renderData.options);
+        if (cached) {
+          return cached;
+        }
       }
-      return result;
+      const file = await engine.process(renderData.body);
+      resultData.result = String(file);
+      if (this.isCacheEnabled(renderData.options)) {
+        this._cache.set(renderData.content, resultData.result, renderData.options);
+      }
+      await this.hook("afterRender" /* afterRender */, resultData);
+      return resultData.result;
     } catch (error) {
       throw new Error(`Failed to render markdown: ${error.message}`);
     }
@@ -230,24 +248,33 @@ ${yamlString}---
    */
   renderSync(options) {
     try {
-      let result = "";
-      if (this.isCacheEnabled(options)) {
-        const cached = this._cache.get(this._content, options);
-        if (cached) {
-          return cached;
-        }
-      }
       let { engine } = this;
       if (options) {
         options = { ...this._options.renderOptions, ...options };
         engine = this.createProcessor(options);
       }
-      const file = engine.processSync(this.body);
-      result = String(file);
-      if (this.isCacheEnabled(options)) {
-        this._cache.set(this._content, result, options);
+      const renderData = {
+        content: this._content,
+        body: this.body,
+        options
+      };
+      this.hook("beforeRender" /* beforeRender */, renderData);
+      const resultData = {
+        result: ""
+      };
+      if (this.isCacheEnabled(renderData.options)) {
+        const cached = this._cache.get(renderData.content, renderData.options);
+        if (cached) {
+          return cached;
+        }
       }
-      return result;
+      const file = engine.processSync(renderData.body);
+      resultData.result = String(file);
+      if (this.isCacheEnabled(renderData.options)) {
+        this._cache.set(renderData.content, resultData.result, renderData.options);
+      }
+      this.hook("afterRender" /* afterRender */, resultData);
+      return resultData.result;
     } catch (error) {
       throw new Error(`Failed to render markdown: ${error.message}`);
     }
@@ -263,7 +290,12 @@ ${yamlString}---
       const directoryPath = dirname(filePath);
       const content = await this.render(options);
       await mkdir(directoryPath, { recursive: true });
-      await writeFile(filePath, content, "utf8");
+      const data = {
+        filePath,
+        content
+      };
+      await this.hook("beforeRenderToFile" /* beforeRenderToFile */, data);
+      await writeFile(data.filePath, data.content);
     } catch (error) {
       this.emit("error", error);
       if (this._options.throwErrors) {
@@ -281,7 +313,12 @@ ${yamlString}---
       const directoryPath = dirname(filePath);
       const content = this.renderSync(options);
       fs.mkdirSync(directoryPath, { recursive: true });
-      fs.writeFileSync(filePath, content, "utf8");
+      const data = {
+        filePath,
+        content
+      };
+      this.hook("beforeRenderToFile" /* beforeRenderToFile */, data);
+      fs.writeFileSync(data.filePath, data.content);
     } catch (error) {
       this.emit("error", error);
       if (this._options.throwErrors) {
@@ -336,7 +373,12 @@ ${yamlString}---
       const { writeFile, mkdir } = fs.promises;
       const directoryPath = dirname(filePath);
       await mkdir(directoryPath, { recursive: true });
-      await writeFile(filePath, this._content, "utf8");
+      const data = {
+        filePath,
+        content: this._content
+      };
+      await this.hook("beforeSaveToFile" /* beforeSaveToFile */, data);
+      await writeFile(data.filePath, data.content);
     } catch (error) {
       this.emit("error", error);
       if (this._options.throwErrors) {
@@ -353,7 +395,12 @@ ${yamlString}---
     try {
       const directoryPath = dirname(filePath);
       fs.mkdirSync(directoryPath, { recursive: true });
-      fs.writeFileSync(filePath, this._content, "utf8");
+      const data = {
+        filePath,
+        content: this._content
+      };
+      this.hook("beforeSaveToFile" /* beforeSaveToFile */, data);
+      fs.writeFileSync(data.filePath, data.content);
     } catch (error) {
       this.emit("error", error);
       if (this._options.throwErrors) {
@@ -433,5 +480,6 @@ ${yamlString}---
   }
 };
 export {
-  Writr
+  Writr,
+  WritrHooks
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "writr",
-  "version": "4.2.0",
+  "version": "4.4.0",
   "description": "Markdown Rendering Simplified",
   "type": "module",
   "main": "./dist/writr.js",
@@ -53,11 +53,11 @@
     "website:serve": "rimraf ./site/README.md ./site/dist && npx docula serve -s ./site -o ./site/dist"
   },
   "dependencies": {
-    "cacheable": "^1.8.5",
-    "hookified": "^1.5.1",
-    "html-react-parser": "^5.1.18",
+    "cacheable": "^1.8.8",
+    "hookified": "^1.7.0",
+    "html-react-parser": "^5.2.2",
     "js-yaml": "^4.1.0",
-    "react": "^18.3.1",
+    "react": "^19.0.0",
     "rehype-highlight": "^7.0.1",
     "rehype-katex": "^7.0.1",
     "rehype-slug": "^6.0.0",
@@ -73,17 +73,17 @@
   },
   "devDependencies": {
     "@types/js-yaml": "^4.0.9",
-    "@types/node": "^22.10.1",
-    "@types/react": "^18.3.12",
-    "@vitest/coverage-v8": "^2.1.6",
-    "docula": "^0.9.5",
+    "@types/node": "^22.12.0",
+    "@types/react": "^19.0.8",
+    "@vitest/coverage-v8": "^3.0.4",
+    "docula": "^0.10.0",
     "rimraf": "^6.0.1",
     "ts-node": "^10.9.2",
-    "tsup": "^8.3.5",
-    "typescript": "^5.7.2",
-    "vitest": "^2.1.6",
-    "webpack": "^5.96.1",
-    "xo": "^0.59.3"
+    "tsup": "^8.3.6",
+    "typescript": "^5.7.3",
+    "vitest": "^3.0.4",
+    "webpack": "^5.97.1",
+    "xo": "^0.60.0"
   },
   "xo": {
     "ignores": [