fix: JSON file reading with optional null return for missing files.

- Moved the check for package.json file existing (`fs.existsSync`) in `Configruation::readExtensionsFromDirectory` method into the `readJsonFile` utility function. This is so that the util function can check if a JSON file exists before trying to read it. If file doesn't exist then it just returns `null`.

    - Removed the `fs.existsSync` check and replaced it with a `null` check in the `readExtensionsFromDirectory` method.

- Refactored `readJsonFile` util function to accept a new `throwOnFileMissing` param with a default value of `true`. This param, along with it's accompanying logic, will throw an error if a file is missing (doesn't exist) and when the param is `true, instead of returning `null`.

This allows only specific usages of the util function to return `null` instead of error throwing when the param is set to `false`. Thus being backward compatibile with other usages.

Author: yCodeTech

src/configuration.ts

@@ -495,16 +495,17 @@ export class Configuration {
 
 				// Get the package.json file path.
 				const packageJSONPath = path.join(extensionPath, "package.json");
+				const packageJSON: IPackageJson = utils.readJsonFile(packageJSONPath, false);
 
-				// If the package.json file exists...
-				if (fs.existsSync(packageJSONPath)) {
-					const packageJSON: IPackageJson = utils.readJsonFile(packageJSONPath);
+				if (packageJSON === null) {
+					return;
+				}
 
-					const id = `${packageJSON.publisher}.${packageJSON.name}`;
+				const id = `${packageJSON.publisher}.${packageJSON.name}`;
 
-					// Push the extension data object into the array.
-					foundExtensions.push({id, extensionPath, packageJSON});
-				}
+				// Push the extension data object into the array.
+				foundExtensions.push({id, extensionPath, packageJSON});
+				
 			}
 		});
 

src/utils.ts

@@ -7,11 +7,26 @@ import {window} from "vscode";
  * Read the file and parse the JSON.
  *
  * @param {string} filepath The path of the file.
+ * @param {boolean} [throwOnFileMissing=true] Whether to throw an error if the file doesn't exist.
+ * If `false`, returns `null`. Default is `true`.
  *
- * @returns {any} The JSON file content as an object.
- * @throws Will throw an error if the JSON file cannot be parsed.
+ * @returns {any | null} The JSON file content as an object, or `null` if file doesn't exist and `throwOnFileMissing` is `false`.
+ * @throws Will throw an error if the JSON file cannot be parsed or if file doesn't exist and `throwOnFileMissing` is `true`.
  */
-export function readJsonFile(filepath: string): any {
+export function readJsonFile(filepath: string, throwOnFileMissing: boolean = true): any | null {
+	// Check if file exists first.
+	// If file doesn't exist...
+	if (!fs.existsSync(filepath)) {
+		// If throwOnFileMissing param is true, throw an error.
+		if (throwOnFileMissing) {
+			const error = new Error(`JSON file not found: "${filepath}"`);
+			logger.error(error.stack);
+			throw error;
+		}
+		// Otherwise just return null.
+		return null;
+	}
+
 	const jsonErrors: jsonc.ParseError[] = [];
 
 	const fileContent = fs
@@ -31,7 +46,7 @@ export function readJsonFile(filepath: string): any {
 			.showErrorMessage(
 				`${errorMsg}. The extension cannot continue. Please check the "Auto Comment Blocks" Output Channel for errors.`,
 				"OK",
-				"Open Output Channel"
+				"Open Output Channel",
 			)
 			.then((selection) => {
 				if (selection === "Open Output Channel") {