fix: languageConfigFilePaths to support multiple config paths per lang

Due to some extensions either not specifying all the language configuration properties in the file or setting the comment properties to an empty array (like the "stillat-llc.vscode-antlers" extension does which overrides the HTML config and makes the comments not work without the extension activated), we need to ensure that they are merged with other possible configs for the language.

- Changed `languageConfigFilePaths` Map to accept an array value instead of just a single string.

- Changed `findAllLanguageConfigFilePaths` method to set the config path into an array as the value in `languageConfigFilePaths` Map, and to push a new path into the array if the `langId` key already exists in the Map.

- Changed `setLanguageConfigDefinitions` method to allow it to loop through the new array of paths which sets the configs into the `languageConfigs` Map, and if the `langId` key already exists then merge the existing config with the new config.

This merges the comments from both configs together and skips empty arrays. It also merges all other config properties together to ensure we are getting a full language configuration. By merging all available configs for the language, the language won't have any issues regarding malformed configs, or comments not working.

Author: yCodeTech

src/configuration.ts

@@ -33,7 +33,7 @@ export class Configuration {
 	/**
 	 * A key:value Map object of language IDs and their config file paths.
 	 */
-	private languageConfigFilePaths = new Map<string, string>();
+	private languageConfigFilePaths = new Map<string, string[]>();
 
 	/**
 	 * A key:value Map object of language IDs and their configs.
@@ -343,70 +343,117 @@ export class Configuration {
 			if (Object.hasOwn(packageJSON, "contributes") && Object.hasOwn(packageJSON.contributes, "languages")) {
 				// Loop through the languages...
 				for (let language of packageJSON.contributes.languages) {
+					const langId = language.id;
 					// Get the languages to skip.
 					let skipLangs = this.getLanguagesToSkip();
 
-					// If skipLangs doesn't include the language ID,
+					// If skipLangs doesn't include the langId,
 					// AND the language object has "configuration" key...
-					if (!skipLangs?.includes(language.id) && Object.hasOwn(language, "configuration")) {
+					if (!skipLangs?.includes(langId) && Object.hasOwn(language, "configuration")) {
 						// Join the extension path with the configuration path.
 						let configPath = path.join(extension.extensionPath, language.configuration);
-						// Set the language ID and config path into the languageConfigFilePaths Map.
-						this.languageConfigFilePaths.set(language.id, configPath);
+
+						// If the langId already exists...
+						if (this.languageConfigFilePaths.has(langId)) {
+							// Push the new config path into the array of the existing langId.
+							this.languageConfigFilePaths.get(langId).push(configPath);
+						}
+						// Otherwise, if the langId doesn't exist...
+						else {
+							// Set the langId with a new config path array.
+							this.languageConfigFilePaths.set(langId, [configPath]);
+						}
 					}
 				}
 			}
 		}
 
 		// Set the languageConfigFilePaths to a new map with all the languages sorted in
-		// ascending order,for sanity reasons.
+		// ascending order, for sanity reasons.
 		this.languageConfigFilePaths = new Map([...this.languageConfigFilePaths].sort());
 	}
 
 	/**
 	 * Set the language config definitions.
 	 */
 	private setLanguageConfigDefinitions() {
-		this.languageConfigFilePaths.forEach((filepath, langId) => {
-			const config = utils.readJsonFile(filepath);
-
-			// If the config JSON has more than 0 keys (ie. not empty)
-			if (Object.keys(config).length > 0) {
-				/**
-				 * Change all autoClosingPairs items that are using the simpler syntax
-				 * (array instead of object) into the object with open and close keys.
-				 * Prevents vscode from failing quietly and not changing the editor language
-				 * properly, which makes the open file become unresponsive when changing tabs.
-				 */
-
-				// If config has key autoClosingPairs...
-				if (Object.hasOwn(config, "autoClosingPairs")) {
-					// Define a new array as the new AutoClosingPair.
-					const autoClosingPairsArray: vscode.AutoClosingPair[] = [];
-					// Loop through the config's autoClosingPairs...
-					config.autoClosingPairs.forEach((item) => {
-						// If the item is an array...
-						if (Array.isArray(item)) {
-							// Create a new object with the 1st array element [0] as the
-							// value of the open key, and the 2nd element [1] as the value
-							// of the close key.
-							const autoClosingPairsObj = {open: item[0], close: item[1]};
-							// Push the object into the new array.
-							autoClosingPairsArray.push(autoClosingPairsObj);
+		this.languageConfigFilePaths.forEach((paths, langId) => {
+			// Loop through the paths array...
+			paths.forEach((filepath) => {
+				let config = utils.readJsonFile(filepath);
+
+				// If the config JSON has more than 0 keys (ie. not empty)
+				if (Object.keys(config).length > 0) {
+					/**
+					 * Change all autoClosingPairs items that are using the simpler syntax
+					 * (array instead of object) into the object with open and close keys.
+					 * Prevents vscode from failing quietly and not changing the editor language
+					 * properly, which makes the open file become unresponsive when changing tabs.
+					 */
+
+					// If config has key autoClosingPairs...
+					if (Object.hasOwn(config, "autoClosingPairs")) {
+						// Define a new array as the new AutoClosingPair.
+						const autoClosingPairsArray: vscode.AutoClosingPair[] = [];
+						// Loop through the config's autoClosingPairs...
+						config.autoClosingPairs.forEach((item) => {
+							// If the item is an array...
+							if (Array.isArray(item)) {
+								// Create a new object with the 1st array element [0] as the
+								// value of the open key, and the 2nd element [1] as the value
+								// of the close key.
+								const autoClosingPairsObj = {open: item[0], close: item[1]};
+								// Push the object into the new array.
+								autoClosingPairsArray.push(autoClosingPairsObj);
+							}
+							// Otherwise, the item is an object, so just push it into the array.
+							else {
+								autoClosingPairsArray.push(item);
+							}
+						});
+
+						// Add the new array to the config's autoClosingPairs key.
+						config.autoClosingPairs = autoClosingPairsArray;
+					}
+
+					// If the langId already exists, then it has multiple config files from
+					// different extensions, so we need to merge them together to ensure
+					// a full configuration is set, to avoid issues of missing values.
+					if (this.languageConfigs.has(langId)) {
+						const existingConfig = this.languageConfigs.get(langId);
+
+						// Only merge if both configs have comments
+						if (existingConfig.comments && config.comments) {
+							// Start with existing comments as base
+							const mergedComments = {...existingConfig.comments};
+
+							// Merge each comment type from new config.
+							Object.entries(config.comments).forEach(([key, value]) => {
+								// Skip empty arrays.
+								if (Array.isArray(value) && value.length === 0) {
+									return;
+								}
+								mergedComments[key] = value;
+							});
+
+							// Update the config with merged comments
+							config = {
+								...existingConfig,
+								...config,
+								comments: mergedComments,
+							};
 						}
-						// Otherwise, the item is an object, so just push it into the array.
+						// If only one config has comments or neither has comments...
 						else {
-							autoClosingPairsArray.push(item);
+							// Just merge the configs directly.
+							config = {...existingConfig, ...config};
 						}
-					});
+					}
 
-					// Add the new array to the config's autoClosingPairs key.
-					config.autoClosingPairs = autoClosingPairsArray;
+					// Set the language configs into the Map.
+					this.languageConfigs.set(langId, config);
 				}
-
-				// Set the language configs into the Map.
-				this.languageConfigs.set(langId, config);
-			}
+			});
 		});
 	}