refactor: create a uniform way of obtaining this extension's details.

Added:

- Added new `extensionDetails` private property in `Configuration` as a Map object.

- Added new `setExtensionData` method to set the data into the `extensionDetails` Map. Also added its method call into the `constructor`.

- Added new `getExtensionData`  public method to get the value of a specified key from the `extensionDetails` Map.

Changed:

- Refactored `getExtensionNames` to be more generic.

This will be used in the new `setExtensionData` method to get and set the names, id and version into the `extensionDetails` Map.

    - Changed the name to `getExtensionPackageJsonData`.

    - Changed it's visibility to `private`.

    - Changed the reading of the package.json file to use the `readJsonFile` method as it does the exact same thing, and makes it DRYer.

    - Added the extension's version.

- Changed all references to the old `getExtensionNames` method to use the new `getExtensionData` method with the specific key needed.

Removed:

- Removed the unused `extensionNames` variable and method call from the `getExtensionsPathsFromWslEnv` method.

Author: yCodeTech

src/configuration.ts

@@ -22,6 +22,11 @@ export class Configuration {
 	 */
 	private logger: Logger;
 
+	/**
+	 * This extension details in the form of a key:value Map object, for ease of use.
+	 */
+	private extensionDetails = new Map<string, any>();
+
 	/**
 	 * A key:value Map object of language IDs and their config file paths.
 	 */
@@ -61,10 +66,12 @@ export class Configuration {
 	public constructor(logger: Logger) {
 		this.logger = logger;
 
+		this.setExtensionData();
+
 		// Always output extension information to channel on activate.
-		const extensionId = this.getExtensionNames().id;
-		const extensionVersion = vscode.extensions.getExtension(extensionId)?.packageJSON.version;
-		this.logger.info(`Extension: ${extensionId} (${extensionVersion})`);
+		const id = this.getExtensionData("id");
+		const version = this.getExtensionData("version");
+		this.logger.info(`Extension: ${id} (${version})`);
 
 		this.findAllLanguageConfigFilePaths();
 		this.setLanguageConfigDefinitions();
@@ -194,22 +201,56 @@ export class Configuration {
 	}
 
 	/**
-	 * Get the names and ids of this extension from package.json.
+	 * Get the names, id, and version of this extension from package.json.
 	 *
-	 * @returns {object} An object containing the extension id, name, and display name.
+	 * @returns {object} An object containing the extension id, name, display name, and version.
 	 */
-	public getExtensionNames(): {id: string; name: string; displayName: string} {
-		const packageJSON = JSON.parse(fs.readFileSync(__dirname + "/../../package.json").toString());
+	private getExtensionPackageJsonData(): {id: string; name: string; displayName: string; version: string} {
+		const packageJSON = this.readJsonFile(__dirname + "/../../package.json");
 
 		const displayName: string = packageJSON.displayName;
 		const fullname: string = packageJSON.name;
 		const id: string = `${packageJSON.publisher}.${fullname}`;
+		const version: string = packageJSON.version;
 
 		let nameParts = fullname.split("-");
 		nameParts[0] = "auto";
 		const name = nameParts.join("-");
 
-		return {id: id, name: name, displayName: displayName};
+		return {id: id, name: name, displayName: displayName, version: version};
+	}
+
+	/**
+	 * Set the extension data into the extensionDetails Map.
+	 */
+	private setExtensionData() {
+		const extensionPackageJsonData = this.getExtensionPackageJsonData();
+
+		const id = extensionPackageJsonData.id;
+		const name = extensionPackageJsonData.name;
+		const displayName = extensionPackageJsonData.displayName;
+		const version = extensionPackageJsonData.version;
+
+		const userExtensionsPath = path.join(vscode.extensions.getExtension(id).extensionPath, "../");
+
+		this.extensionDetails.set("id", id);
+		this.extensionDetails.set("name", name);
+		this.extensionDetails.set("displayName", displayName);
+		this.extensionDetails.set("version", version);
+		this.extensionDetails.set("userExtensionsPath", userExtensionsPath);
+	}
+
+	/**
+	 * Get the extension's details.
+	 *
+	 * @param {string} key The key of the specific extension detail to get.
+	 *
+	 * @returns {any} Returns a value of a specific key.
+	 */
+	public getExtensionData(key: string): any {
+		if (this.extensionDetails.has(key)) {
+			return this.extensionDetails.get(key);
+		}
 	}
 
 	/**
@@ -218,7 +259,7 @@ export class Configuration {
 	 * @returns {vscode.WorkspaceConfiguration}
 	 */
 	public getConfiguration(): vscode.WorkspaceConfiguration {
-		return vscode.workspace.getConfiguration(this.getExtensionNames().name, null);
+		return vscode.workspace.getConfiguration(this.getExtensionData("name"), null);
 	}
 
 	/**
@@ -997,7 +1038,7 @@ export class Configuration {
 	 */
 	private handleChangeBladeMultiLineBlock(textEditor: vscode.TextEditor) {
 		let langId = textEditor.document.languageId;
-		const extensionNames = this.getExtensionNames();
+		const extensionName = this.getExtensionData("name");
 
 		// Only carry out function if languageId is blade.
 		if (langId === "blade" && !this.isLangIdDisabled(langId)) {
@@ -1021,7 +1062,7 @@ export class Configuration {
 		// then output a message to the user.
 		else if (langId == "blade" && this.isLangIdDisabled(langId)) {
 			vscode.window.showInformationMessage(
-				`Blade is set as disabled in the "${extensionNames.name}.disabledLanguages" setting. The "${extensionNames.name}.bladeOverrideComments" setting will have no affect.`,
+				`Blade is set as disabled in the "${extensionName}.disabledLanguages" setting. The "${extensionName}.bladeOverrideComments" setting will have no affect.`,
 				"OK"
 			);
 
@@ -1036,8 +1077,6 @@ export class Configuration {
 	 * @returns {Object} An object containing the user and built-in extensions paths.
 	 */
 	private getExtensionsPathsFromWslEnv() {
-		const extensionNames = this.getExtensionNames();
-
 		/** Built-in Extensions */
 
 		// Get the path to the VS Code's exectutable from the VSCODE_CWD environment variable.

src/extension.ts

@@ -17,10 +17,8 @@ export function activate(context: vscode.ExtensionContext) {
 
 	disposables.push(...configureCommentBlocksDisposable, ...registerCommandsDisposable);
 
-	const extensionNames = configuration.getExtensionNames();
-
-	const extensionName = extensionNames.name;
-	const extensionDisplayName = extensionNames.displayName;
+	const extensionName = configuration.getExtensionData("name");
+	const extensionDisplayName = configuration.getExtensionData("displayName");
 
 	let disabledLangConfig: string[] = configuration.getConfigurationValue<string[]>("disabledLanguages");