Use constants to reference commands in the status bar item

For eng/ide/ada_language_server#1520

Author: AnthonyLeonardoGracio

integration/vscode/ada/src/ExtensionState.ts

@@ -23,6 +23,13 @@ import {
     createSparkTaskProvider,
 } from './taskProviders';
 import { isAbsolute } from 'path';
+import {
+    CMD_SHOW_EXTENSION_LOGS,
+    CMD_SHOW_ADA_LS_OUTPUT,
+    CMD_SHOW_GPR_LS_OUTPUT,
+    CMD_RELOAD_PROJECT,
+    CMD_RESTART_LANG_SERVERS,
+} from './commands';
 
 /**
  * Return type of the 'als-source-dirs' LSP request.
@@ -268,18 +275,18 @@ export class ExtensionState {
             this.statusBar.tooltip.appendMarkdown('\n\n---\n\n');
         }
         this.statusBar.tooltip.appendMarkdown(
-            `[$(terminal) Open Extension Logs](command:ada.showExtensionOutput
+            `[$(terminal) Open Extension Logs](command:${CMD_SHOW_EXTENSION_LOGS}
  "Show Ada Extension Output")
 
-[$(terminal) Open Logs for Ada & SPARK](command:ada.showAdaLSOutput
+[$(terminal) Open Logs for Ada & SPARK](command:${CMD_SHOW_ADA_LS_OUTPUT}
  "Show Ada Language Server for Ada & SPARK Output")
 
-[$(terminal) Open Logs for GPR](command:ada.showGprLSOutput
+[$(terminal) Open Logs for GPR](command:${CMD_SHOW_GPR_LS_OUTPUT}
  "Show Ada Language Server for GPR Output")
 
-[$(refresh) Reload Project](command:als-reload-project "Reload Project")
+[$(refresh) Reload Project](command:${CMD_RELOAD_PROJECT} "Reload Project")
 
-[$(debug-restart) Restart Language Servers](command:ada.restartLanguageServers
+[$(debug-restart) Restart Language Servers](command:${CMD_RESTART_LANG_SERVERS}
  "Restart Ada Language Servers")`,
         );
     };

integration/vscode/ada/src/alsExecuteCommand.ts

@@ -40,6 +40,7 @@ import {
     ReplaceTypeCommandArgs,
 } from './refactoring/alsReplaceTypeCommand';
 import { adaExtState } from './extension';
+import { CMD_RELOAD_PROJECT } from './commands';
 
 /**
  * Type alias for a function that intercepts a command and executes it by return a promise that
@@ -90,7 +91,7 @@ export const alsCommandExecutor = (client: LanguageClient): CommandExecutor => {
                 args[0] as ReplaceTypeCommandArgs,
             );
             if (!proceedWithExecution) return Promise.resolve(undefined);
-        } else if (command === 'als-reload-project') {
+        } else if (command === CMD_RELOAD_PROJECT) {
             // Clear the cache and the predefined tasks when the project
             // has been reloaded.
             adaExtState.clearCacheAndTasks('project is being reloaded: clearing caches and tasks');

integration/vscode/ada/src/commands.ts

@@ -86,9 +86,35 @@ export const CMD_SPARK_LIMIT_SUBP_ARG = 'ada.spark.limitSubpArg';
 export const CMD_SPARK_LIMIT_REGION_ARG = 'ada.spark.limitRegionArg';
 export const CMD_SPARK_PROVE_SUBP = 'ada.spark.proveSubprogram';
 
+/**
+ * Identifier for the command that shows the extension's output in the Output panel.
+ */
+export const CMD_SHOW_EXTENSION_LOGS = 'ada.showExtensionOutput';
+
+/**
+ * Identifier for the command that shows the output of the ALS for Ada in the Output panel.
+ */
+export const CMD_SHOW_ADA_LS_OUTPUT = 'ada.showAdaLSOutput';
+
+/**
+ * Identifier for the command that shows the output of the ALS for GPR in the Output panel.
+ */
+export const CMD_SHOW_GPR_LS_OUTPUT = 'ada.showGprLSOutput';
+
+/**
+ * Identifier for the command that reloads the currently loaded project on server-side.
+ */
+export const CMD_RELOAD_PROJECT = 'als-reload-project';
+
+/**
+ * Identifier for the command that restarts all the language servers spawned by the extension
+ * (Ada and GPR).
+ */
+export const CMD_RESTART_LANG_SERVERS = 'ada.restartLanguageServers';
+
 export function registerCommands(context: vscode.ExtensionContext, clients: ExtensionState) {
     context.subscriptions.push(
-        vscode.commands.registerCommand('ada.restartLanguageServers', restartLanguageServers),
+        vscode.commands.registerCommand(CMD_RESTART_LANG_SERVERS, restartLanguageServers),
     );
     context.subscriptions.push(
         vscode.commands.registerCommand('ada.createHelloWorldProject', createHelloWorldProject),
@@ -116,15 +142,15 @@ export function registerCommands(context: vscode.ExtensionContext, clients: Exte
         vscode.commands.registerCommand('ada.subprogramBox', addSubprogramBoxCommand),
     );
     context.subscriptions.push(
-        vscode.commands.registerCommand('ada.showExtensionOutput', () => mainOutputChannel.show()),
+        vscode.commands.registerCommand(CMD_SHOW_EXTENSION_LOGS, () => mainOutputChannel.show()),
     );
     context.subscriptions.push(
-        vscode.commands.registerCommand('ada.showAdaLSOutput', () =>
+        vscode.commands.registerCommand(CMD_SHOW_ADA_LS_OUTPUT, () =>
             clients.adaClient.outputChannel.show(),
         ),
     );
     context.subscriptions.push(
-        vscode.commands.registerCommand('ada.showGprLSOutput', () =>
+        vscode.commands.registerCommand(CMD_SHOW_GPR_LS_OUTPUT, () =>
             clients.gprClient.outputChannel.show(),
         ),
     );

integration/vscode/ada/test/general/extension.test.ts

@@ -5,6 +5,7 @@ import { activate, assertEqualToFileContent } from '../utils';
 
 import { readFileSync, writeFileSync } from 'fs';
 import * as vscode from 'vscode';
+import { CMD_RESTART_LANG_SERVERS } from '../../src/commands';
 
 suite('Extensions Test Suite', function () {
     // Make sure the extension is activated
@@ -139,7 +140,7 @@ suite('Extensions Test Suite', function () {
                 // Restart the server and check that we still have the same project
                 // loaded on ALS side
                 const oldAlsUri = await adaExtState.getProjectUri();
-                await vscode.commands.executeCommand('ada.restartLanguageServers');
+                await vscode.commands.executeCommand(CMD_RESTART_LANG_SERVERS);
                 const newAlsUri = await adaExtState.getProjectUri();
                 assert.deepStrictEqual(
                     oldAlsUri?.fsPath,