writr 4.1.4 → 4.2.0

package/README.md

@@ -22,6 +22,8 @@
   - [`.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)
+  - [`.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)
   - [`.loadFromFile(filePath: string): Promise<void>`](#loadfromfilefilepath-string-promisevoid)
@@ -81,6 +83,7 @@ An example passing in the options also via the constructor:
 ```javascript
 import { Writr, WritrOptions } from 'writr';
 const writrOptions = {
+  throwErrors: true,
   renderOptions: {
     emoji: true,
     toc: true,
@@ -105,6 +108,7 @@ By default the constructor takes in a markdown `string` or `WritrOptions` in the
 ```javascript
 import { Writr, WritrOptions } from 'writr';
 const writrOptions = {
+  throwErrors: true,
   renderOptions: {
     emoji: true,
     toc: true,
@@ -149,7 +153,23 @@ console.log(writr.body); // '# Hello World ::-):\n\n This is a test.'
 
 ## `.options`
 
-Accessing the default options for this instance of Writr.
+Accessing the default options for this instance of Writr. Here is the default settings for `WritrOptions`.
+
+```javascript
+{
+  throwErrors: false,
+  renderOptions: {
+    emoji: true,
+    toc: false,
+    slug: false,
+    highlight: false,
+    gfm: true,
+    math: false,
+    mdx: false,
+    caching: false,
+  }
+}
+```
 
 ## `.frontmatter`
 
@@ -232,6 +252,26 @@ 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>'
+
+Rendering markdown to a file. The options are based on RenderOptions.
+
+```javascript
+import { Writr } from 'writr';
+const writr = new Writr(`# Hello World ::-):\n\n This is a test.`);
+await writr.renderToFile('path/to/file.html');
+```
+
+## '.renderToFileSync(filePath: string, options?: RenderOptions): void'
+
+Rendering markdown to a file synchronously. The options are based on RenderOptions.
+
+```javascript
+import { Writr } from 'writr';
+const writr = new Writr(`# Hello World ::-):\n\n This is a test.`);
+writr.renderToFileSync('path/to/file.html');
+```
+
 ## '.renderReact(options?: RenderOptions, reactOptions?: HTMLReactParserOptions): Promise<React.JSX.Element />'
 
 Rendering markdown to React. The options are based on RenderOptions and now HTMLReactParserOptions from `html-react-parser`.

package/dist/writr.d.ts

@@ -20,12 +20,12 @@ declare class WritrCache {
 /**
  * Writr options.
  * @typedef {Object} WritrOptions
- * @property {string} [openai] - Openai api key (default: undefined)
  * @property {RenderOptions} [renderOptions] - Default render options (default: undefined)
+ * @property {boolean} [throwErrors] - Throw error (default: false)
  */
 type WritrOptions = {
-    openai?: string;
     renderOptions?: RenderOptions;
+    throwErrors?: boolean;
 };
 /**
  * Render options.
@@ -37,7 +37,7 @@ type WritrOptions = {
  * @property {boolean} [gfm] - Github flavor markdown (default: true)
  * @property {boolean} [math] - Math support (default: true)
  * @property {boolean} [mdx] - MDX support (default: true)
- * @property {boolean} [caching] - Caching (default: true)
+ * @property {boolean} [caching] - Caching (default: false)
  */
 type RenderOptions = {
     emoji?: boolean;
@@ -126,6 +126,18 @@ declare class Writr extends Hookified {
      * @returns {string} The rendered HTML content.
      */
     renderSync(options?: RenderOptions): string;
+    /**
+     * Render the markdown content and save it to a file. If the directory doesn't exist it will be created.
+     * @param {string} filePath The file path to save the rendered markdown content to.
+     * @param {RenderOptions} [options] the render options.
+     */
+    renderToFile(filePath: string, options?: RenderOptions): Promise<void>;
+    /**
+     * Render the markdown content and save it to a file synchronously. If the directory doesn't exist it will be created.
+     * @param {string} filePath The file path to save the rendered markdown content to.
+     * @param {RenderOptions} [options] the render options.
+     */
+    renderToFileSync(filePath: string, options?: RenderOptions): void;
     /**
      * Render the markdown content to React.
      * @param {RenderOptions} [options] The render options.

package/dist/writr.js

@@ -58,7 +58,7 @@ 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
   _options = {
-    openai: void 0,
+    throwErrors: false,
     renderOptions: {
       emoji: true,
       toc: true,
@@ -252,6 +252,43 @@ ${yamlString}---
       throw new Error(`Failed to render markdown: ${error.message}`);
     }
   }
+  /**
+   * Render the markdown content and save it to a file. If the directory doesn't exist it will be created.
+   * @param {string} filePath The file path to save the rendered markdown content to.
+   * @param {RenderOptions} [options] the render options.
+   */
+  async renderToFile(filePath, options) {
+    try {
+      const { writeFile, mkdir } = fs.promises;
+      const directoryPath = dirname(filePath);
+      const content = await this.render(options);
+      await mkdir(directoryPath, { recursive: true });
+      await writeFile(filePath, content, "utf8");
+    } catch (error) {
+      this.emit("error", error);
+      if (this._options.throwErrors) {
+        throw error;
+      }
+    }
+  }
+  /**
+   * Render the markdown content and save it to a file synchronously. If the directory doesn't exist it will be created.
+   * @param {string} filePath The file path to save the rendered markdown content to.
+   * @param {RenderOptions} [options] the render options.
+   */
+  renderToFileSync(filePath, options) {
+    try {
+      const directoryPath = dirname(filePath);
+      const content = this.renderSync(options);
+      fs.mkdirSync(directoryPath, { recursive: true });
+      fs.writeFileSync(filePath, content, "utf8");
+    } catch (error) {
+      this.emit("error", error);
+      if (this._options.throwErrors) {
+        throw error;
+      }
+    }
+  }
   /**
    * Render the markdown content to React.
    * @param {RenderOptions} [options] The render options.
@@ -295,10 +332,17 @@ ${yamlString}---
    * @returns {Promise<void>}
    */
   async saveToFile(filePath) {
-    const { writeFile, mkdir } = fs.promises;
-    const directoryPath = dirname(filePath);
-    await mkdir(directoryPath, { recursive: true });
-    await writeFile(filePath, this._content, "utf8");
+    try {
+      const { writeFile, mkdir } = fs.promises;
+      const directoryPath = dirname(filePath);
+      await mkdir(directoryPath, { recursive: true });
+      await writeFile(filePath, this._content, "utf8");
+    } catch (error) {
+      this.emit("error", error);
+      if (this._options.throwErrors) {
+        throw error;
+      }
+    }
   }
   /**
    * Save the markdown content to a file synchronously. If the directory doesn't exist it will be created.
@@ -306,9 +350,16 @@ ${yamlString}---
    * @returns {void}
    */
   saveToFileSync(filePath) {
-    const directoryPath = dirname(filePath);
-    fs.mkdirSync(directoryPath, { recursive: true });
-    fs.writeFileSync(filePath, this._content, "utf8");
+    try {
+      const directoryPath = dirname(filePath);
+      fs.mkdirSync(directoryPath, { recursive: true });
+      fs.writeFileSync(filePath, this._content, "utf8");
+    } catch (error) {
+      this.emit("error", error);
+      if (this._options.throwErrors) {
+        throw error;
+      }
+    }
   }
   isCacheEnabled(options) {
     if (options?.caching !== void 0) {
@@ -344,8 +395,8 @@ ${yamlString}---
     return processor;
   }
   mergeOptions(current, options) {
-    if (options.openai) {
-      current.openai = options.openai;
+    if (options.throwErrors !== void 0) {
+      current.throwErrors = options.throwErrors;
     }
     if (options.renderOptions) {
       current.renderOptions ??= {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "writr",
-  "version": "4.1.4",
+  "version": "4.2.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.2",
-    "hookified": "^1.5.0",
+    "cacheable": "^1.8.5",
+    "hookified": "^1.5.1",
     "html-react-parser": "^5.1.18",
     "js-yaml": "^4.1.0",
     "react": "^18.3.1",
@@ -73,16 +73,16 @@
   },
   "devDependencies": {
     "@types/js-yaml": "^4.0.9",
-    "@types/node": "^22.8.4",
+    "@types/node": "^22.10.1",
     "@types/react": "^18.3.12",
-    "@vitest/coverage-v8": "^2.1.4",
-    "docula": "^0.9.4",
+    "@vitest/coverage-v8": "^2.1.6",
+    "docula": "^0.9.5",
     "rimraf": "^6.0.1",
     "ts-node": "^10.9.2",
     "tsup": "^8.3.5",
-    "typescript": "^5.6.3",
-    "vitest": "^2.1.4",
-    "webpack": "^5.95.0",
+    "typescript": "^5.7.2",
+    "vitest": "^2.1.6",
+    "webpack": "^5.96.1",
     "xo": "^0.59.3"
   },
   "xo": {