writr 4.3.0 → 4.4.0

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,33 @@ 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 `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.
 

package/dist/writr.d.ts

@@ -53,7 +53,7 @@ declare enum WritrHooks {
     beforeRender = "beforeRender",
     afterRender = "afterRender",
     beforeSaveToFile = "beforeSaveToFile",
-    afterSaveToFile = "afterSaveToFile",
+    beforeRenderToFile = "beforeRenderToFile",
     beforeLoadFromFile = "beforeLoadFromFile",
     afterLoadFromFile = "afterLoadFromFile"
 }

package/dist/writr.js

@@ -58,7 +58,7 @@ var WritrHooks = /* @__PURE__ */ ((WritrHooks2) => {
   WritrHooks2["beforeRender"] = "beforeRender";
   WritrHooks2["afterRender"] = "afterRender";
   WritrHooks2["beforeSaveToFile"] = "beforeSaveToFile";
-  WritrHooks2["afterSaveToFile"] = "afterSaveToFile";
+  WritrHooks2["beforeRenderToFile"] = "beforeRenderToFile";
   WritrHooks2["beforeLoadFromFile"] = "beforeLoadFromFile";
   WritrHooks2["afterLoadFromFile"] = "afterLoadFromFile";
   return WritrHooks2;
@@ -290,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) {
@@ -308,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) {
@@ -363,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) {
@@ -380,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) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "writr",
-  "version": "4.3.0",
+  "version": "4.4.0",
   "description": "Markdown Rendering Simplified",
   "type": "module",
   "main": "./dist/writr.js",
@@ -53,8 +53,8 @@
     "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.0",
     "html-react-parser": "^5.2.2",
     "js-yaml": "^4.1.0",
     "react": "^19.0.0",
@@ -73,15 +73,15 @@
   },
   "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.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.8",
+    "tsup": "^8.3.6",
+    "typescript": "^5.7.3",
+    "vitest": "^3.0.4",
     "webpack": "^5.97.1",
     "xo": "^0.60.0"
   },