refactor: replace mergeConfigProperty with mergeArraysBy utils function

- Refactored `mergeConfigProperty` into a new generic `mergeArraysBy` utility function.

    - Removed `mergeConfigProperty` method from `Configuration` class.

    - Added new `mergeArraysBy` utility function in `utils` file, and updated the code to be more generic with better typings.

    - Replaced all references to the old method in `Configuration` with the new utils function.

Author: yCodeTech

src/configuration.ts

@@ -700,14 +700,10 @@ export class Configuration {
 		let langConfig = {...internalLangConfig};
 
 		if (multiLine) {
-			langConfig.autoClosingPairs = this.mergeConfigProperty(
-				defaultMultiLineConfig.autoClosingPairs,
-				internalLangConfig?.autoClosingPairs,
-				"open"
-			);
+			langConfig.autoClosingPairs = utils.mergeArraysBy(defaultMultiLineConfig.autoClosingPairs, internalLangConfig?.autoClosingPairs, "open");
 
 			// Add the multi-line onEnter rules to the langConfig.
-			langConfig.onEnterRules = this.mergeConfigProperty(Rules.multilineEnterRules, internalLangConfig?.onEnterRules, "beforeText");
+			langConfig.onEnterRules = utils.mergeArraysBy(Rules.multilineEnterRules, internalLangConfig?.onEnterRules, "beforeText");
 
 			// Only assign the default config comments if it doesn't already exist.
 			// (nullish assignment operator ??=)
@@ -736,15 +732,15 @@ export class Configuration {
 		if (isOnEnter && singleLineStyle) {
 			// //-style comments
 			if (singleLineStyle === "//") {
-				langConfig.onEnterRules = this.mergeConfigProperty(Rules.slashEnterRules, langConfig?.onEnterRules, "beforeText");
+				langConfig.onEnterRules = utils.mergeArraysBy(Rules.slashEnterRules, langConfig?.onEnterRules, "beforeText");
 			}
 			// #-style comments
 			else if (singleLineStyle === "#") {
-				langConfig.onEnterRules = this.mergeConfigProperty(Rules.hashEnterRules, langConfig?.onEnterRules, "beforeText");
+				langConfig.onEnterRules = utils.mergeArraysBy(Rules.hashEnterRules, langConfig?.onEnterRules, "beforeText");
 			}
 			// ;-style comments
 			else if (singleLineStyle === ";") {
-				langConfig.onEnterRules = this.mergeConfigProperty(Rules.semicolonEnterRules, langConfig?.onEnterRules, "beforeText");
+				langConfig.onEnterRules = utils.mergeArraysBy(Rules.semicolonEnterRules, langConfig?.onEnterRules, "beforeText");
 			}
 		}
 		// If isOnEnter is false AND singleLineStyle isn't false, i.e. a string.
@@ -854,40 +850,6 @@ export class Configuration {
 		return vscode.languages.setLanguageConfiguration(langId, langConfig);
 	}
 
-	/**
-	 * Merges two configuration properties arrays, removing any duplicates based on a
-	 * specified property.
-	 *
-	 * @param {any[]} defaultConfigProperty The default configuration property array of objects.
-	 * @param {any[]} internalConfigProperty The internal configuration property array of objects.
-	 * @param {string} objectKey The key within the array item object to check against for preventing duplicates
-	 * @returns {any[]} The merged configuration property array without duplicates.
-	 */
-	private mergeConfigProperty(defaultConfigProperty: any[], internalConfigProperty: any[], objectKey: string) {
-		// Define an empty array if the internalConfigProperty is undefined.
-		internalConfigProperty ??= [];
-
-		// Copy to avoid side effects.
-		const merged = [...defaultConfigProperty];
-
-		/**
-		 * Merge the arrays and remove any duplicates.
-		 */
-
-		// Loop over the internalConfigProperty array...
-		internalConfigProperty.forEach((item) =>
-			// Test all items in the merged array, and if the item's
-			// key is not already present in one of the merged array's objects then add the item
-			// to the merged array.
-			//
-			// Code based on "2023 update" portion of this StackOverflow answer:
-			// https://stackoverflow.com/a/1584377/2358222
-			merged.some((mergedItem) => item[objectKey] === mergedItem[objectKey]) ? null : merged.push(item)
-		);
-
-		return merged;
-	}
-
 	/**
 	 * The keyboard binding event handler for the single-line blocks on shift+enter.
 	 *

src/utils.ts

@@ -125,3 +125,46 @@ export function convertMapToReversedObject(m: Map<string, Map<string, string>>):
 	}
 	return result;
 }
+
+/**
+ * Merges two arrays of objects, removing duplicates based on a specified property.
+ *
+ * Code based on "2023 update" portion of this StackOverflow answer:
+ * https://stackoverflow.com/a/1584377/2358222
+ *
+ * @param {T[]} primaryArray The primary array of objects (takes precedence).
+ * @param {T[]} secondaryArray The secondary array of objects to merge in.
+ * @param {keyof T} key The property key to check for duplicates.
+ *
+ * @returns {T[]} The merged array without duplicates
+ *
+ * @example
+ * const users1 = [{id: 1, name: 'John'}, {id: 2, name: 'Jane'}];
+ * const users2 = [{id: 2, name: 'Jane'}, {id: 3, name: 'Jane Doe'}];
+ * const merged = mergeArraysBy(users1, users2, 'name');
+ * // Result: [{id: 1, name: 'John'}, {id: 2, name: 'Jane'}, {id: 3, name: 'Jane Doe'}]
+ */
+export function mergeArraysBy<T>(primaryArray: T[], secondaryArray: T[], key: keyof T): T[] {
+	// Handle undefined/null arrays
+	const primary = primaryArray || [];
+	const secondary = secondaryArray || [];
+
+	// Start with primary array (avoids side effects)
+	const merged = [...primary];
+
+	// Add items from secondary array that don't exist in primary,
+	// removing any duplicates.
+	secondary.forEach((item) => {
+		// Test all items in the merged array to check if the value of the key
+		// already exists in the merged array.
+		const exists: boolean = merged.some((existingItem) => item[key] === existingItem[key]);
+
+		// If the value of the key does not exist in the merged array,
+		// then add the item, which prevents duplicates.
+		if (!exists) {
+			merged.push(item);
+		}
+	});
+
+	return merged;
+}