writr 4.3.0 → 4.4.1

package/README.md

@@ -366,9 +366,8 @@ 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;
-  content: string;
+export type renderData = {
+  body: string
   options: RenderOptions;
 }
 ```
@@ -376,11 +375,43 @@ export type renderData {
 For `afterRender` the data object is a `resultData` object. Here is the interface for `resultData`:
 
 ```typescript
-export type resultData {
+export type resultData = {
   result: string;
 }
 ```
 
+For `saveToFile` 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 `renderToFile` 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`.
+
+For `loadFromFile` the data object is an object with `content` so you can change before it is set on `writr.content`. Here is the interface for `loadFromFileData`:
+
+```typescript
+export type loadFromFileData = {
+  content: string;
+}
+```
+
+This is called when you call `loadFromFile`, `loadFromFileSync`.
+
 # Code of Conduct and Contributing
 [Code of Conduct](CODE_OF_CONDUCT.md) and [Contributing](CONTRIBUTING.md) guidelines.
 

package/dist/writr.d.ts

@@ -52,10 +52,9 @@ type RenderOptions = {
 declare enum WritrHooks {
     beforeRender = "beforeRender",
     afterRender = "afterRender",
-    beforeSaveToFile = "beforeSaveToFile",
-    afterSaveToFile = "afterSaveToFile",
-    beforeLoadFromFile = "beforeLoadFromFile",
-    afterLoadFromFile = "afterLoadFromFile"
+    saveToFile = "saveToFile",
+    renderToFile = "renderToFile",
+    loadFromFile = "loadFromFile"
 }
 declare class Writr extends Hookified {
     engine: unified.Processor<mdast.Root, mdast.Root, hast.Root, hast.Root, string>;

package/dist/writr.js

@@ -57,10 +57,9 @@ var WritrCache = class {
 var WritrHooks = /* @__PURE__ */ ((WritrHooks2) => {
   WritrHooks2["beforeRender"] = "beforeRender";
   WritrHooks2["afterRender"] = "afterRender";
-  WritrHooks2["beforeSaveToFile"] = "beforeSaveToFile";
-  WritrHooks2["afterSaveToFile"] = "afterSaveToFile";
-  WritrHooks2["beforeLoadFromFile"] = "beforeLoadFromFile";
-  WritrHooks2["afterLoadFromFile"] = "afterLoadFromFile";
+  WritrHooks2["saveToFile"] = "saveToFile";
+  WritrHooks2["renderToFile"] = "renderToFile";
+  WritrHooks2["loadFromFile"] = "loadFromFile";
   return WritrHooks2;
 })(WritrHooks || {});
 var Writr = class extends Hookified {
@@ -290,7 +289,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("renderToFile" /* renderToFile */, data);
+      await writeFile(data.filePath, data.content);
     } catch (error) {
       this.emit("error", error);
       if (this._options.throwErrors) {
@@ -308,7 +312,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("renderToFile" /* renderToFile */, data);
+      fs.writeFileSync(data.filePath, data.content);
     } catch (error) {
       this.emit("error", error);
       if (this._options.throwErrors) {
@@ -342,8 +351,20 @@ ${yamlString}---
    * @returns {Promise<void>}
    */
   async loadFromFile(filePath) {
-    const { readFile } = fs.promises;
-    this._content = await readFile(filePath, "utf8");
+    try {
+      const { readFile } = fs.promises;
+      const data = {
+        content: ""
+      };
+      data.content = await readFile(filePath, "utf8");
+      await this.hook("loadFromFile" /* loadFromFile */, data);
+      this._content = data.content;
+    } catch (error) {
+      this.emit("error", error);
+      if (this._options.throwErrors) {
+        throw error;
+      }
+    }
   }
   /**
    * Load markdown content from a file synchronously.
@@ -351,7 +372,19 @@ ${yamlString}---
    * @returns {void}
    */
   loadFromFileSync(filePath) {
-    this._content = fs.readFileSync(filePath, "utf8");
+    try {
+      const data = {
+        content: ""
+      };
+      data.content = fs.readFileSync(filePath, "utf8");
+      this.hook("loadFromFile" /* loadFromFile */, data);
+      this._content = data.content;
+    } catch (error) {
+      this.emit("error", error);
+      if (this._options.throwErrors) {
+        throw error;
+      }
+    }
   }
   /**
    * Save the markdown content to a file. If the directory doesn't exist it will be created.
@@ -363,7 +396,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("saveToFile" /* saveToFile */, data);
+      await writeFile(data.filePath, data.content);
     } catch (error) {
       this.emit("error", error);
       if (this._options.throwErrors) {
@@ -380,7 +418,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("saveToFile" /* saveToFile */, data);
+      fs.writeFileSync(data.filePath, data.content);
     } catch (error) {
       this.emit("error", error);
       if (this._options.throwErrors) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "writr",
-  "version": "4.3.0",
+  "version": "4.4.1",
   "description": "Markdown Rendering Simplified",
   "type": "module",
   "main": "./dist/writr.js",
@@ -53,17 +53,17 @@
     "website:serve": "rimraf ./site/README.md ./site/dist && npx docula serve -s ./site -o ./site/dist"
   },
   "dependencies": {
-    "cacheable": "^1.8.7",
-    "hookified": "^1.6.0",
+    "cacheable": "^1.8.8",
+    "hookified": "^1.7.1",
     "html-react-parser": "^5.2.2",
     "js-yaml": "^4.1.0",
     "react": "^19.0.0",
-    "rehype-highlight": "^7.0.1",
+    "rehype-highlight": "^7.0.2",
     "rehype-katex": "^7.0.1",
     "rehype-slug": "^6.0.0",
     "rehype-stringify": "^10.0.1",
     "remark-emoji": "^5.0.1",
-    "remark-gfm": "^4.0.0",
+    "remark-gfm": "^4.0.1",
     "remark-math": "^6.0.0",
     "remark-mdx": "^3.1.0",
     "remark-parse": "^11.0.0",
@@ -73,16 +73,16 @@
   },
   "devDependencies": {
     "@types/js-yaml": "^4.0.9",
-    "@types/node": "^22.10.2",
-    "@types/react": "^19.0.2",
-    "@vitest/coverage-v8": "^2.1.8",
-    "docula": "^0.9.6",
+    "@types/node": "^22.13.5",
+    "@types/react": "^19.0.10",
+    "@vitest/coverage-v8": "^3.0.7",
+    "docula": "^0.10.1",
     "rimraf": "^6.0.1",
     "ts-node": "^10.9.2",
-    "tsup": "^8.3.5",
-    "typescript": "^5.7.2",
-    "vitest": "^2.1.8",
-    "webpack": "^5.97.1",
+    "tsup": "^8.4.0",
+    "typescript": "^5.7.3",
+    "vitest": "^3.0.7",
+    "webpack": "^5.98.0",
     "xo": "^0.60.0"
   },
   "xo": {