feat(object): ✨ Add a new snippets group merge & apply it to config package (#76)

Author: xeho91

.changeset/few-crabs-cry.md

@@ -0,0 +1,5 @@
+---
+"@terminal-nerds/snippets-object": minor
+---
+
+✨ Added a new module `merge`

packages/config/package.json

@@ -42,8 +42,8 @@
 	],
 	"dependencies": {
 		"@terminal-nerds/snippets-error": "workspace:*",
+		"@terminal-nerds/snippets-object": "workspace:^",
 		"@terminal-nerds/snippets-runtime": "workspace:*",
-		"deepmerge-ts": "5.0.0",
 		"pkg-dir": "7.0.0",
 		"type-fest": "3.6.1"
 	},

packages/config/source/merge/merge.ts

@@ -1,11 +1,11 @@
-import { deepmerge } from "deepmerge-ts";
+import { mergeDeepObjects } from "@terminal-nerds/snippets-object/merge";
 
 export type MergedConfig<T extends Record<string, unknown> = Record<string, unknown>> = T;
 
 export function createMergedConfig<T extends Record<string, unknown> = Record<string, unknown>>(
 	dirtyConfigsList: Array<unknown>,
 ): MergedConfig<T> {
-	const cleanConfigsList = dirtyConfigsList.filter(Boolean);
+	const cleanConfigsList = dirtyConfigsList.filter(Boolean) as Array<Record<string, object>>;
 
-	return deepmerge(...cleanConfigsList) as MergedConfig<T>;
+	return mergeDeepObjects(cleanConfigsList) as MergedConfig<T>;
 }

packages/object/README.md

@@ -28,13 +28,18 @@
 | ------------------------------------------ | ----------------------------------------------------- |
 | [`@terminal-nerds/snippets-object/keys`]   | ![keys size gzip badge] ![keys size brotli badge]     |
 | [`@terminal-nerds/snippets-object/schema`] | ![schema size gzip badge] ![schema size brotli badge] |
+| [`@terminal-nerds/snippets-object/schema`] | ![schema size gzip badge] ![schema size brotli badge] |
 
 <!-- prettier-ignore-start -->
 <!-- MODULES LINKS -->
 [`@terminal-nerds/snippets-object/keys`]: https://github.com/terminal-nerds/snippets/blob/main/packages/object/source/keys/keys.ts
 [keys size gzip badge]: https://badgen.net/badgesize/gzip/file-object/unpkg.com/@terminal-nerds/snippets-object/dist/keys/keys.js?label=gzip
 [keys size brotli badge]: https://badgen.net/badgesize/brotli/file-object/unpkg.com/@terminal-nerds/snippets-object/dist/keys/keys.js?label=brotli
 
+[`@terminal-nerds/snippets-object/merge`]: https://github.com/terminal-nerds/snippets/blob/main/packages/object/source/merge/merge.ts
+[merge size gzip badge]: https://badgen.net/badgesize/gzip/file-object/unpkg.com/@terminal-nerds/snippets-object/dist/merge/merge.js?label=gzip
+[merge size brotli badge]: https://badgen.net/badgesize/brotli/file-object/unpkg.com/@terminal-nerds/snippets-object/dist/merge/merge.js?label=brotli
+
 [`@terminal-nerds/snippets-object/schema`]: https://github.com/terminal-nerds/snippets/blob/main/packages/object/source/schema/schema.ts
 [schema size gzip badge]: https://badgen.net/badgesize/gzip/file-object/unpkg.com/@terminal-nerds/snippets-object/dist/schema/schema.js?label=gzip
 [schema size brotli badge]: https://badgen.net/badgesize/brotli/file-object/unpkg.com/@terminal-nerds/snippets-object/dist/schema/schema.js?label=brotli

packages/object/package.json

@@ -75,6 +75,7 @@
 	},
 	"dependencies": {
 		"@terminal-nerds/snippets-type": "workspace:*",
+		"deepmerge-ts": "5.0.0",
 		"type-fest": "3.6.1",
 		"zod": "3.21.4"
 	}

packages/object/source/keys/keys.ts

@@ -1,8 +1,10 @@
 import { z } from "zod";
 
-const OBJECT_KEY_SCHEMA = z.number().or(z.string()).or(z.symbol());
+export const OBJECT_KEY_SCHEMA = z.number().or(z.string()).or(z.symbol());
+
 const RENAMER_SCHEMA = z.function().args(OBJECT_KEY_SCHEMA).returns(OBJECT_KEY_SCHEMA);
-type ObjectKey = number | string | symbol;
+
+export type ObjectKey = number | string | symbol;
 
 export function renameObjectKeys<OldKey extends ObjectKey, Value, NewKey extends ObjectKey>(
 	object: Record<OldKey, Value>,

packages/object/source/main.ts

@@ -1,3 +1,4 @@
 /* MODULES */
 export * from "./keys/keys.ts";
+export * from "./merge/merge.ts";
 export * from "./schema/schema.ts";

packages/object/source/merge/merge.test.ts

@@ -0,0 +1,23 @@
+import { SAMPLE_PRIMITIVES } from "@terminal-nerds/snippets-test/sample";
+import { returns, throws } from "@terminal-nerds/snippets-test/unit";
+import { describe, it } from "vitest";
+import { ZodError } from "zod";
+
+import { mergeDeepObjects } from "./merge.ts";
+
+const SAMPLE_OBJECT1 = { a: [1] } as const;
+const SAMPLE_OBJECT2 = { a: [2, 3], b: false } as const;
+const SAMPLE_OBJECT3 = { a: [4, 5], b: true, c: "terminal nerds" } as const;
+
+describe(`deepMergeObjects(objects)`, () => {
+	it(throws(ZodError).on(`invalid object values`).samples(SAMPLE_PRIMITIVES), ({ expect }) => {
+		// @ts-expect-error Testing
+		expect(() => mergeDeepObjects(SAMPLE_PRIMITIVES)).toThrowError(ZodError);
+	});
+
+	const expected = { a: [1, 2, 3, 4, 5], b: true, c: "terminal nerds" } as const;
+
+	it(returns(expected).on(`sample objects`), ({ expect }) => {
+		expect(mergeDeepObjects([SAMPLE_OBJECT1, SAMPLE_OBJECT2, SAMPLE_OBJECT3])).toEqual(expected);
+	});
+});

packages/object/source/merge/merge.ts

@@ -0,0 +1,9 @@
+import { OBJECT_SCHEMA } from "@terminal-nerds/snippets-type/non-primitive";
+import { deepmerge } from "deepmerge-ts";
+import { z } from "zod";
+
+export function mergeDeepObjects(objects: ReadonlyArray<object>): object {
+	z.array(OBJECT_SCHEMA).parse(objects);
+
+	return deepmerge(...objects) as object;
+}