refactor: paths to installed extensions into a separate method

- Added new `ExtensionData::setExtensionDiscoveryPaths` method to set the paths to installed extensions, and added it's method call to the constructor.

- Moved the setting of the extension paths from `setExtensionData` into the new `setExtensionDiscoveryPaths` method.

- Added new `ExtensionPaths` interface and moved all the related properties from the `ExtensionMetaData` interface into the new interface.

- Added new `ExtensionData::extensionDiscoveryPaths` property to hold the Map of all the paths, and uses the `ExtensionPaths` interface.

- Changed references to the `extensionData` property in `setExtensionDiscoveryPaths` method to use the new `extensionDiscoveryPaths` property.

- Added `getExtensionDiscoveryPath` and `getAllExtensionDiscoveryPaths` methods to get a specific extension path by key or get all paths, respectively.

- Changed all method calls to `get` extension paths in `Configuration` class to use the `getExtensionDiscoveryPath` method; and added the `getAllExtensionDiscoveryPaths` method call in the constructor.

Author: yCodeTech

src/configuration.ts

@@ -76,6 +76,7 @@ export class Configuration {
 	public constructor() {
 		// Always output extension information to channel on activate.
 		logger.debug(`Extension details:`, this.extensionData.getAll());
+		logger.debug(`Extension Discovery Paths:`, this.extensionData.getAllExtensionDiscoveryPaths());
 
 		this.findAllLanguageConfigFilePaths();
 		this.setLanguageConfigDefinitions();
@@ -309,8 +310,8 @@ export class Configuration {
 		// If running in WSL...
 		if (isWsl) {
 			// Get the Windows user and built-in extensions paths.
-			const windowsUserExtensionsPath = this.extensionData.get("WindowsUserExtensionsPathFromWsl");
-			const windowsBuiltInExtensionsPath = this.extensionData.get("WindowsBuiltInExtensionsPathFromWsl");
+			const windowsUserExtensionsPath = this.extensionData.getExtensionDiscoveryPath("WindowsUserExtensionsPathFromWsl");
+			const windowsBuiltInExtensionsPath = this.extensionData.getExtensionDiscoveryPath("WindowsBuiltInExtensionsPathFromWsl");
 
 			// Read the paths and create arrays of the extensions.
 			const windowsBuiltInExtensions = this.readExtensionsFromDirectory(windowsBuiltInExtensionsPath);
@@ -320,8 +321,8 @@ export class Configuration {
 			extensions.push(...windowsBuiltInExtensions, ...windowsUserExtensions);
 		}
 
-		const userExtensionsPath = this.extensionData.get("userExtensionsPath");
-		const builtInExtensionsPath = this.extensionData.get("builtInExtensionsPath");
+		const userExtensionsPath = this.extensionData.getExtensionDiscoveryPath("userExtensionsPath");
+		const builtInExtensionsPath = this.extensionData.getExtensionDiscoveryPath("builtInExtensionsPath");
 
 		// Read the paths and create arrays of the extensions.
 		const userExtensions = this.readExtensionsFromDirectory(userExtensionsPath);
@@ -971,25 +972,25 @@ export class Configuration {
 	private logDebugInfo() {
 		// The path to the built-in extensions. The env variable changes when on WSL.
 		// So we can use it for both Windows and WSL.
-		const builtInExtensionsPath = this.extensionData.get("builtInExtensionsPath");
+		const builtInExtensionsPath = this.extensionData.getExtensionDiscoveryPath("builtInExtensionsPath");
 
 		let extensionsPaths = {};
 
 		if (isWsl) {
 			// Get the Windows user and built-in extensions paths.
-			const windowsUserExtensionsPath = this.extensionData.get("WindowsUserExtensionsPathFromWsl");
-			const windowsBuiltInExtensionsPath = this.extensionData.get("WindowsBuiltInExtensionsPathFromWsl");
+			const windowsUserExtensionsPath = this.extensionData.getExtensionDiscoveryPath("WindowsUserExtensionsPathFromWsl");
+			const windowsBuiltInExtensionsPath = this.extensionData.getExtensionDiscoveryPath("WindowsBuiltInExtensionsPathFromWsl");
 
 			extensionsPaths = {
 				"Windows-installed Built-in Extensions Path": windowsBuiltInExtensionsPath,
 				"Windows-installed User Extensions Path": windowsUserExtensionsPath,
 				"WSL-installed Built-in Extensions Path": builtInExtensionsPath,
-				"WSL-installed User Extensions Path": this.extensionData.get("userExtensionsPath"),
+				"WSL-installed User Extensions Path": this.extensionData.getExtensionDiscoveryPath("userExtensionsPath"),
 			};
 		} else {
 			extensionsPaths = {
 				"Built-in Extensions Path": builtInExtensionsPath,
-				"User Extensions Path": this.extensionData.get("userExtensionsPath"),
+				"User Extensions Path": this.extensionData.getExtensionDiscoveryPath("userExtensionsPath"),
 			};
 		}
 

src/extensionData.ts

@@ -4,7 +4,7 @@ import isWsl from "is-wsl";
 import {IPackageJson} from "package-json-type";
 
 import {readJsonFile} from "./utils";
-import {ExtensionMetaData} from "./interfaces/extensionMetaData";
+import {ExtensionMetaData, ExtensionPaths} from "./interfaces/extensionMetaData";
 
 export class ExtensionData {
 	/**
@@ -14,6 +14,14 @@ export class ExtensionData {
 	 */
 	private extensionData = new Map<keyof ExtensionMetaData, string>();
 
+	/**
+	 * Extension discovery paths in the form of a key:value Map object.
+	 *
+	 * @type {Map<keyof ExtensionPaths, string>}
+	 */
+	private extensionDiscoveryPaths = new Map<keyof ExtensionPaths, string>();
+
+
 	/**
 	 * The package.json data for this extension.
 	 *
@@ -24,6 +32,7 @@ export class ExtensionData {
 	public constructor() {
 		this.packageJsonData = this.getExtensionPackageJsonData();
 		this.setExtensionData();
+		this.setExtensionDiscoveryPaths();
 	}
 
 	/**
@@ -53,26 +62,31 @@ export class ExtensionData {
 	 * Set the extension data into the extensionData Map.
 	 */
 	private setExtensionData() {
-		// The path to the user extensions.
-		const userExtensionsPath = isWsl
-			? path.join(vscode.env.appRoot, "../../", "extensions")
-			: path.join(this.packageJsonData.extensionPath, "../");
 
 		// Set each key-value pair directly into the Map
 		this.extensionData.set("id", this.packageJsonData.id);
 		this.extensionData.set("name", this.packageJsonData.name);
 		this.extensionData.set("namespace", this.packageJsonData.contributes.configuration.namespace);
 		this.extensionData.set("displayName", this.packageJsonData.displayName);
 		this.extensionData.set("version", this.packageJsonData.version);
-		this.extensionData.set("userExtensionsPath", userExtensionsPath);
+	}
+
+	private setExtensionDiscoveryPaths() {
+		// The path to the user extensions.
+		// const userExtensionsPath = isWsl ? path.join(vscode.env.appRoot, "../../", "extensions") : path.join(this.extensionPath, "../");
+
+		//TODO: REMOVE THIS BEFORE RELEASE. FOR TESTING ONLY.
+		const userExtensionsPath = isWsl ? path.join(vscode.env.appRoot, "../../", "extensions") : "C:\\Users\\Stuart\\.vscode\\extensions";
+
+		this.extensionDiscoveryPaths.set("userExtensionsPath", userExtensionsPath);
 		// The path to the built-in extensions.
 		// This env variable changes when on WSL to it's WSL-built-in extensions path.
-		this.extensionData.set("builtInExtensionsPath", path.join(vscode.env.appRoot, "extensions"));
+		this.extensionDiscoveryPaths.set("builtInExtensionsPath", path.join(vscode.env.appRoot, "extensions"));
 
 		// Only set these if running in WSL
 		if (isWsl) {
-			this.extensionData.set("WindowsUserExtensionsPathFromWsl", path.dirname(process.env.VSCODE_WSL_EXT_LOCATION!));
-			this.extensionData.set("WindowsBuiltInExtensionsPathFromWsl", path.join(process.env.VSCODE_CWD!, "resources/app/extensions"));
+			this.extensionDiscoveryPaths.set("WindowsUserExtensionsPathFromWsl", path.dirname(process.env.VSCODE_WSL_EXT_LOCATION!));
+			this.extensionDiscoveryPaths.set("WindowsBuiltInExtensionsPathFromWsl", path.join(process.env.VSCODE_CWD!, "resources/app/extensions"));
 		}
 	}
 
@@ -95,4 +109,24 @@ export class ExtensionData {
 	public getAll(): ReadonlyMap<keyof ExtensionMetaData, string> {
 		return this.extensionData;
 	}
+
+	/**
+	 * Get the extension discovery paths by a specified key.
+	 *
+	 * @param {K} key The key of the specific path to get.
+	 *
+	 * @returns {ExtensionPaths[K] | undefined} The value of the extension detail, or undefined if the key does not exist.
+	 */
+	public getExtensionDiscoveryPath<K extends keyof ExtensionPaths>(key: K): ExtensionPaths[K] | undefined {
+		return this.extensionDiscoveryPaths.get(key) as ExtensionPaths[K] | undefined;
+	}
+
+	/**
+	 * Get all extension discovery paths.
+	 *
+	 * @returns {ReadonlyMap<keyof ExtensionPaths, string>} A read-only Map containing all extension discovery paths.
+	 */
+	public getAllExtensionDiscoveryPaths(): ReadonlyMap<keyof ExtensionPaths, string> {
+		return this.extensionDiscoveryPaths;
+	}
 }

src/interfaces/extensionMetaData.ts

@@ -30,6 +30,13 @@ export interface ExtensionMetaData {
 	 * Directly from package.json "version" key.
 	 */
 	version: string;
+
+}
+
+/**
+ * Extension discovery paths configuration for this extension
+ */
+export interface ExtensionPaths {
 	/**
 	 * The path to the user extensions.
 	 */