Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add terminal tab hover action for env changes #177730

Merged
merged 2 commits into from
Mar 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import { Codicon } from 'vs/base/common/codicons';
import { IExtensionOwnedEnvironmentVariableMutator, IMergedEnvironmentVariableCollection, IMergedEnvironmentVariableCollectionDiff } from 'vs/platform/terminal/common/environmentVariable';
import { TerminalStatus } from 'vs/workbench/contrib/terminal/browser/terminalStatusList';
import Severity from 'vs/base/common/severity';
import { ICommandService } from 'vs/platform/commands/common/commands';

export class EnvironmentVariableInfoStale implements IEnvironmentVariableInfo {
readonly requiresAction = true;
Expand Down Expand Up @@ -59,7 +60,8 @@ export class EnvironmentVariableInfoChangesActive implements IEnvironmentVariabl
readonly requiresAction = false;

constructor(
private readonly _collection: IMergedEnvironmentVariableCollection
private readonly _collection: IMergedEnvironmentVariableCollection,
@ICommandService private readonly _commandService: ICommandService
) {
}

Expand All @@ -75,11 +77,20 @@ export class EnvironmentVariableInfoChangesActive implements IEnvironmentVariabl
return message;
}

private _getActions(): ITerminalStatusHoverAction[] {
return [{
label: localize('showEnvironmentContributions', "Show environment contributions"),
run: () => this._commandService.executeCommand(TerminalCommandId.ShowEnvironmentContributions),
commandId: TerminalCommandId.ShowEnvironmentContributions
}];
}

getStatus(): ITerminalStatus {
return {
id: TerminalStatus.EnvironmentVariableInfoChangesActive,
severity: Severity.Info,
tooltip: this._getInfo()
tooltip: this._getInfo(),
hoverActions: this._getActions()
};
}
}
Expand Down
2 changes: 2 additions & 0 deletions src/vs/workbench/contrib/terminal/browser/terminal.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import { URI } from 'vs/base/common/uri';
import { createDecorator } from 'vs/platform/instantiation/common/instantiation';
import { IKeyMods } from 'vs/platform/quickinput/common/quickInput';
import { IMarkProperties, ITerminalCapabilityStore, ITerminalCommand } from 'vs/platform/terminal/common/capabilities/capabilities';
import { IMergedEnvironmentVariableCollection } from 'vs/platform/terminal/common/environmentVariable';
import { IExtensionTerminalProfile, IReconnectionProperties, IShellIntegration, IShellLaunchConfig, ITerminalDimensions, ITerminalLaunchError, ITerminalProfile, ITerminalTabLayoutInfoById, TerminalExitReason, TerminalIcon, TerminalLocation, TerminalShellType, TerminalType, TitleEventSource, WaitOnExitValue } from 'vs/platform/terminal/common/terminal';
import { IColorTheme } from 'vs/platform/theme/common/themeService';
import { IWorkspaceFolder } from 'vs/platform/workspace/common/workspace';
Expand Down Expand Up @@ -457,6 +458,7 @@ export interface ITerminalInstance {
readonly capabilities: ITerminalCapabilityStore;
readonly usedShellIntegrationInjection: boolean;
readonly injectedArgs: string[] | undefined;
readonly extEnvironmentVariableCollection: IMergedEnvironmentVariableCollection | undefined;

readonly statusList: ITerminalStatusList;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ import { IAudioCueService, AudioCue } from 'vs/platform/audioCues/browser/audioC
import { ITerminalQuickFixOptions } from 'vs/platform/terminal/common/xterm/terminalQuickFix';
import { FileSystemProviderCapabilities, IFileService } from 'vs/platform/files/common/files';
import { preparePathForShell } from 'vs/workbench/contrib/terminal/common/terminalEnvironment';
import { IEnvironmentVariableCollection } from 'vs/platform/terminal/common/environmentVariable';
import { IEnvironmentVariableCollection, IMergedEnvironmentVariableCollection } from 'vs/platform/terminal/common/environmentVariable';
import { ISimpleSelectedSuggestion } from 'vs/workbench/services/suggest/browser/simpleSuggestWidget';
import { TERMINAL_BACKGROUND_COLOR } from 'vs/workbench/contrib/terminal/common/terminalColorRegistry';
import { editorBackground } from 'vs/platform/theme/common/colorRegistry';
Expand Down Expand Up @@ -221,6 +221,8 @@ export class TerminalInstance extends Disposable implements ITerminalInstance {
*/
get quickFix(): ITerminalQuickFixAddon | undefined { return this._quickFixAddon; }

get extEnvironmentVariableCollection(): IMergedEnvironmentVariableCollection | undefined { return this._processManager.extEnvironmentVariableCollection; }

xterm?: XtermTerminal;
disableLayout: boolean = false;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ export class TerminalProcessManager extends Disposable implements ITerminalProce
get hasWrittenData(): boolean { return this._hasWrittenData; }
get hasChildProcesses(): boolean { return this._hasChildProcesses; }
get reconnectionProperties(): IReconnectionProperties | undefined { return this._shellLaunchConfig?.attachPersistentProcess?.reconnectionProperties || this._shellLaunchConfig?.reconnectionProperties || undefined; }
get extEnvironmentVariableCollection(): IMergedEnvironmentVariableCollection | undefined { return this._extEnvironmentVariableCollection; }

constructor(
private readonly _instanceId: number,
Expand Down
3 changes: 3 additions & 0 deletions src/vs/workbench/contrib/terminal/common/terminal.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import { ThemeIcon } from 'vs/base/common/themables';
import { IProcessDetails } from 'vs/platform/terminal/common/terminalProcess';
import { ITerminalQuickFixProvider, ITerminalCommandSelector, ITerminalOutputMatch, ITerminalOutputMatcher } from 'vs/platform/terminal/common/xterm/terminalQuickFix';
import Severity from 'vs/base/common/severity';
import { IMergedEnvironmentVariableCollection } from 'vs/platform/terminal/common/environmentVariable';

export const TERMINAL_VIEW_ID = 'terminal';

Expand Down Expand Up @@ -395,6 +396,7 @@ export interface ITerminalProcessManager extends IDisposable {
readonly hasChildProcesses: boolean;
readonly backend: ITerminalBackend | undefined;
readonly capabilities: ITerminalCapabilityStore;
readonly extEnvironmentVariableCollection: IMergedEnvironmentVariableCollection | undefined;

readonly onPtyDisconnect: Event<void>;
readonly onPtyReconnect: Event<void>;
Expand Down Expand Up @@ -618,6 +620,7 @@ export const enum TerminalCommandId {
AcceptSelectedSuggestion = 'workbench.action.terminal.acceptSelectedSuggestion',
HideSuggestWidget = 'workbench.action.terminal.hideSuggestWidget',
FocusHover = 'workbench.action.terminal.focusHover',
ShowEnvironmentContributions = 'workbench.action.terminal.showEnvironmentContributions',
}

export const DEFAULT_COMMANDS_TO_SKIP_SHELL: string[] = [
Expand Down
1 change: 1 addition & 0 deletions src/vs/workbench/contrib/terminal/terminal.all.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,6 @@ import 'vs/workbench/contrib/terminal/browser/terminalView';
// primary workbench contribution)
import 'vs/workbench/contrib/terminalContrib/accessibility/browser/terminal.accessibility.contribution';
import 'vs/workbench/contrib/terminalContrib/developer/browser/terminal.developer.contribution';
import 'vs/workbench/contrib/terminalContrib/environmentChanges/browser/terminal.environmentChanges.contribution';
import 'vs/workbench/contrib/terminalContrib/find/browser/terminal.find.contribution';
import 'vs/workbench/contrib/terminalContrib/links/browser/terminal.links.contribution';
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/

import { Schemas } from 'vs/base/common/network';
import { localize } from 'vs/nls';
import { Action2, registerAction2 } from 'vs/platform/actions/common/actions';
import { ServicesAccessor } from 'vs/platform/instantiation/common/instantiation';
import { EnvironmentVariableMutatorType, IMergedEnvironmentVariableCollection } from 'vs/platform/terminal/common/environmentVariable';
import { ITerminalService } from 'vs/workbench/contrib/terminal/browser/terminal';
import { TerminalCommandId } from 'vs/workbench/contrib/terminal/common/terminal';
import { TerminalContextKeys } from 'vs/workbench/contrib/terminal/common/terminalContextKey';
import { terminalStrings } from 'vs/workbench/contrib/terminal/common/terminalStrings';
import { IEditorService } from 'vs/workbench/services/editor/common/editorService';
import { URI } from 'vs/base/common/uri';

const category = terminalStrings.actionCategory;

// TODO: The rest of the terminal environment changes feature should move here https://github.com/microsoft/vscode/issues/177241

registerAction2(class extends Action2 {
constructor() {
super({
id: TerminalCommandId.ShowEnvironmentContributions,
title: { value: localize('workbench.action.terminal.showEnvironmentContributions', "Show Environment Contributions"), original: 'Show Environment Contributions' },
category,
f1: true,
precondition: TerminalContextKeys.processSupported
});
}
async run(accessor: ServicesAccessor) {
const collection = accessor.get(ITerminalService).activeInstance?.extEnvironmentVariableCollection;
if (collection) {
const editorService = accessor.get(IEditorService);
await editorService.openEditor({
resource: URI.from({
scheme: Schemas.untitled
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does the readonly inMemory scheme make more sense in this use case?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It sounds like this is what I want, but I tried and get this. Am I doing something wrong?

image

I wanted to avoid creating a file service provider for a scheme

}),
contents: describeEnvironmentChanges(collection),
languageId: 'markdown'
});
}
}
});


function describeEnvironmentChanges(collection: IMergedEnvironmentVariableCollection): string {
let content = `# ${localize('envChanges', 'Terminal Environment Changes')}`;
for (const [ext, coll] of collection.collections) {
content += `\n\n## ${localize('extension', 'Extension: {0}', ext)}`;
content += '\n';
for (const [variable, mutator] of coll.map.entries()) {
content += `\n- \`${mutatorTypeLabel(mutator.type, mutator.value, variable)}\``;
}
}
return content;
}

function mutatorTypeLabel(type: EnvironmentVariableMutatorType, value: string, variable: string): string {
switch (type) {
case EnvironmentVariableMutatorType.Prepend: return `${variable}=${value}\${env:${variable}}`;
case EnvironmentVariableMutatorType.Append: return `${variable}=\${env:${variable}}${value}`;
default: return `${variable}=${value}`;
}
}