Enhance command registration (#21)

This pull request refactors the way VS Code commands are registered in
the extension by introducing a new `CommandRegistration` interface,
updating the command registration logic to use this interface, and
making related updates to the extension activation process and
configuration. These changes improve code maintainability and
scalability for future commands.

**Command registration improvements:**

* Introduced a new `CommandRegistration` interface in
`src/interfaces/commands.ts` to standardize the structure for
registering commands, including command IDs and handler functions.
* Updated `Configuration.registerCommands` in `src/configuration.ts` to
use the new `CommandRegistration` interface and dynamically register
commands with namespace prefixes, improving scalability and reducing
duplication.

**Extension activation updates:**

* Modified `src/extension.ts` to align with the new command registration
approach, ensuring commands are registered with the correct context and
subscriptions.

**VS Code integration:**

* Added new command definitions for
`auto-comment-blocks.singleLineBlock` and
`auto-comment-blocks.changeBladeMultiLineBlock` to the `commands`
section in `package.json`, ensuring they are discoverable and properly
categorized in VS Code.

Author: yCodeTech

package.json

@@ -81,6 +81,18 @@
 				}
 			}
 		},
+		"commands": [
+			{
+				"command": "auto-comment-blocks.singleLineBlock",
+				"title": "Continue Single-Line Comment Block",
+				"category": "Auto Comment Blocks"
+			},
+			{
+				"command": "auto-comment-blocks.changeBladeMultiLineBlock",
+				"title": "Toggle Blade Multi-Line Comment Style",
+				"category": "Auto Comment Blocks"
+			}
+		],
 		"keybindings": [
 			{
 				"command": "auto-comment-blocks.singleLineBlock",

src/configuration.ts

@@ -15,6 +15,7 @@ import {Settings} from "./interfaces/settings";
 import {ExtraSingleLineCommentStyles, LineComment, SingleLineCommentStyle} from "./interfaces/commentStyles";
 import {ExtensionMetaData} from "./interfaces/extensionMetaData";
 import {JsonObject, JsonArray, LanguageId, MultiLineLanguageDefinitions, SingleLineLanguageDefinitions} from "./interfaces/utils";
+import {CommandRegistration} from "./interfaces/commands";
 
 export class Configuration {
 	/**************
@@ -161,22 +162,25 @@ export class Configuration {
 
 	/**
 	 * Register some VSCode commands.
-	 *
-	 * @returns {vscode.Disposable[]}
 	 */
-	public registerCommands(): vscode.Disposable[] {
-		const singleLineBlockCommand = vscode.commands.registerTextEditorCommand("auto-comment-blocks.singleLineBlock", (textEditor, edit, args) => {
-			this.handleSingleLineBlock(textEditor, edit);
-		});
+	public registerCommands(context: vscode.ExtensionContext) {
+		const namespace = this.extensionData.get("namespace");
 
-		const changeBladeMultiLineBlockCommand = vscode.commands.registerTextEditorCommand(
-			"auto-comment-blocks.changeBladeMultiLineBlock",
-			(textEditor, edit, args) => {
-				this.handleChangeBladeMultiLineBlock(textEditor);
-			}
-		);
+		const commands: CommandRegistration[] = [
+			{
+				command: "singleLineBlock",
+				handler: this.handleSingleLineBlock.bind(this),
+			},
+			{
+				command: "changeBladeMultiLineBlock",
+				handler: this.handleChangeBladeMultiLineBlock.bind(this),
+			},
+		];
 
-		return [singleLineBlockCommand, changeBladeMultiLineBlockCommand];
+		commands.forEach(({command, handler}) => {
+			const namespacedCommand = `${namespace}.${command}`;
+			context.subscriptions.push(vscode.commands.registerTextEditorCommand(namespacedCommand, handler));
+		});
 	}
 
 	/**

src/extension.ts

@@ -14,9 +14,10 @@ const disposables: vscode.Disposable[] = [];
 
 export function activate(context: vscode.ExtensionContext) {
 	const configureCommentBlocksDisposable = configuration.configureCommentBlocks();
-	const registerCommandsDisposable = configuration.registerCommands();
 
-	disposables.push(...configureCommentBlocksDisposable, ...registerCommandsDisposable);
+	configuration.registerCommands(context);
+
+	disposables.push(...configureCommentBlocksDisposable);
 
 	const extensionName = extensionData.get("namespace");
 

src/interfaces/commands.ts

@@ -0,0 +1,33 @@
+import * as vscode from "vscode";
+
+/**
+ * Defines the structure for registering commands.
+ */
+export interface CommandRegistration {
+	/**
+	 * The command ID, corresponding to those defined in package.json
+	 *
+	 * @type {keyof Commands}
+	 */
+	command: keyof Commands;
+
+	/**
+	 * The command handler function.
+	 *
+	 * The parameters are passed to the handler automatically by VS Code when the
+	 * command is executed.
+	 *
+	 * @param textEditor The text editor
+	 * @param edit The text editor edits. Optional because some commands may not need it.
+	 * @returns void
+	 */
+	handler: (textEditor: vscode.TextEditor, edit?: vscode.TextEditorEdit) => void;
+}
+
+/**
+ * Defines command IDs without the namespace prefix.
+ */
+interface Commands {
+	singleLineBlock: string;
+	changeBladeMultiLineBlock: string;
+}