add id for TerminalCommand, add Add to Chat action for commands (microsoft#272943)

Author: meganrogge

src/vs/platform/terminal/common/capabilities/capabilities.ts

@@ -291,6 +291,7 @@ interface IBaseTerminalCommand {
 	isTrusted: boolean;
 	timestamp: number;
 	duration: number;
+	id: string;
 
 	// Optional serializable
 	cwd: string | undefined;

src/vs/platform/terminal/common/capabilities/commandDetection/terminalCommand.ts

@@ -6,13 +6,15 @@
 import { IMarkProperties, ISerializedTerminalCommand, ITerminalCommand } from '../capabilities.js';
 import { ITerminalOutputMatcher, ITerminalOutputMatch } from '../../terminal.js';
 import type { IBuffer, IBufferLine, IMarker, Terminal } from '@xterm/headless';
+import { generateUuid } from '../../../../../base/common/uuid.js';
 
 export interface ITerminalCommandProperties {
 	command: string;
 	commandLineConfidence: 'low' | 'medium' | 'high';
 	isTrusted: boolean;
 	timestamp: number;
 	duration: number;
+	id: string;
 	marker: IMarker | undefined;
 	cwd: string | undefined;
 	exitCode: number | undefined;
@@ -48,6 +50,7 @@ export class TerminalCommand implements ITerminalCommand {
 	get markProperties() { return this._properties.markProperties; }
 	get executedX() { return this._properties.executedX; }
 	get startX() { return this._properties.startX; }
+	get id() { return this._properties.id; }
 
 	constructor(
 		private readonly _xterm: Terminal,
@@ -72,6 +75,7 @@ export class TerminalCommand implements ITerminalCommand {
 			command: isCommandStorageDisabled ? '' : serialized.command,
 			commandLineConfidence: serialized.commandLineConfidence ?? 'low',
 			isTrusted: serialized.isTrusted,
+			id: serialized.id,
 			promptStartMarker,
 			marker,
 			startX: serialized.startX,
@@ -107,6 +111,7 @@ export class TerminalCommand implements ITerminalCommand {
 			timestamp: this.timestamp,
 			duration: this.duration,
 			markProperties: this.markProperties,
+			id: this.id,
 		};
 	}
 
@@ -271,13 +276,15 @@ export class PartialTerminalCommand implements ICurrentPartialCommand {
 	cwd?: string;
 	command?: string;
 	commandLineConfidence?: 'low' | 'medium' | 'high';
+	id: string;
 
 	isTrusted?: boolean;
 	isInvalid?: boolean;
 
 	constructor(
 		private readonly _xterm: Terminal,
 	) {
+		this.id = generateUuid();
 	}
 
 	serialize(cwd: string | undefined): ISerializedTerminalCommand | undefined {
@@ -300,7 +307,8 @@ export class PartialTerminalCommand implements ICurrentPartialCommand {
 			commandStartLineContent: undefined,
 			timestamp: 0,
 			duration: 0,
-			markProperties: undefined
+			markProperties: undefined,
+			id: this.id
 		};
 	}
 
@@ -315,6 +323,7 @@ export class PartialTerminalCommand implements ICurrentPartialCommand {
 				command: ignoreCommandLine ? '' : (this.command || ''),
 				commandLineConfidence: ignoreCommandLine ? 'low' : (this.commandLineConfidence || 'low'),
 				isTrusted: !!this.isTrusted,
+				id: this.id,
 				promptStartMarker: this.promptStartMarker,
 				marker: this.commandStartMarker,
 				startX: this.commandStartX,

src/vs/workbench/contrib/chat/browser/actions/chatContext.ts

@@ -4,7 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 import { CancellationToken } from '../../../../../base/common/cancellation.js';
 import { Codicon } from '../../../../../base/common/codicons.js';
-import { Disposable } from '../../../../../base/common/lifecycle.js';
+import { Disposable, DisposableStore } from '../../../../../base/common/lifecycle.js';
 import { isElectron } from '../../../../../base/common/platform.js';
 import { dirname } from '../../../../../base/common/resources.js';
 import { ThemeIcon } from '../../../../../base/common/themables.js';
@@ -29,6 +29,9 @@ import { IChatWidget } from '../chat.js';
 import { imageToHash, isImage } from '../chatPasteProviders.js';
 import { convertBufferToScreenshotVariable } from '../contrib/screenshot.js';
 import { ChatInstructionsPickerPick } from '../promptSyntax/attachInstructionsAction.js';
+import { ITerminalService } from '../../../terminal/browser/terminal.js';
+import { URI } from '../../../../../base/common/uri.js';
+import { ITerminalCommand, TerminalCapability } from '../../../../../platform/terminal/common/capabilities/capabilities.js';
 
 
 export class ChatContextContributions extends Disposable implements IWorkbenchContribution {
@@ -258,6 +261,73 @@ class ClipboardImageContextValuePick implements IChatContextValueItem {
 	}
 }
 
+export class TerminalContext implements IChatContextValueItem {
+
+	readonly type = 'valuePick';
+	readonly icon = Codicon.terminal;
+	readonly label = localize('terminal', 'Terminal');
+	constructor(private readonly _resource: URI, @ITerminalService private readonly _terminalService: ITerminalService) {
+
+	}
+	async isEnabled(widget: IChatWidget) {
+		const terminal = this._terminalService.getInstanceFromResource(this._resource);
+		return !!widget.attachmentCapabilities.supportsTerminalAttachments && terminal?.isDisposed === false;
+	}
+	async asAttachment(widget: IChatWidget): Promise<IChatRequestVariableEntry | undefined> {
+		const terminal = this._terminalService.getInstanceFromResource(this._resource);
+		if (!terminal) {
+			return;
+		}
+
+		const command = terminal.capabilities.get(TerminalCapability.CommandDetection)?.commands.find(cmd => cmd.id === this._resource.query);
+		if (!command) {
+			return;
+		}
+		const attachment: IChatRequestVariableEntry = {
+			kind: 'terminalCommand',
+			id: `terminalCommand:${Date.now()}}`,
+			value: this.asValue(command),
+			name: command.command,
+			command: command.command,
+			output: command.getOutput(),
+			exitCode: command.exitCode,
+			resource: this._resource
+		};
+		const cleanup = new DisposableStore();
+		let disposed = false;
+		const disposeCleanup = () => {
+			if (disposed) {
+				return;
+			}
+			disposed = true;
+			cleanup.dispose();
+		};
+		cleanup.add(widget.attachmentModel.onDidChange(e => {
+			if (e.deleted.includes(attachment.id)) {
+				disposeCleanup();
+			}
+		}));
+		cleanup.add(terminal.onDisposed(() => {
+			widget.attachmentModel.delete(attachment.id);
+			widget.refreshParsedInput();
+			disposeCleanup();
+		}));
+		return attachment;
+	}
+
+	private asValue(command: ITerminalCommand): string {
+		let value = `Command: ${command.command}`;
+		const output = command.getOutput();
+		if (output) {
+			value += `\nOutput:\n${output}`;
+		}
+		if (typeof command.exitCode === 'number') {
+			value += `\nExit Code: ${command.exitCode}`;
+		}
+		return value;
+	}
+}
+
 class ScreenshotContextValuePick implements IChatContextValueItem {
 
 	readonly type = 'valuePick';

src/vs/workbench/contrib/chat/browser/chatAttachmentModel.ts

@@ -33,7 +33,7 @@ export class ChatAttachmentModel extends Disposable {
 	constructor(
 		@IFileService private readonly fileService: IFileService,
 		@ISharedWebContentExtractorService private readonly webContentExtractorService: ISharedWebContentExtractorService,
-		@IChatAttachmentResolveService private readonly chatAttachmentResolveService: IChatAttachmentResolveService
+		@IChatAttachmentResolveService private readonly chatAttachmentResolveService: IChatAttachmentResolveService,
 	) {
 		super();
 	}

src/vs/workbench/contrib/chat/browser/chatAttachmentWidgets.ts

@@ -17,6 +17,7 @@ import { MarkdownString } from '../../../../base/common/htmlContent.js';
 import { Iterable } from '../../../../base/common/iterator.js';
 import { KeyCode } from '../../../../base/common/keyCodes.js';
 import { Disposable, DisposableStore, IDisposable } from '../../../../base/common/lifecycle.js';
+import { Schemas } from '../../../../base/common/network.js';
 import { basename, dirname } from '../../../../base/common/path.js';
 import { ThemeIcon } from '../../../../base/common/themables.js';
 import { URI } from '../../../../base/common/uri.js';
@@ -52,8 +53,9 @@ import { revealInSideBarCommand } from '../../files/browser/fileActions.contribu
 import { CellUri } from '../../notebook/common/notebookCommon.js';
 import { INotebookService } from '../../notebook/common/notebookService.js';
 import { getHistoryItemEditorTitle } from '../../scm/browser/util.js';
+import { ITerminalService } from '../../terminal/browser/terminal.js';
 import { IChatContentReference } from '../common/chatService.js';
-import { IChatRequestPasteVariableEntry, IChatRequestVariableEntry, IElementVariableEntry, INotebookOutputVariableEntry, IPromptFileVariableEntry, IPromptTextVariableEntry, ISCMHistoryItemVariableEntry, OmittedState, PromptFileVariableKind, ChatRequestToolReferenceEntry, ISCMHistoryItemChangeVariableEntry, ISCMHistoryItemChangeRangeVariableEntry } from '../common/chatVariableEntries.js';
+import { IChatRequestPasteVariableEntry, IChatRequestVariableEntry, IElementVariableEntry, INotebookOutputVariableEntry, IPromptFileVariableEntry, IPromptTextVariableEntry, ISCMHistoryItemVariableEntry, OmittedState, PromptFileVariableKind, ChatRequestToolReferenceEntry, ISCMHistoryItemChangeVariableEntry, ISCMHistoryItemChangeRangeVariableEntry, ITerminalVariableEntry } from '../common/chatVariableEntries.js';
 import { ILanguageModelChatMetadataAndIdentifier, ILanguageModelsService } from '../common/languageModels.js';
 import { ILanguageModelToolsService, ToolSet } from '../common/languageModelToolsService.js';
 import { getCleanPromptName } from '../common/promptSyntax/config/promptFileLocations.js';
@@ -91,6 +93,7 @@ abstract class AbstractChatAttachmentWidget extends Disposable {
 		protected readonly currentLanguageModel: ILanguageModelChatMetadataAndIdentifier | undefined,
 		@ICommandService protected readonly commandService: ICommandService,
 		@IOpenerService protected readonly openerService: IOpenerService,
+		@ITerminalService protected readonly terminalService?: ITerminalService,
 	) {
 		super();
 		this.element = dom.append(container, $('.chat-attached-context-attachment.show-file-icons'));
@@ -160,6 +163,11 @@ abstract class AbstractChatAttachmentWidget extends Disposable {
 			return;
 		}
 
+		if (resource.scheme === Schemas.vscodeTerminal) {
+			this.terminalService?.openResource(resource);
+			return;
+		}
+
 		// Open file in editor
 		const openTextEditorOptions: ITextEditorOptions | undefined = range ? { selection: range } : undefined;
 		const options: OpenInternalOptions = {
@@ -170,6 +178,7 @@ abstract class AbstractChatAttachmentWidget extends Disposable {
 				...openOptions.editorOptions
 			},
 		};
+
 		await this.openerService.open(resource, options);
 		this._onDidOpen.fire();
 		this.element.focus();
@@ -249,6 +258,118 @@ export class FileAttachmentWidget extends AbstractChatAttachmentWidget {
 	}
 }
 
+
+export class TerminalCommandAttachmentWidget extends AbstractChatAttachmentWidget {
+
+	constructor(
+		attachment: ITerminalVariableEntry,
+		currentLanguageModel: ILanguageModelChatMetadataAndIdentifier | undefined,
+		options: { shouldFocusClearButton: boolean; supportsDeletion: boolean },
+		container: HTMLElement,
+		contextResourceLabels: ResourceLabels,
+		@ICommandService commandService: ICommandService,
+		@IOpenerService openerService: IOpenerService,
+		@IHoverService private readonly hoverService: IHoverService,
+		@ITerminalService protected override readonly terminalService: ITerminalService,
+	) {
+		super(attachment, options, container, contextResourceLabels, currentLanguageModel, commandService, openerService, terminalService);
+
+		const ariaLabel = localize('chat.terminalCommand', "Terminal command, {0}", attachment.command);
+		const clickHandler = () => this.openResource(attachment.resource, { editorOptions: { preserveFocus: true } }, false, undefined);
+
+		this._register(createTerminalCommandElements(this.element, attachment, ariaLabel, this.hoverService, clickHandler));
+
+		this._register(dom.addDisposableListener(this.element, dom.EventType.KEY_DOWN, async (e: KeyboardEvent) => {
+			if ((e.target as HTMLElement | null)?.closest('.monaco-button')) {
+				return;
+			}
+			const event = new StandardKeyboardEvent(e);
+			if (event.equals(KeyCode.Enter) || event.equals(KeyCode.Space)) {
+				dom.EventHelper.stop(e, true);
+				await clickHandler();
+			}
+		}));
+
+		this.attachClearButton();
+	}
+}
+
+const MAX_TERMINAL_ATTACHMENT_OUTPUT_LENGTH = 2000;
+
+function createTerminalCommandElements(
+	element: HTMLElement,
+	attachment: ITerminalVariableEntry,
+	ariaLabel: string,
+	hoverService: IHoverService,
+	clickHandler: () => Promise<void>
+): IDisposable {
+	const disposable = new DisposableStore();
+	element.ariaLabel = ariaLabel;
+	element.style.cursor = 'pointer';
+
+	const pillIcon = dom.$('div.chat-attached-context-pill', {}, dom.$('span.codicon.codicon-terminal'));
+	const textLabel = dom.$('span.chat-attached-context-custom-text', {}, attachment.command);
+	element.appendChild(pillIcon);
+	element.appendChild(textLabel);
+
+	disposable.add(dom.addDisposableListener(element, dom.EventType.CLICK, e => {
+		if ((e.target as HTMLElement | null)?.closest('.monaco-button')) {
+			return;
+		}
+		void clickHandler();
+	}));
+
+	const hoverElement = dom.$('div.chat-attached-context-hover');
+	hoverElement.setAttribute('aria-label', ariaLabel);
+
+	const commandTitle = dom.$('div', {}, typeof attachment.exitCode === 'number'
+		? localize('chat.terminalCommandHoverCommandTitleExit', "Command: {0}, exit code: {1}", attachment.command, attachment.exitCode)
+		: localize('chat.terminalCommandHoverCommandTitle', "Command"));
+	commandTitle.classList.add('attachment-additional-info');
+	const commandBlock = dom.$('pre.chat-terminal-command-block');
+	hoverElement.append(commandTitle, commandBlock);
+
+	if (attachment.output && attachment.output.trim().length > 0) {
+		const outputTitle = dom.$('div', {}, localize('chat.terminalCommandHoverOutputTitle', "Output"));
+		outputTitle.classList.add('attachment-additional-info');
+		const outputBlock = dom.$('pre.chat-terminal-command-output');
+		let outputText = attachment.output;
+		let truncated = false;
+		if (outputText.length > MAX_TERMINAL_ATTACHMENT_OUTPUT_LENGTH) {
+			outputText = `${outputText.slice(0, MAX_TERMINAL_ATTACHMENT_OUTPUT_LENGTH)}...`;
+			truncated = true;
+		}
+		outputBlock.textContent = outputText;
+		hoverElement.append(outputTitle, outputBlock);
+
+		if (truncated) {
+			const truncatedInfo = dom.$('div', {}, localize('chat.terminalCommandHoverOutputTruncated', "Output truncated to first {0} characters.", MAX_TERMINAL_ATTACHMENT_OUTPUT_LENGTH));
+			truncatedInfo.classList.add('attachment-additional-info');
+			hoverElement.appendChild(truncatedInfo);
+		}
+	}
+
+	const hint = dom.$('div', {}, localize('chat.terminalCommandHoverHint', "Click to focus this command in the terminal."));
+	hint.classList.add('attachment-additional-info');
+	hoverElement.appendChild(hint);
+
+	const separator = dom.$('div.chat-attached-context-url-separator');
+	const openLink = dom.$('a.chat-attached-context-url', {}, localize('chat.terminalCommandHoverOpen', "Open in terminal"));
+	disposable.add(dom.addDisposableListener(openLink, 'click', e => {
+		e.preventDefault();
+		e.stopPropagation();
+		void clickHandler();
+	}));
+	hoverElement.append(separator, openLink);
+
+	disposable.add(hoverService.setupDelayedHover(element, {
+		...commonHoverOptions,
+		content: hoverElement,
+	}, commonHoverLifecycleOptions));
+
+	return disposable;
+}
+
 export class ImageAttachmentWidget extends AbstractChatAttachmentWidget {
 
 	constructor(

src/vs/workbench/contrib/chat/browser/chatContentParts/chatAttachmentsContentPart.ts

@@ -11,9 +11,9 @@ import { URI } from '../../../../../base/common/uri.js';
 import { Range } from '../../../../../editor/common/core/range.js';
 import { IInstantiationService } from '../../../../../platform/instantiation/common/instantiation.js';
 import { ResourceLabels } from '../../../../browser/labels.js';
-import { IChatRequestVariableEntry, isElementVariableEntry, isImageVariableEntry, isNotebookOutputVariableEntry, isPasteVariableEntry, isPromptFileVariableEntry, isPromptTextVariableEntry, isSCMHistoryItemChangeRangeVariableEntry, isSCMHistoryItemChangeVariableEntry, isSCMHistoryItemVariableEntry, OmittedState } from '../../common/chatVariableEntries.js';
+import { IChatRequestVariableEntry, isElementVariableEntry, isImageVariableEntry, isNotebookOutputVariableEntry, isPasteVariableEntry, isPromptFileVariableEntry, isPromptTextVariableEntry, isSCMHistoryItemChangeRangeVariableEntry, isSCMHistoryItemChangeVariableEntry, isSCMHistoryItemVariableEntry, isTerminalVariableEntry, OmittedState } from '../../common/chatVariableEntries.js';
 import { ChatResponseReferencePartStatusKind, IChatContentReference } from '../../common/chatService.js';
-import { DefaultChatAttachmentWidget, ElementChatAttachmentWidget, FileAttachmentWidget, ImageAttachmentWidget, NotebookCellOutputChatAttachmentWidget, PasteAttachmentWidget, PromptFileAttachmentWidget, PromptTextAttachmentWidget, SCMHistoryItemAttachmentWidget, SCMHistoryItemChangeAttachmentWidget, SCMHistoryItemChangeRangeAttachmentWidget, ToolSetOrToolItemAttachmentWidget } from '../chatAttachmentWidgets.js';
+import { DefaultChatAttachmentWidget, ElementChatAttachmentWidget, FileAttachmentWidget, ImageAttachmentWidget, NotebookCellOutputChatAttachmentWidget, PasteAttachmentWidget, PromptFileAttachmentWidget, PromptTextAttachmentWidget, SCMHistoryItemAttachmentWidget, SCMHistoryItemChangeAttachmentWidget, SCMHistoryItemChangeRangeAttachmentWidget, TerminalCommandAttachmentWidget, ToolSetOrToolItemAttachmentWidget } from '../chatAttachmentWidgets.js';
 
 export interface IChatAttachmentsContentPartOptions {
 	readonly variables: IChatRequestVariableEntry[];
@@ -141,6 +141,8 @@ export class ChatAttachmentsContentPart extends Disposable {
 			widget = this.instantiationService.createInstance(PromptTextAttachmentWidget, attachment, undefined, { shouldFocusClearButton: false, supportsDeletion: false }, container, this._contextResourceLabels);
 		} else if (resource && (attachment.kind === 'file' || attachment.kind === 'directory')) {
 			widget = this.instantiationService.createInstance(FileAttachmentWidget, resource, range, attachment, correspondingContentReference, undefined, { shouldFocusClearButton: false, supportsDeletion: false }, container, this._contextResourceLabels);
+		} else if (isTerminalVariableEntry(attachment)) {
+			widget = this.instantiationService.createInstance(TerminalCommandAttachmentWidget, attachment, undefined, { shouldFocusClearButton: false, supportsDeletion: false }, container, this._contextResourceLabels);
 		} else if (isPasteVariableEntry(attachment)) {
 			widget = this.instantiationService.createInstance(PasteAttachmentWidget, attachment, undefined, { shouldFocusClearButton: false, supportsDeletion: false }, container, this._contextResourceLabels);
 		} else if (resource && isNotebookOutputVariableEntry(attachment)) {