fix: ts 7.0 type errors.

Fixed TS 7.0 errors by ensuring:

- Variables don't have `undefined` or `null` values before accessing them and providing fallback values if they are undefined with the null coalescing operator (??) and conditional ternary operator (? .. : .. ).

- Values from methods are satisfying their expected return types using the `as` keyword and generic typed method calls.

- Object keys aren't accessed if the object itself is `undefined` with the optional chaining operator (?.) and proper undefined type guards and conditionals.

- `reconstructRegex` util function infers the correct type from the passed `obj` param.

- Error stack logging has a fallback of the error message in case the stack is null/undefined.

- `convertMapToReversedObject` util function has properly typed `result` instead of implicit `any` type and changed the reverse object mapping to mutate the existing array instead of rebuilding a new one on every iteration.

Author: yCodeTech

src/configuration.ts

@@ -95,7 +95,7 @@ export class Configuration {
 		// Read the default multi-line config from the JSON file and cache it for later use.
 		this.defaultMultiLineConfig = utils.readJsonFile(`${configPath}/default-multi-line-config.json`) as vscode.LanguageConfiguration;
 		// Read the languages to skip from the JSON file and cache it for later use.
-		this.languagesToSkip = utils.readJsonFile(`${configPath}/skip-languages.jsonc`);
+		this.languagesToSkip = utils.readJsonFile<JsonObject>(`${configPath}/skip-languages.jsonc`) ?? {};
 
 		this.findAllLanguageConfigFilePaths();
 		this.setLanguageConfigDefinitions();
@@ -255,7 +255,7 @@ export class Configuration {
 	 * ```
 	 */
 	public getConfigurationValue<K extends keyof Settings>(key: K): Settings[K] {
-		return this.getConfiguration().get<Settings[K]>(key);
+		return this.getConfiguration().get<Settings[K]>(key) as Settings[K];
 	}
 
 	/**
@@ -343,8 +343,8 @@ export class Configuration {
 		const builtInExtensionsPath = this.extensionData.getExtensionDiscoveryPath("builtInExtensionsPath");
 
 		// Read the paths and create arrays of the extensions.
-		const userExtensions = this.readExtensionsFromDirectory(userExtensionsPath);
-		const builtInExtensions = this.readExtensionsFromDirectory(builtInExtensionsPath);
+		const userExtensions = userExtensionsPath ? this.readExtensionsFromDirectory(userExtensionsPath) : [];
+		const builtInExtensions = builtInExtensionsPath ? this.readExtensionsFromDirectory(builtInExtensionsPath) : [];
 
 		// Add all installed extensions (including built-in ones) into the extensions array.
 		// If running WSL, these will be the WSL-installed extensions.
@@ -372,7 +372,7 @@ export class Configuration {
 						// 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);
+							this.languageConfigFilePaths.get(langId)?.push(configPath);
 						}
 						// Otherwise, if the langId doesn't exist...
 						else {
@@ -412,7 +412,7 @@ export class Configuration {
 						// Define a new array as the new AutoClosingPair.
 						const autoClosingPairsArray: vscode.AutoClosingPair[] = [];
 						// Loop through the config's autoClosingPairs...
-						config.autoClosingPairs.forEach((item) => {
+						(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
@@ -439,7 +439,7 @@ export class Configuration {
 						const existingConfig = this.languageConfigs.get(langId);
 
 						// Only merge if both configs have comments
-						if (existingConfig.comments && config.comments) {
+						if (existingConfig?.comments && config.comments) {
 							// Start with existing comments as base
 							const mergedComments = {...existingConfig.comments};
 
@@ -449,7 +449,9 @@ export class Configuration {
 								if (Array.isArray(value) && value.length === 0) {
 									return;
 								}
-								mergedComments[key] = value;
+								if (key === "lineComment" || key === "blockComment") {
+									mergedComments[key] = value;
+								}
 							});
 
 							// Update the config with merged comments
@@ -555,7 +557,7 @@ export class Configuration {
 		this.languageConfigs.forEach((config: vscode.LanguageConfiguration, langId: LanguageId) => {
 			// If the config object has own property of comments AND the comments key has
 			// own property of blockComment...
-			if (Object.hasOwn(config, "comments") && Object.hasOwn(config.comments, "blockComment")) {
+			if (config.comments && Object.hasOwn(config.comments, "blockComment") && config.comments.blockComment) {
 				// If the blockComment array includes the multi-line start of "/*"...
 				if (config.comments.blockComment.includes("/*")) {
 					// console.log(langId, config.comments);
@@ -627,7 +629,7 @@ export class Configuration {
 
 			// If the config object has own property of comments AND the comments key has
 			// own property of lineComment...
-			if (Object.hasOwn(config, "comments") && Object.hasOwn(config.comments, "lineComment")) {
+			if (config.comments && Object.hasOwn(config.comments, "lineComment")) {
 				let lineComment = config.comments.lineComment;
 
 				// Line comments can be a string or an object with a "comment" key.
@@ -752,21 +754,19 @@ export class Configuration {
 
 		// Deep-clone the internalLangConfig so modifications never write back
 		// into the cached `languageConfigs` Map by accident.
-		let langConfig: vscode.LanguageConfiguration = internalLangConfig
-			? structuredClone(internalLangConfig)
-			: {};
+		let langConfig: vscode.LanguageConfiguration = internalLangConfig ? structuredClone(internalLangConfig) : {};
 
 		if (multiLine) {
 			langConfig.autoClosingPairs = utils.mergeArraysBy<vscode.AutoClosingPair>(
-				this.defaultMultiLineConfig.autoClosingPairs,
-				internalLangConfig?.autoClosingPairs,
+				this.defaultMultiLineConfig.autoClosingPairs ?? [],
+				internalLangConfig?.autoClosingPairs ?? [],
 				"open"
 			);
 
 			// Add the multi-line onEnter rules to the langConfig.
 			langConfig.onEnterRules = utils.mergeArraysBy<vscode.OnEnterRule>(
 				Rules.multilineEnterRules,
-				internalLangConfig?.onEnterRules,
+				internalLangConfig?.onEnterRules ?? [],
 				"beforeText"
 			);
 
@@ -780,7 +780,7 @@ export class Configuration {
 			if (this.isLangIdMultiLineCommentOverridden(langId) && langConfig.comments?.blockComment) {
 				langConfig.comments.blockComment = [
 					this.getOverriddenMultiLineComment(langId),
-					langConfig.comments.blockComment[1]
+					langConfig.comments.blockComment[1],
 				];
 			}
 
@@ -792,6 +792,7 @@ export class Configuration {
 
 				// If bladeComments has a value...
 				if (bladeComments) {
+					langConfig.comments ??= {};
 					langConfig.comments.blockComment = bladeComments;
 				}
 			}
@@ -805,22 +806,26 @@ export class Configuration {
 		if (isOnEnter && singleLineStyle) {
 			// //-style comments
 			if (singleLineStyle === "//") {
-				langConfig.onEnterRules = utils.mergeArraysBy<vscode.OnEnterRule>(Rules.slashEnterRules, langConfig?.onEnterRules, "beforeText");
+				langConfig.onEnterRules = utils.mergeArraysBy<vscode.OnEnterRule>(Rules.slashEnterRules, langConfig.onEnterRules ?? [], "beforeText");
 			}
 			// #-style comments
 			else if (singleLineStyle === "#") {
-				langConfig.onEnterRules = utils.mergeArraysBy<vscode.OnEnterRule>(Rules.hashEnterRules, langConfig?.onEnterRules, "beforeText");
+				langConfig.onEnterRules = utils.mergeArraysBy<vscode.OnEnterRule>(Rules.hashEnterRules, langConfig.onEnterRules ?? [], "beforeText");
 			}
 			// ;-style comments
 			else if (singleLineStyle === ";") {
-				langConfig.onEnterRules = utils.mergeArraysBy<vscode.OnEnterRule>(Rules.semicolonEnterRules, langConfig?.onEnterRules, "beforeText");
+				langConfig.onEnterRules = utils.mergeArraysBy<vscode.OnEnterRule>(
+					Rules.semicolonEnterRules,
+					langConfig.onEnterRules ?? [],
+					"beforeText"
+				);
 			}
 		}
 		// If isOnEnter is false AND singleLineStyle isn't false, i.e. a string.
 		else if (!isOnEnter && singleLineStyle) {
 			// If langConfig does NOT have a comments key OR
 			// the comments key exists but does NOT have the lineComment key...
-			if (!Object.hasOwn(langConfig, "comments") || !Object.hasOwn(langConfig.comments, "lineComment")) {
+			if (!langConfig.comments || !Object.hasOwn(langConfig.comments, "lineComment")) {
 				// Add the singleLineStyle to the lineComments key and make sure any
 				// blockComments aren't overwritten.
 				langConfig.comments = {...langConfig.comments, lineComment: singleLineStyle};
@@ -838,7 +843,7 @@ export class Configuration {
 
 		// Check if isOnEnter OR multiline is true.
 		if (isOnEnter || multiLine) {
-			langConfig.onEnterRules.forEach((item) => {
+			(langConfig.onEnterRules ?? []).forEach((item) => {
 				// Check if the item has a "beforeText" property and reconstruct its regex pattern.
 				if (Object.hasOwn(item, "beforeText")) {
 					item.beforeText = utils.reconstructRegex(item, "beforeText");
@@ -934,19 +939,20 @@ export class Configuration {
 	 * @param {vscode.TextEditor} textEditor The text editor.
 	 * @param {vscode.TextEditorEdit} edit The text editor edits.
 	 */
-	private handleSingleLineBlock(textEditor: vscode.TextEditor, edit: vscode.TextEditorEdit) {
+	private handleSingleLineBlock(textEditor: vscode.TextEditor, edit?: vscode.TextEditorEdit) {
 		let langId: LanguageId = textEditor.document.languageId;
 		const singleLineLangs = this.getSingleLineLanguages("supportedLanguages");
 		const customSingleLineLangs = this.getSingleLineLanguages("customSupportedLanguages");
 
 		// Get the langId from the auto-supported langs. If it doesn't exist, try getting it from
 		// the custom-supported langs instead.
-		let style: SingleLineCommentStyle | ExtraSingleLineCommentStyles = singleLineLangs.get(langId) ?? customSingleLineLangs.get(langId);
+		let style: SingleLineCommentStyle | ExtraSingleLineCommentStyles | undefined =
+			singleLineLangs.get(langId) ?? customSingleLineLangs.get(langId);
 
 		if (style && textEditor.selection.isEmpty) {
 			let line = textEditor.document.lineAt(textEditor.selection.active);
 			let isCommentLine = true;
-			let indentRegex: RegExp;
+			let indentRegex: RegExp | undefined;
 
 			if (style === "//" && line.text.search(/^\s*\/\/\s*/) !== -1) {
 				indentRegex = /\//;
@@ -972,7 +978,7 @@ export class Configuration {
 				isCommentLine = false;
 			}
 
-			if (!isCommentLine) {
+			if (!isCommentLine || !indentRegex) {
 				return;
 			}
 
@@ -982,7 +988,7 @@ export class Configuration {
 				indentedNewLine += style + " ";
 			}
 
-			edit.insert(textEditor.selection.active, indentedNewLine);
+			edit?.insert(textEditor.selection.active, indentedNewLine);
 		}
 	}
 

src/utils.ts

@@ -23,7 +23,7 @@ export function readJsonFile<T extends JsonValue = JsonObject>(filepath: string,
 		// If throwOnFileMissing param is true, throw an error.
 		if (throwOnFileMissing) {
 			const error = new Error(`JSON file not found: "${filepath}"`);
-			logger.error(error.stack);
+			logger.error(error.stack ?? error.message);
 			throw error;
 		}
 		// Otherwise just return null.
@@ -60,7 +60,7 @@ function parseJsonContent<T extends JsonValue = JsonObject>(filepath: string, fi
 		const errorMsg = "Failed to parse a required JSON file";
 		const error = new Error(`${errorMsg}: "${filepath}"\n\n\tParse Errors:\n\n${errorMessages}\n\tStack Trace:`);
 
-		logger.error(error.stack);
+		logger.error(error.stack ?? error.message);
 
 		window
 			.showErrorMessage(
@@ -137,18 +137,20 @@ export function ensureDirExists(dir: string) {
  * Reconstruct the regex pattern because vscode doesn't like the regex pattern as a string,
  * or some patterns are not working as expected.
  *
- * @param {unknown} obj The object
+ * @param {T} obj The object
  * @param {string} key The key to check in the object
  * @returns {RegExp} The reconstructed regex pattern.
  */
-export function reconstructRegex(obj: unknown, key: string): RegExp {
+export function reconstructRegex<T extends object, K extends keyof T>(obj: T, key: K): RegExp {
+	const value = obj[key];
+
 	// If key has a "pattern" key, then it's an object...
-	if (Object.hasOwn(obj[key], "pattern")) {
-		return new RegExp(obj[key].pattern);
+	if (typeof value === "object" && value !== null && Object.hasOwn(value, "pattern")) {
+		return new RegExp((value as unknown as {pattern: string}).pattern);
 	}
 	// Otherwise it's a string.
 	else {
-		return new RegExp(obj[key]);
+		return new RegExp(value as string);
 	}
 }
 
@@ -185,7 +187,7 @@ export function reconstructRegex(obj: unknown, key: string): RegExp {
  * }
  */
 export function convertMapToReversedObject<T extends JsonValue = JsonObject>(m: Map<string, Map<string, string>>): T {
-	const result = {};
+	const result: Record<string, Record<string, string[]>> = {};
 
 	// Convert a nested key:value Map from inside another Map into an key:array object,
 	// while reversing/switching the keys and values. The Map's values are now the keys of
@@ -199,15 +201,15 @@ export function convertMapToReversedObject<T extends JsonValue = JsonObject>(m:
 
 		// Reverse the inner object mapping.
 		//
-		// Loop through the object (o) keys, assigns a new object (r) with the value of the
-		// object key (k) as the new key (eg. "//") and the new value is an array of all
-		// the original object keys (o[k]) (eg. "php").
-		// If the key (o[k]) already exists in the new object (r), then just add the
-		// original key to the array, otherwise start a new array ([]) with the original
-		// key as value ( (r[o[k]] || []).concat(k) ).
-		// Add this new reversed object to the result object with the outer map key
-		// as the key.
-		result[key] = Object.keys(o).reduce((r, k) => Object.assign(r, {[o[k]]: (r[o[k]] || []).concat(k)}), {});
+		// Loop through the object (o) keys, and for each one, push the key (itemKey, eg. "php")
+		// onto the array keyed by its value (o[itemKey], eg. "//") in the reversed object,
+		// creating that array on first use. Add this reversed object to the result object
+		// with the outer map key as the key.
+		result[key] = Object.keys(o).reduce<Record<string, string[]>>((reversed, itemKey) => {
+			const value = o[itemKey];
+			(reversed[value] ??= []).push(itemKey);
+			return reversed;
+		}, {});
 	}
 	return result as T;
 }
@@ -279,9 +281,9 @@ function validateDevEnvVariables() {
 		// Trim whitespace and resolve the path to an absolute path
 		let devPath = path.resolve(process.env.DEV_USER_EXTENSIONS_PATH.trim());
 
-		let stats: fs.Stats;
+		let stats: fs.Stats | undefined;
 		let errorMsg: string = "";
-		let errorData: Error;
+		let errorData: Error | undefined;
 
 		// Get the file system stats for the path to check if it exists.
 		// statSync throws an exception if the no file system data exists for the path,
@@ -293,7 +295,7 @@ function validateDevEnvVariables() {
 			const errorCode = nodeError.code || "UNKNOWN";
 
 			// Handle specific file system errors with user-friendly messages.
-			const errorMessages = {
+			const errorMessages: Record<string, string> = {
 				ENOENT: "Path from env variable 'DEV_USER_EXTENSIONS_PATH' does not exist",
 				EACCES: "Permission denied accessing path from env variable 'DEV_USER_EXTENSIONS_PATH'",
 				UNKNOWN: "Unknown error accessing the path from env variable 'DEV_USER_EXTENSIONS_PATH'",