fix: improve type safety and clarity

- Added some code comments for clarity.

- Improved type safety on a few variables, including the `config` in the `Configuration::setLanguageConfigDefinitions` method and the `event` of the `onDidChangeConfiguration` API in the `activate` method in extension.ts.

Author: yCodeTech

src/configuration.ts

@@ -379,7 +379,7 @@ export class Configuration {
 		this.languageConfigFilePaths.forEach((paths, langId) => {
 			// Loop through the paths array...
 			paths.forEach((filepath) => {
-				let config = utils.readJsonFile(filepath);
+				let config = utils.readJsonFile(filepath) as vscode.LanguageConfiguration;
 
 				// If the config JSON has more than 0 keys (ie. not empty)
 				if (Object.keys(config).length > 0) {
@@ -514,7 +514,8 @@ export class Configuration {
 	 * @returns {string[]} An array of language ID strings.
 	 */
 	private getMultiLineLanguages(key: "supportedLanguages" | "customSupportedLanguages"): string[] {
-		return this.multiLineBlocksMap.get(key);
+		// The non-null assertion operator (!) ensures that the key is never undefined.
+		return this.multiLineBlocksMap.get(key)!;
 	}
 
 	/**
@@ -524,7 +525,8 @@ export class Configuration {
 	 * @returns {Map<string, string>} The Map of the languages and styles.
 	 */
 	private getSingleLineLanguages(key: "supportedLanguages" | "customSupportedLanguages"): Map<string, string> {
-		return this.singleLineBlocksMap.get(key);
+		// The non-null assertion operator (!) ensures that the key is never undefined.
+		return this.singleLineBlocksMap.get(key)!;
 	}
 
 	/**
@@ -1028,6 +1030,7 @@ export class Configuration {
 		rules.forEach((rule) => {
 			if (rule.action && "indent" in rule.action) {
 				// Convert JSON format to API format
+				// Usage of the `any` type is necessary here because `rule.action`
 				const indentValue = (rule.action as any).indent;
 				delete (rule.action as any).indent;
 

src/extension.ts

@@ -32,7 +32,7 @@ export function activate(context: vscode.ExtensionContext) {
 	 * When the configuration/user settings are changed, set the extension
 	 * to reflect the settings and output a message to the user.
 	 */
-	vscode.workspace.onDidChangeConfiguration((event: any) => {
+	vscode.workspace.onDidChangeConfiguration((event: vscode.ConfigurationChangeEvent) => {
 		// TODO: Work on automatically updating the languages instead of making the user reload the extension.
 
 		/**

src/utils.ts

@@ -219,8 +219,7 @@ export function mergeArraysBy<T>(primaryArray: T[], secondaryArray: T[], key: ke
 	// Start with primary array (avoids side effects)
 	const merged = [...primary];
 
-	// Add items from secondary array that don't exist in primary,
-	// removing any duplicates.
+	// 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.