Merge pull request #6 from md2docx/merge-options-utils

Merge options utils

Author: mayank1513

lib/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @m2d/core
 
+## 1.4.3
+
+### Patch Changes
+
+- 26199b2: Attempt to keep entire code block on same page.
+- 4fbac23: feat/utils: add mergeOptions function for deep merging user and default options
+
 ## 1.4.2
 
 ### Patch Changes

lib/__tests__/index.test.ts

@@ -32,7 +32,6 @@ describe("toDocx", () => {
     const docxBlob = await toDocx(
       mdast,
       { title: "Custom Title" },
-      // @ts-expect-error WIP
       { plugins: [htmlPlugin(), listPlugin()] },
     );
 

lib/__tests__/utils.test.ts

@@ -0,0 +1,59 @@
+import { describe, it } from "vitest";
+import { mergeOptions } from "../src/utils";
+
+describe.concurrent("mergeOptions", () => {
+  it("should return defaultOptions if options is undefined", ({ expect }) => {
+    const defaults = { a: 1, b: 2 };
+    const result = mergeOptions(undefined, defaults);
+    expect(result).toEqual(defaults);
+  });
+
+  it("should return options if defaultOptions is undefined", ({ expect }) => {
+    const opts = { a: 3, b: 4 };
+    const result = mergeOptions(opts, undefined);
+    expect(result).toEqual(opts);
+  });
+
+  it("should deeply merge nested objects", ({ expect }) => {
+    const defaults = { a: 1, b: { c: 2, d: 3 } };
+    const opts = { b: { c: 5 } };
+    const result = mergeOptions(opts, defaults);
+    expect(result).toEqual({ a: 1, b: { c: 5, d: 3 } });
+  });
+
+  it("should override primitive values", ({ expect }) => {
+    const defaults = { a: 1, b: 2 };
+    const opts = { b: 5 };
+    const result = mergeOptions(opts, defaults);
+    expect(result).toEqual({ a: 1, b: 5 });
+  });
+
+  it("should not merge arrays, but override them", ({ expect }) => {
+    const defaults = { arr: [1, 2, 3], b: 2 };
+    const opts = { arr: [4, 5] };
+    const result = mergeOptions(opts, defaults);
+    expect(result).toEqual({ arr: [4, 5], b: 2 });
+  });
+
+  it("should handle null and undefined values in options", ({ expect }) => {
+    const defaults = { a: 1, b: 2 };
+    const opts = { a: null, b: undefined };
+    const result = mergeOptions(opts, defaults as any);
+    expect(result).toEqual({ a: null, b: undefined });
+  });
+
+  it("should handle both options and defaultOptions as undefined", ({ expect }) => {
+    const result = mergeOptions(undefined, undefined);
+    expect(result).toEqual({});
+  });
+
+  it("should not mutate the input objects", ({ expect }) => {
+    const defaults = { a: 1, b: { c: 2 } };
+    const opts = { b: { d: 3 } };
+    const defaultsCopy = JSON.parse(JSON.stringify(defaults));
+    const optsCopy = JSON.parse(JSON.stringify(opts));
+    mergeOptions(opts, defaults as any);
+    expect(defaults).toEqual(defaultsCopy);
+    expect(opts).toEqual(optsCopy);
+  });
+});

lib/package.json

@@ -2,7 +2,7 @@
   "name": "@m2d/core",
   "author": "Mayank Kumar Chaudhari (https://mayank-chaudhari.vercel.app)",
   "private": false,
-  "version": "1.4.2",
+  "version": "1.4.3",
   "description": "Core engine to convert extended MDAST to DOCX. Supports plugins for footnotes, images, lists, tables, and more. Designed for seamless Markdown-to-DOCX conversion.",
   "license": "MPL-2.0",
   "main": "./dist/index.js",

lib/src/section.ts

@@ -237,6 +237,7 @@ export const toSection = async (
                 ...newParaProps,
                 alignment: "left",
                 style: "blockCode",
+                keepLines: true,
                 children: node.value.split("\n").map(
                   (line, i) =>
                     // @ts-expect-error -- ok to pass extra data

lib/src/utils/index.ts

@@ -222,6 +222,32 @@ export interface IPlugin<T extends Node = EmptyNode> {
 }
 
 /**
- * @mayank/docx is a fork of the `docx` library with minor modifications,
- * primarily adding exports for additional types missing from the original `docx` library.
+ * Deeply merges user options over default options.
+ * Later values override earlier ones. Arrays are not merged.
+ *
+ * @param options - User-provided overrides.
+ * @param defaultOptions - Default values.
+ * @returns A deeply merged object.
  */
+export function mergeOptions<T>(options?: Partial<T>, defaultOptions?: Partial<T>): T {
+  const result: any = { ...defaultOptions, ...options };
+
+  if (options) {
+    for (const [key, value] of Object.entries(options)) {
+      const defaultVal = (defaultOptions as any)?.[key];
+
+      if (
+        value &&
+        typeof value === "object" &&
+        !Array.isArray(value) &&
+        defaultVal &&
+        typeof defaultVal === "object" &&
+        !Array.isArray(defaultVal)
+      ) {
+        result[key] = mergeOptions(value, defaultVal);
+      }
+    }
+  }
+
+  return result as T;
+}

packages/shared/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @repo/shared
 
+## 0.0.24
+
+### Patch Changes
+
+- Updated dependencies [26199b2]
+- Updated dependencies [4fbac23]
+  - @m2d/core@1.4.3
+
 ## 0.0.23
 
 ### Patch Changes

packages/shared/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@repo/shared",
-  "version": "0.0.23",
+  "version": "0.0.24",
   "private": true,
   "sideEffects": false,
   "main": "./dist/index.js",