Unify terminal contribution descriptions for contributd terminal commands (#1716)

Author: DonJayamanne

src/extension/chatSessions/vscode-node/copilotCLITerminalIntegration.ts

@@ -70,7 +70,7 @@ export class CopilotCLITerminalIntegration extends Disposable implements ICopilo
 		}
 
 		const storageLocation = path.join(globalStorageUri.fsPath, 'copilotCli');
-		this.terminalService.contributePath('copilot-cli', storageLocation, 'Enables use of the `copilot` command in the terminal.', true);
+		this.terminalService.contributePath('copilot-cli', storageLocation, { command: COPILOT_CLI_COMMAND }, true);
 
 		await fs.mkdir(storageLocation, { recursive: true });
 

src/extension/onboardDebug/vscode-node/copilotDebugCommandContribution.ts

@@ -254,14 +254,14 @@ export class CopilotDebugCommandContribution extends Disposable implements vscod
 		} else if (!previouslyStoredAt) {
 			// 2. enabling a disabled state
 			await this.fillStoragePath(storageLocation);
-			this.terminalService.contributePath('copilot-debug', storageLocation, `Enables use of the \`${COPILOT_DEBUG_COMMAND}\` command in the terminal.`);
+			this.terminalService.contributePath('copilot-debug', storageLocation, { command: COPILOT_DEBUG_COMMAND });
 		} else if (previouslyStoredAt.version !== versionNonce) {
 			// 3. upgrading the worker
 			await this.fillStoragePath(storageLocation);
-			this.terminalService.contributePath('copilot-debug', storageLocation, `Enables use of the \`${COPILOT_DEBUG_COMMAND}\` command in the terminal.`);
+			this.terminalService.contributePath('copilot-debug', storageLocation, { command: COPILOT_DEBUG_COMMAND });
 		} else if (enabled) {
 			// 4. already enabled and up to date, just ensure PATH contribution
-			this.terminalService.contributePath('copilot-debug', storageLocation, `Enables use of the \`${COPILOT_DEBUG_COMMAND}\` command in the terminal.`);
+			this.terminalService.contributePath('copilot-debug', storageLocation, { command: COPILOT_DEBUG_COMMAND });
 		}
 
 		this.context.globalState.update(WAS_REGISTERED_STORAGE_KEY, enabled ? {

src/platform/terminal/common/terminalService.ts

@@ -58,8 +58,16 @@ export interface ITerminalService {
 	 * @param pathLocation The path to add to PATH
 	 * @param description Optional description for the PATH contribution
 	 * @param prepend Whether to prepend (true) or append (false) the path. Defaults to false (append).
-	 */
+	*/
 	contributePath(contributor: string, pathLocation: string, description?: string, prepend?: boolean): void;
+	/**
+	 * Contributes a path to the terminal PATH environment variable.
+	 * @param contributor Unique identifier for the contributor
+	 * @param pathLocation The path to add to PATH
+	 * @param description Optional command thats contributed in the Terminal.
+	 * @param prepend Whether to prepend (true) or append (false) the path. Defaults to false (append).
+	*/
+	contributePath(contributor: string, pathLocation: string, description?: { command: string }, prepend?: boolean): void;
 
 	/**
 	 * Removes a path contribution from the terminal PATH environment variable.
@@ -150,10 +158,13 @@ export class NullTerminalService extends Disposable implements ITerminalService
 		return undefined;
 	}
 
-	contributePath(contributor: string, pathLocation: string, description?: string): void {
+	contributePath(contributor: string, pathLocation: string, description?: string, prepend?: boolean): void;
+	contributePath(contributor: string, pathLocation: string, description?: { command: string }, prepend?: boolean): void;
+	contributePath(contributor: unknown, pathLocation: unknown, description?: unknown, prepend?: unknown): void {
 		// No-op for null service
 	}
 
+
 	removePathContribution(contributor: string): void {
 		// No-op for null service
 	}

src/platform/terminal/vscode/terminalServiceImpl.ts

@@ -3,7 +3,9 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
+import * as l10n from '@vscode/l10n';
 import { Event, ExtensionTerminalOptions, Terminal, TerminalExecutedCommand, TerminalOptions, TerminalShellExecutionEndEvent, TerminalShellIntegrationChangeEvent, window, type TerminalDataWriteEvent } from 'vscode';
+import { coalesce } from '../../../util/vs/base/common/arrays';
 import { Disposable } from '../../../util/vs/base/common/lifecycle';
 import * as path from '../../../util/vs/base/common/path';
 import { IVSCodeExtensionContext } from '../../extContext/common/extensionContext';
@@ -14,7 +16,7 @@ export class TerminalServiceImpl extends Disposable implements ITerminalService
 
 	declare readonly _serviceBrand: undefined;
 
-	private readonly pathContributions = new Map<string, { path: string; description?: string; prepend: boolean }>();
+	private readonly pathContributions = new Map<string, { path: string; description?: string | { command: string }; prepend: boolean }>();
 
 	constructor(
 		@IVSCodeExtensionContext private readonly context: IVSCodeExtensionContext,
@@ -91,7 +93,7 @@ export class TerminalServiceImpl extends Disposable implements ITerminalService
 		return getActiveTerminalShellType();
 	}
 
-	contributePath(contributor: string, pathLocation: string, description?: string, prepend: boolean = false): void {
+	contributePath(contributor: string, pathLocation: string, description?: string | { command: string }, prepend: boolean = false): void {
 		this.pathContributions.set(contributor, { path: pathLocation, description, prepend });
 		this.updateEnvironmentPath();
 	}
@@ -113,12 +115,30 @@ export class TerminalServiceImpl extends Disposable implements ITerminalService
 
 
 		// Build combined description
-		const allDescriptions = Array.from(this.pathContributions.values())
-			.map(c => c.description)
-			.filter(d => d)
-			.join(' and ');
+		const allDescriptions = coalesce(Array.from(this.pathContributions.values())
+			.map(c => c.description && typeof c.description === 'string' ? c.description : undefined)
+			.filter(d => d));
+		let descriptions = '';
+		if (allDescriptions.length === 1) {
+			descriptions = allDescriptions[0];
+		} else if (allDescriptions.length > 1) {
+			descriptions = `${allDescriptions.slice(0, -1).join(', ')} ${l10n.t('and')} ${allDescriptions[allDescriptions.length - 1]}`;
+		}
+
+		const allCommands = coalesce(Array.from(this.pathContributions.values())
+			.map(c => (c.description && typeof c.description !== 'string') ? `\`${c.description.command}\`` : undefined)
+			.filter(d => d));
+
+		let commandsDescription = '';
+		if (allCommands.length === 1) {
+			commandsDescription = l10n.t('Enables use of {0} command in the terminal', allCommands[0]);
+		} else if (allCommands.length > 1) {
+			const commands = `${allCommands.slice(0, -1).join(', ')} ${l10n.t('and')} ${allCommands[allCommands.length - 1]}`;
+			commandsDescription = l10n.t('Enables use of {0} commands in the terminal', commands);
+		}
 
-		this.context.environmentVariableCollection.description = allDescriptions || 'Enables additional commands in the terminal.';
+		const description = [descriptions, commandsDescription].filter(d => d).join(' and ');
+		this.context.environmentVariableCollection.description = description || 'Enables additional commands in the terminal.';
 
 		// Build combined path from all contributions
 		// Since we cannot mix and match append/prepend, if there are any prepend paths, then prepend everything.

src/platform/test/node/simulationWorkspaceServices.ts

@@ -838,7 +838,7 @@ export class TestingTerminalService extends Disposable implements ITerminalServi
 	getBufferWithPid(pid: number, maxChars?: number): Promise<string> {
 		throw new Error('Method not implemented.');
 	}
-	contributePath(contributor: string, pathLocation: string, description?: string): void {
+	contributePath(contributor: string, pathLocation: string, description?: string | { command: string }): void {
 		// No-op for test service
 	}
 	removePathContribution(contributor: string): void {