writr - npm Package Compare versions

Comparing version 4.3.0 to 4.4.0

dist/writr.d.ts

@@ -56,3 +56,3 @@ import * as unified from 'unified';
     beforeSaveToFile = "beforeSaveToFile",
-    afterSaveToFile = "afterSaveToFile",
+    beforeRenderToFile = "beforeRenderToFile",
     beforeLoadFromFile = "beforeLoadFromFile",
@@ -59,0 +59,0 @@ afterLoadFromFile = "afterLoadFromFile"

dist/writr.js

@@ -61,3 +61,3 @@ // src/writr.ts
   WritrHooks2["beforeSaveToFile"] = "beforeSaveToFile";
-  WritrHooks2["afterSaveToFile"] = "afterSaveToFile";
+  WritrHooks2["beforeRenderToFile"] = "beforeRenderToFile";
   WritrHooks2["beforeLoadFromFile"] = "beforeLoadFromFile";
@@ -294,3 +294,8 @@ WritrHooks2["afterLoadFromFile"] = "afterLoadFromFile";
       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) {
@@ -313,3 +318,8 @@ this.emit("error", error);
       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) {
@@ -369,3 +379,8 @@ this.emit("error", error);
       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) {
@@ -387,3 +402,8 @@ this.emit("error", error);
       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) {
@@ -390,0 +410,0 @@ this.emit("error", error);

package.json

 {
   "name": "writr",
-  "version": "4.3.0",
+  "version": "4.4.0",
   "description": "Markdown Rendering Simplified",
@@ -56,4 +56,4 @@ "type": "module",
   "dependencies": {
-    "cacheable": "^1.8.7",
-    "hookified": "^1.6.0",
+    "cacheable": "^1.8.8",
+    "hookified": "^1.7.0",
     "html-react-parser": "^5.2.2",
@@ -77,11 +77,11 @@ "js-yaml": "^4.1.0",
     "@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",
@@ -88,0 +88,0 @@ "xo": "^0.60.0"

README.md

@@ -369,5 +369,4 @@ ![Writr](site/logo.svg)
 ```typescript
-export type renderData {
-  body: string;
-  content: string;
+export type renderData = {
+  body: string
   options: RenderOptions;
@@ -380,3 +379,3 @@ }
 ```typescript
-export type resultData {
+export type resultData = {
   result: string;
@@ -386,2 +385,24 @@ }
 
+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
@@ -388,0 +409,0 @@ [Code of Conduct](CODE_OF_CONDUCT.md) and [Contributing](CONTRIBUTING.md) guidelines.

No alert changes

Improved metrics

Total package byte prevSize

39988

increased by2.94%

Lines of code

673

increased by3.06%

Number of lines in readme file

411

increased by5.38%

Dependency changes

• Updatedcacheable@^1.8.8

• Updatedhookified@^1.7.0