refactor: retrieval of extension data into a new ExtensionData class.

Changed:

- Moved `getExtensionPackageJsonData`, `setExtensionData`, `getExtensionData` methods into a new `ExtensionData` class for simplicity and better organisation.

- Simplified the `getExtensionPackageJsonData` method to get all package.json data not just a select few.

By using the new type `IPackageJson`, we can properly type the data as package.json instead of a generic `object` or `any`.

    - Changed the `name` variable to `namespace`, simplied it's code and added it to the `contributes.configuration` object of the packageJson data, since it's the namespace of the  settings
    - Changed the `name` variable to `namespace`, simplied it's code and added it to the `contributes.configuration` object of the packageJson data, since it's the namespace of the configuration settings.

- Split `setExtensionData` into 2 methods: `setExtensionData` and `createExtensionData`; and simplified the code.

    - `createExtensionData` to create the extension data object, defining the keys and values for the Map. The keys as defined here will also be used for type inference for VScode intellisense in the new `get` method.

    - `setExtensionData` to set the data as defined in `createExtensionData` method into the `extensionData` Map.

- Changed all references to the old `getExtensionData` method to use the `get` method of the new `ExtensionData` class.

- Renamed the `Configuration` property `extensionDetails` to `extensionData`; and instantiate the `ExtensionData` class as it's value.

Added:

- Added new `get` method to get the extension's data by a specified key.

VScode intellisense auto-suggests the keys by using type inference from the keys set in `createExtensionData` method. This is important so remembering or looking up the keys isn't a pain.

- Added `getAll` method to get all extension data as readonly so it can only be logged in the Output Channel.

- Added a new dependency `package-json-type` to allow package.json typings as `IPackageJson`.

Author: yCodeTech

package.json

@@ -110,6 +110,7 @@
 	},
 	"dependencies": {
 		"is-wsl": "^3.1.0",
-		"jsonc-parser": "^3.3.1"
+		"jsonc-parser": "^3.3.1",
+		"package-json-type": "^1.0.3"
 	}
 }

src/configuration.ts

@@ -9,6 +9,7 @@ import isWsl from "is-wsl";
 import {Rules} from "./rules";
 import {Logger} from "./logger";
 import * as utils from "./utils";
+import {ExtensionData} from "./extensionData";
 
 export class Configuration {
 	/**************
@@ -23,9 +24,10 @@ export class Configuration {
 	private logger: Logger;
 
 	/**
-	 * This extension details in the form of a key:value Map object, for ease of use.
+	 * This extension data class instance.
+	 * @type {ExtensionData}
 	 */
-	private extensionDetails = new Map<string, any>();
+	private extensionData: ExtensionData = new ExtensionData();
 
 	/**
 	 * A key:value Map object of language IDs and their config file paths.
@@ -66,10 +68,8 @@ export class Configuration {
 	public constructor(logger: Logger) {
 		this.logger = logger;
 
-		this.setExtensionData();
-
 		// Always output extension information to channel on activate.
-		this.logger.debug(`Extension details:`, this.extensionDetails);
+		this.logger.debug(`Extension details:`, this.extensionData.getAll());
 
 		this.findAllLanguageConfigFilePaths();
 		this.setLanguageConfigDefinitions();
@@ -198,86 +198,13 @@ export class Configuration {
 		}
 	}
 
-	/**
-	 * Get the names, id, and version of this extension from package.json.
-	 *
-	 * @returns {object} An object containing the extension id, name, display name, and version.
-	 */
-	private getExtensionPackageJsonData(): {id: string; name: string; displayName: string; version: string} {
-		const packageJSON = utils.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, 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;
-
-		// The path to the user extensions.
-		const userExtensionsPath = isWsl
-			? path.join(vscode.env.appRoot, "../../", "extensions")
-			: path.join(vscode.extensions.getExtension(id).extensionPath, "../");
-
-		// The path to the built-in extensions.
-		// This env variable changes when on WSL to it's WSL-built-in extensions path.
-		const builtInExtensionsPath = path.join(vscode.env.appRoot, "extensions");
-
-		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);
-		this.extensionDetails.set("builtInExtensionsPath", builtInExtensionsPath);
-
-		if (isWsl) {
-			// Get the root path to VS Code from the env variable, and use it to get
-			// the Windows built-in extensions.
-			const windowsBuiltInExtensionsPathFromWsl = path.join(process.env.VSCODE_CWD, "resources/app/extensions");
-
-			// Get the Windows user extensions path from env variable.
-			const windowsUserExtensionsPathFromWsl = path.dirname(process.env.VSCODE_WSL_EXT_LOCATION);
-
-			this.extensionDetails.set("WindowsUserExtensionsPathFromWsl", windowsUserExtensionsPathFromWsl);
-			this.extensionDetails.set("WindowsBuiltInExtensionsPathFromWsl", windowsBuiltInExtensionsPathFromWsl);
-		}
-	}
-
-	/**
-	 * 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);
-		}
-	}
-
 	/**
 	 * Get all the extension's configuration settings.
 	 *
 	 * @returns {vscode.WorkspaceConfiguration}
 	 */
 	public getConfiguration(): vscode.WorkspaceConfiguration {
-		return vscode.workspace.getConfiguration(this.getExtensionData("name"), null);
+		return vscode.workspace.getConfiguration(this.extensionData.get("name"), null);
 	}
 
 	/**
@@ -368,15 +295,15 @@ export class Configuration {
 		// If running in WSL...
 		if (isWsl) {
 			// Get the Windows user and built-in extensions paths.
-			const windowsUserExtensionsPath = this.getExtensionData("WindowsUserExtensionsPathFromWsl");
-			const windowsBuiltInExtensionsPath = this.getExtensionData("WindowsBuiltInExtensionsPathFromWsl");
+			const windowsUserExtensionsPath = this.extensionData.get("WindowsUserExtensionsPathFromWsl");
+			const windowsBuiltInExtensionsPath = this.extensionData.get("WindowsBuiltInExtensionsPathFromWsl");
 
 			// Read the paths and create arrays of the extensions.
-			const builtInExtensions = this.readExtensionsFromDirectory(windowsBuiltInExtensionsPath);
-			const userExtensions = this.readExtensionsFromDirectory(windowsUserExtensionsPath);
+			const windowsBuiltInExtensions = this.readExtensionsFromDirectory(windowsBuiltInExtensionsPath);
+			const windowsUserExtensions = this.readExtensionsFromDirectory(windowsUserExtensionsPath);
 
 			// Combine the built-in and user extensions into the extensions array.
-			extensions.push(...builtInExtensions, ...userExtensions);
+			extensions.push(...windowsBuiltInExtensions, ...windowsUserExtensions);
 		}
 
 		// Add all installed extensions (including built-in ones) into the extensions array.
@@ -916,7 +843,7 @@ export class Configuration {
 	 */
 	private handleChangeBladeMultiLineBlock(textEditor: vscode.TextEditor) {
 		let langId = textEditor.document.languageId;
-		const extensionName = this.getExtensionData("name");
+		const extensionName = this.extensionData.get("name");
 
 		// Only carry out function if languageId is blade.
 		if (langId === "blade" && !this.isLangIdDisabled(langId)) {
@@ -955,25 +882,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.getExtensionData("builtInExtensionsPath");
+		const builtInExtensionsPath = this.extensionData.get("builtInExtensionsPath");
 
 		let extensionsPaths = {};
 
 		if (isWsl) {
 			// Get the Windows user and built-in extensions paths.
-			const windowsUserExtensionsPath = this.getExtensionData("WindowsUserExtensionsPathFromWsl");
-			const windowsBuiltInExtensionsPath = this.getExtensionData("WindowsBuiltInExtensionsPathFromWsl");
+			const windowsUserExtensionsPath = this.extensionData.get("WindowsUserExtensionsPathFromWsl");
+			const windowsBuiltInExtensionsPath = this.extensionData.get("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.getExtensionData("userExtensionsPath"),
+				"WSL-installed User Extensions Path": this.extensionData.get("userExtensionsPath"),
 			};
 		} else {
 			extensionsPaths = {
 				"Built-in Extensions Path": builtInExtensionsPath,
-				"User Extensions Path": this.getExtensionData("userExtensionsPath"),
+				"User Extensions Path": this.extensionData.get("userExtensionsPath"),
 			};
 		}
 

src/extension.ts

@@ -4,8 +4,10 @@ import * as vscode from "vscode";
 
 import {Configuration} from "./configuration";
 import {Logger} from "./logger";
+import {ExtensionData} from "./extensionData";
 
 const logger = new Logger();
+const extensionData = new ExtensionData();
 logger.setupOutputChannel();
 let configuration = new Configuration(logger);
 
@@ -17,8 +19,9 @@ export function activate(context: vscode.ExtensionContext) {
 
 	disposables.push(...configureCommentBlocksDisposable, ...registerCommandsDisposable);
 
-	const extensionName = configuration.getExtensionData("name");
-	const extensionDisplayName = configuration.getExtensionData("displayName");
+	const extensionName = extensionData.get("name");
+
+	const extensionDisplayName = extensionData.get("displayName");
 
 	let disabledLangConfig: string[] = configuration.getConfigurationValue<string[]>("disabledLanguages");
 

src/extensionData.ts

@@ -0,0 +1,110 @@
+import * as vscode from "vscode";
+import * as path from "path";
+import isWsl from "is-wsl";
+import {IPackageJson} from "package-json-type";
+
+import {readJsonFile} from "./utils";
+
+export class ExtensionData {
+	/**
+	 * This extension details in the form of a key:value Map object.
+	 *
+	 * @type {Map<string, string>}
+	 */
+	private extensionData = new Map<string, string>();
+
+	/**
+	 * The package.json data for this extension.
+	 *
+	 * @type {IPackageJson}
+	 */
+	private packageJsonData: IPackageJson;
+
+	public constructor() {
+		this.packageJsonData = this.getExtensionPackageJsonData();
+		this.setExtensionData();
+	}
+
+	/**
+	 * Get the names, id, and version of this extension from package.json.
+	 *
+	 * @returns {IPackageJson} The package.json data for this extension, plus the new `id`, and `contributes.configuration.namespace` keys.
+	 */
+	private getExtensionPackageJsonData(): IPackageJson {
+		const packageJSON: IPackageJson = readJsonFile(__dirname + "/../../package.json");
+
+		// Set the id (publisher.name) into the packageJSON object as a new `id` key.
+		packageJSON.id = `${packageJSON.publisher}.${packageJSON.name}`;
+
+		// The configuration settings namespace is a shortened version of the extension name.
+		// We just need to replace "automatic" with "auto" in the name.
+		const settingsNamespace: string = packageJSON.name.replace("automatic", "auto");
+		// Set the namespace to the packageJSON `configuration` object as a new `namespace` key.
+		packageJSON.contributes.configuration.namespace = settingsNamespace;
+
+		return packageJSON;
+	}
+
+	/**
+	 * Set the extension data into the extensionData Map.
+	 */
+	private setExtensionData() {
+		// Set all entries in the extensionData Map.
+		Object.entries(this.createExtensionData()).forEach(([key, value]) => {
+			this.extensionData.set(key, value);
+		});
+	}
+
+	/**
+	 * Create the extension data object for the extensionData Map.
+	 * It also helps for type inference intellisense in the get method.
+	 *
+	 * @returns The extension data object with keys and values.
+	 */
+	private createExtensionData() {
+		// The path to the user extensions.
+		const userExtensionsPath = isWsl
+			? path.join(vscode.env.appRoot, "../../", "extensions")
+			: path.join(vscode.extensions.getExtension(id).extensionPath, "../");
+
+
+		// Set the keys and values for the Map.
+		// The keys will also be used for type inference in VSCode intellisense.
+		return {
+			id: this.packageJsonData.id,
+			name: this.packageJsonData.contributes.configuration.namespace,
+			displayName: this.packageJsonData.displayName,
+			version: this.packageJsonData.version,
+			userExtensionsPath: userExtensionsPath,
+			// The path to the built-in extensions.
+			// This env variable changes when on WSL to it's WSL-built-in extensions path.
+			builtInExtensionsPath: path.join(vscode.env.appRoot, "extensions"),
+
+			// Only set these if running in WSL.
+			...(isWsl && {
+				WindowsUserExtensionsPathFromWsl: path.dirname(process.env.VSCODE_WSL_EXT_LOCATION!),
+				WindowsBuiltInExtensionsPathFromWsl: path.join(process.env.VSCODE_CWD!, "resources/app/extensions"),
+			}),
+		} as const;
+	}
+
+	/**
+	 * Get the extension's data by a specified key.
+	 *
+	 * @param {K} key The key of the extension detail to get.
+	 *
+	 * @returns {ReturnType<typeof this.createExtensionData>[K] | undefined} The value of the extension detail, or undefined if the key does not exist.
+	 */
+	public get<K extends keyof ReturnType<typeof this.createExtensionData>>(key: K): ReturnType<typeof this.createExtensionData>[K] | undefined {
+		return this.extensionData.get(key) as ReturnType<typeof this.createExtensionData>[K] | undefined;
+	}
+
+	/**
+	 * Get all extension data.
+	 *
+	 * @returns {ReadonlyMap<string, string>} A read-only Map containing all extension details.
+	 */
+	public getAll(): ReadonlyMap<string, string> {
+		return this.extensionData;
+	}
+}