refactor: extract debug logging from constructor into new method

- Added the new `logDebugInfo` method to log all debugging information to the Output channel.

- Extracted all the debug logging from the `constructor` into it's own method to keep the constructor clean.

- Changed the format of the data logged for the supported languages. Instead of logging the `Map`s, we now utilise the auto-generated language definitions files. This is because the single-line languages are reformatted in a human-readable way to output to the file, so it would be better reading this formatted file than the JS `Map`.

Author: yCodeTech

src/configuration.ts

@@ -65,33 +65,14 @@ export class Configuration {
 		const extensionVersion = vscode.extensions.getExtension(extensionId)?.packageJSON.version;
 		this.logger.info(`Extension: ${extensionId} (${extensionVersion})`);
 
-		const env = {
-			"OS": process.platform,
-			"Platform": process.platform,
-			"VS Code Version": vscode.version,
-			"VS Code Root Path": vscode.env.appRoot,
-			"VS Code Built-in Extensions Path": `${vscode.env.appRoot}\\extensions`,
-			"VS Code Host": vscode.env.appHost,
-			"VS Code Remote Name": vscode.env.remoteName || "local",
-			"Other System Env Variables": process.env,
-		};
-		this.logger.debug("Environment:", env);
-
-		// Log the extension's user configuration settings.
-		this.logger.debug("Configuration settings:", this.getConfiguration());
-
 		this.findAllLanguageConfigFilePaths();
 		this.setLanguageConfigDefinitions();
 
 		this.setMultiLineCommentLanguageDefinitions();
 		this.setSingleLineCommentLanguageDefinitions();
 		this.writeCommentLanguageDefinitionsToJsonFile();
 
-		// Log the objects for debugging purposes.
-		this.logger.debug("The language config filepaths found are:", this.languageConfigFilePaths);
-		this.logger.debug("The language configs found are:", this.languageConfigs);
-		this.logger.debug("The supported languages for multi-line blocks:", this.multiLineBlocksMap);
-		this.logger.debug("The supported languages single-line blocks:", this.singleLineBlocksMap);
+		this.logDebugInfo();
 	}
 
 	/**
@@ -993,4 +974,30 @@ export class Configuration {
 			this.setBladeComments(false);
 		}
 	}
+
+	/**
+	 * Logs the environment, configuration settings, and language configs for debugging purposes.
+	 */
+	private logDebugInfo() {
+		const env = {
+			"OS": process.platform,
+			"Platform": process.platform,
+			"VS Code Version": vscode.version,
+			"VS Code Root Path": vscode.env.appRoot,
+			"VS Code Built-in Extensions Path": `${vscode.env.appRoot}\\extensions`,
+			"VS Code Host": vscode.env.appHost,
+			"VS Code Remote Name": vscode.env.remoteName || "local",
+			"Other System Env Variables": process.env,
+		};
+		this.logger.debug("Environment:", env);
+
+		// Log the extension's user configuration settings.
+		this.logger.debug("Configuration settings:", this.getConfiguration());
+
+		// Log the objects for debugging purposes.
+		this.logger.debug("The language config filepaths found are:", this.languageConfigFilePaths);
+		this.logger.debug("The language configs found are:", this.languageConfigs);
+		this.logger.debug("The supported languages for multi-line blocks:", this.readJsonFile(this.multiLineLangDefinitionFilePath));
+		this.logger.debug("The supported languages for single-line blocks:", this.readJsonFile(this.singleLineLangDefinitionFilePath));
+	}
 }