Report shell integration status in hover

microsoft · Jan 7, 2022 · 2a751e5 · 2a751e5
1 parent cc5f6e9
commit 2a751e5
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 5 deletions.
diff --git a/src/vs/workbench/contrib/terminal/browser/terminal.ts b/src/vs/workbench/contrib/terminal/browser/terminal.ts
@@ -9,7 +9,7 @@ import { URI } from 'vs/base/common/uri';
 import { FindReplaceState } from 'vs/editor/contrib/find/findState';
 import { createDecorator } from 'vs/platform/instantiation/common/instantiation';
 import { IShellLaunchConfig, ITerminalDimensions, ITerminalLaunchError, ITerminalProfile, ITerminalTabLayoutInfoById, TerminalIcon, TitleEventSource, TerminalShellType, IExtensionTerminalProfile, TerminalLocation, ProcessPropertyType, ProcessCapability, IProcessPropertyMap } from 'vs/platform/terminal/common/terminal';
-import { ICommandTracker, INavigationMode, IRemoteTerminalAttachTarget, IStartExtensionTerminalRequest, ITerminalConfigHelper, ITerminalFont, ITerminalBackend, ITerminalProcessExtHostProxy, IRegisterContributedProfileArgs } from 'vs/workbench/contrib/terminal/common/terminal';
+import { ICommandTracker, INavigationMode, IRemoteTerminalAttachTarget, IStartExtensionTerminalRequest, ITerminalConfigHelper, ITerminalFont, ITerminalBackend, ITerminalProcessExtHostProxy, IRegisterContributedProfileArgs, IShellIntegration } from 'vs/workbench/contrib/terminal/common/terminal';
 import { ITerminalStatusList } from 'vs/workbench/contrib/terminal/browser/terminalStatusList';
 import { Orientation } from 'vs/base/browser/ui/splitview/splitview';
 import { IEditableData } from 'vs/workbench/common/views';
@@ -808,6 +808,11 @@ export interface IXtermTerminal {
 	 */
 	readonly commandTracker: ICommandTracker;
 
+	/**
+	 * Reports the status of shell integration and fires events relating to it.
+	 */
+	readonly shellIntegration: IShellIntegration;
+
 	/**
 	 * The position of the terminal.
 	 */

diff --git a/src/vs/workbench/contrib/terminal/browser/terminalTabsList.ts b/src/vs/workbench/contrib/terminal/browser/terminalTabsList.ts
@@ -17,7 +17,7 @@ import { ActionBar } from 'vs/base/browser/ui/actionbar/actionbar';
 import { MenuItemAction } from 'vs/platform/actions/common/actions';
 import { MenuEntryActionViewItem } from 'vs/platform/actions/browser/menuEntryActionViewItem';
 import { ITerminalBackend, TerminalCommandId } from 'vs/workbench/contrib/terminal/common/terminal';
-import { TerminalLocation, TerminalSettingId } from 'vs/platform/terminal/common/terminal';
+import { ProcessCapability, TerminalLocation, TerminalSettingId } from 'vs/platform/terminal/common/terminal';
 import { Codicon } from 'vs/base/common/codicons';
 import { Action } from 'vs/base/common/actions';
 import { MarkdownString } from 'vs/base/common/htmlContent';
@@ -304,6 +304,16 @@ class TerminalTabsRenderer implements IListRenderer<ITerminalInstance, ITerminal
 				template.context.hoverActions.push(...status.hoverActions);
 			}
 		}
+
+		let shellIntegrationString = '';
+		const capabilities = instance.xterm?.shellIntegration.capabilities;
+		if (capabilities?.length) {
+			shellIntegrationString += `\n\n---\n\n$(plug) ${localize('shellIntegration.enabled', "Shell integration is enabled")}`;
+			for (const capability of capabilities) {
+				shellIntegrationString += `\n- ${this._getCapabilityName(capability)}`;
+			}
+		}
+
 		const iconId = getIconId(instance);
 		const hasActionbar = !this.shouldHideActionBar();
 		let label: string = '';
@@ -361,7 +371,7 @@ class TerminalTabsRenderer implements IListRenderer<ITerminalInstance, ITerminal
 				badges: hasText
 			},
 			title: {
-				markdown: new MarkdownString(instance.title + statusString, { supportThemeIcons: true }),
+				markdown: new MarkdownString(instance.title + shellIntegrationString + statusString, { supportThemeIcons: true }),
 				markdownNotSupportedFallback: undefined
 			},
 			extraClasses
@@ -493,6 +503,13 @@ class TerminalTabsRenderer implements IListRenderer<ITerminalInstance, ITerminal
 		this._terminalGroupService.focusTabs();
 		this._listService.lastFocusedList?.focusNext();
 	}
+
+	private _getCapabilityName(capability: ProcessCapability): string {
+		switch (capability) {
+			case ProcessCapability.CommandCognisant: return localize('capability.commandDetection', "Command detection");
+			case ProcessCapability.CwdDetection: return localize('capability.cwdDetection', "Current working directory detection");
+		}
+	}
 }
 
 interface ITerminalTabEntryTemplate {

diff --git a/src/vs/workbench/contrib/terminal/browser/xterm/shellIntegrationAddon.ts b/src/vs/workbench/contrib/terminal/browser/xterm/shellIntegrationAddon.ts
@@ -72,6 +72,7 @@ export const enum ShellIntegrationInteraction {
 
 export class ShellIntegrationAddon extends Disposable implements IShellIntegration, ITerminalAddon {
 	private _terminal?: Terminal;
+	readonly capabilities: ProcessCapability[] = [];
 
 	// TODO: Rename ProcessCapability to TerminalCapability, move naive CwdDetection to renderer
 	private readonly _onCapabilityDisabled = new Emitter<ProcessCapability>();
@@ -107,6 +108,7 @@ export class ShellIntegrationAddon extends Disposable implements IShellIntegrati
 				type = ShellIntegrationInteraction.CommandFinished;
 				break;
 			case ShellIntegrationOscPt.EnableShellIntegration:
+				this.capabilities.push(ProcessCapability.CommandCognisant);
 				this._onCapabilityEnabled.fire(ProcessCapability.CommandCognisant);
 				return true;
 			default:

diff --git a/src/vs/workbench/contrib/terminal/browser/xterm/xtermTerminal.ts b/src/vs/workbench/contrib/terminal/browser/xterm/xtermTerminal.ts
@@ -13,7 +13,7 @@ import { TerminalConfigHelper } from 'vs/workbench/contrib/terminal/browser/term
 import { DisposableStore } from 'vs/base/common/lifecycle';
 import { IEditorOptions } from 'vs/editor/common/config/editorOptions';
 import { ProcessCapability, TerminalLocation, TerminalSettingId } from 'vs/platform/terminal/common/terminal';
-import { ICommandTracker, ITerminalFont, TERMINAL_VIEW_ID } from 'vs/workbench/contrib/terminal/common/terminal';
+import { ICommandTracker, IShellIntegration, ITerminalFont, TERMINAL_VIEW_ID } from 'vs/workbench/contrib/terminal/common/terminal';
 import { isSafari } from 'vs/base/browser/browser';
 import { IXtermTerminal } from 'vs/workbench/contrib/terminal/browser/terminal';
 import { ILogService } from 'vs/platform/log/common/log';
@@ -55,14 +55,15 @@ export class XtermTerminal extends DisposableStore implements IXtermTerminal {
 
 	// Always on addons
 	private _commandTrackerAddon: CommandTrackerAddon;
+	private _shellIntegrationAddon: ShellIntegrationAddon;
 
 	// Optional addons
 	private _searchAddon?: SearchAddonType;
-	private _shellIntegrationAddon?: ShellIntegrationAddon;
 	private _unicode11Addon?: Unicode11AddonType;
 	private _webglAddon?: WebglAddonType;
 
 	get commandTracker(): ICommandTracker { return this._commandTrackerAddon; }
+	get shellIntegration(): IShellIntegration { return this._shellIntegrationAddon; }
 
 	private _target: TerminalLocation | undefined;
 	set target(location: TerminalLocation | undefined) {

diff --git a/src/vs/workbench/contrib/terminal/common/terminal.ts b/src/vs/workbench/contrib/terminal/common/terminal.ts
@@ -332,6 +332,7 @@ export interface ICommandTracker {
 }
 
 export interface IShellIntegration {
+	readonly capabilities: readonly ProcessCapability[];
 	readonly onCapabilityEnabled: Event<ProcessCapability>;
 	readonly onCapabilityDisabled: Event<ProcessCapability>;
 	// TODO: Fire more fine-grained and stronger typed events