-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Pull out and test TerminalProfileQuickpick (#136680)
- Loading branch information
1 parent
13bf498
commit 8b0720d
Showing
6 changed files
with
420 additions
and
241 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
240 changes: 240 additions & 0 deletions
240
src/vs/workbench/contrib/terminal/browser/terminalProfileQuickpick.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,240 @@ | ||
| /*--------------------------------------------------------------------------------------------- | ||
| * Copyright (c) Microsoft Corporation. All rights reserved. | ||
| * Licensed under the MIT License. See License.txt in the project root for license information. | ||
| *--------------------------------------------------------------------------------------------*/ | ||
|
|
||
| import { iconRegistry, Codicon } from 'vs/base/common/codicons'; | ||
| import { ConfigurationTarget, IConfigurationService } from 'vs/platform/configuration/common/configuration'; | ||
| import { IQuickInputService, IKeyMods, IPickOptions, IQuickPickSeparator, IQuickInputButton, IQuickPickItem } from 'vs/platform/quickinput/common/quickInput'; | ||
| import { IExtensionTerminalProfile, ITerminalProfile, ITerminalProfileObject, TerminalSettingPrefix } from 'vs/platform/terminal/common/terminal'; | ||
| import { getUriClasses, getColorClass, getColorStyleElement } from 'vs/workbench/contrib/terminal/browser/terminalIcon'; | ||
| import { configureTerminalProfileIcon } from 'vs/workbench/contrib/terminal/browser/terminalIcons'; | ||
| import * as nls from 'vs/nls'; | ||
| import { IThemeService, ThemeIcon } from 'vs/platform/theme/common/themeService'; | ||
| import { ITerminalProfileService } from 'vs/workbench/contrib/terminal/common/terminal'; | ||
| import { IQuickPickTerminalObject } from 'vs/workbench/contrib/terminal/browser/terminal'; | ||
|
|
||
|
|
||
| type DefaultProfileName = string; | ||
| export class TerminalProfileQuickpick { | ||
| constructor( | ||
| @ITerminalProfileService private readonly _terminalProfileService: ITerminalProfileService, | ||
| @IConfigurationService private readonly _configurationService: IConfigurationService, | ||
| @IQuickInputService private readonly _quickInputService: IQuickInputService, | ||
| @IThemeService private readonly _themeService: IThemeService | ||
| ) { } | ||
|
|
||
| async showAndGetResult(type: 'setDefault' | 'createInstance'): Promise<IQuickPickTerminalObject | DefaultProfileName | undefined> { | ||
| const platformKey = await this._terminalProfileService.getPlatformKey(); | ||
| const profilesKey = TerminalSettingPrefix.Profiles + platformKey; | ||
| const result = await this._createAndShow(type); | ||
| const defaultProfileKey = `${TerminalSettingPrefix.DefaultProfile}${platformKey}`; | ||
| if (!result) { | ||
| return; | ||
| } | ||
| if (type === 'setDefault') { | ||
| if ('command' in result.profile) { | ||
| return; // Should never happen | ||
| } else if ('id' in result.profile) { | ||
| // extension contributed profile | ||
| await this._configurationService.updateValue(defaultProfileKey, result.profile.title, ConfigurationTarget.USER); | ||
| return { | ||
| config: { | ||
| extensionIdentifier: result.profile.extensionIdentifier, | ||
| id: result.profile.id, | ||
| title: result.profile.title, | ||
| options: { | ||
| color: result.profile.color, | ||
| icon: result.profile.icon | ||
| } | ||
| }, | ||
| keyMods: result.keyMods | ||
| }; | ||
| } | ||
|
|
||
| // Add the profile to settings if necessary | ||
| if ('isAutoDetected' in result.profile) { | ||
| const profilesConfig = await this._configurationService.getValue(profilesKey); | ||
| if (typeof profilesConfig === 'object') { | ||
| const newProfile: ITerminalProfileObject = { | ||
| path: result.profile.path | ||
| }; | ||
| if (result.profile.args) { | ||
| newProfile.args = result.profile.args; | ||
| } | ||
| (profilesConfig as { [key: string]: ITerminalProfileObject })[result.profile.profileName] = newProfile; | ||
| } | ||
| await this._configurationService.updateValue(profilesKey, profilesConfig, ConfigurationTarget.USER); | ||
| } | ||
| // Set the default profile | ||
| await this._configurationService.updateValue(defaultProfileKey, result.profileName, ConfigurationTarget.USER); | ||
| } else if (type === 'createInstance') { | ||
| if ('id' in result.profile) { | ||
| return { | ||
| config: { | ||
| extensionIdentifier: result.profile.extensionIdentifier, | ||
| id: result.profile.id, | ||
| title: result.profile.title, | ||
| options: { | ||
| icon: result.profile.icon, | ||
| color: result.profile.color, | ||
| } | ||
| }, | ||
| keyMods: result.keyMods | ||
| }; | ||
| } else { | ||
| return { config: result.profile, keyMods: result.keyMods }; | ||
| } | ||
| } | ||
| // for tests | ||
| return 'profileName' in result.profile ? result.profile.profileName : result.profile.title; | ||
| } | ||
|
|
||
| private async _createAndShow(type: 'setDefault' | 'createInstance'): Promise<IProfileQuickPickItem | undefined> { | ||
| const platformKey = await this._terminalProfileService.getPlatformKey(); | ||
| const profiles = this._terminalProfileService.availableProfiles; | ||
| const profilesKey = TerminalSettingPrefix.Profiles + platformKey; | ||
| const defaultProfileName = this._terminalProfileService.getDefaultProfileName(); | ||
| let keyMods: IKeyMods | undefined; | ||
| const options: IPickOptions<IProfileQuickPickItem> = { | ||
| placeHolder: type === 'createInstance' ? nls.localize('terminal.integrated.selectProfileToCreate', "Select the terminal profile to create") : nls.localize('terminal.integrated.chooseDefaultProfile', "Select your default terminal profile"), | ||
| onDidTriggerItemButton: async (context) => { | ||
| if ('command' in context.item.profile) { | ||
| return; | ||
| } | ||
| if ('id' in context.item.profile) { | ||
| return; | ||
| } | ||
| const configProfiles: { [key: string]: any } = this._configurationService.getValue(TerminalSettingPrefix.Profiles + platformKey); | ||
| const existingProfiles = !!configProfiles ? Object.keys(configProfiles) : []; | ||
| const name = await this._quickInputService.input({ | ||
| prompt: nls.localize('enterTerminalProfileName', "Enter terminal profile name"), | ||
| value: context.item.profile.profileName, | ||
| validateInput: async input => { | ||
| if (existingProfiles.includes(input)) { | ||
| return nls.localize('terminalProfileAlreadyExists', "A terminal profile already exists with that name"); | ||
| } | ||
| return undefined; | ||
| } | ||
| }); | ||
| if (!name) { | ||
| return; | ||
| } | ||
| const newConfigValue: { [key: string]: ITerminalProfileObject } = { ...configProfiles } ?? {}; | ||
| newConfigValue[name] = { | ||
| path: context.item.profile.path, | ||
| args: context.item.profile.args | ||
| }; | ||
| await this._configurationService.updateValue(profilesKey, newConfigValue, ConfigurationTarget.USER); | ||
| }, | ||
| onKeyMods: mods => keyMods = mods | ||
| }; | ||
|
|
||
| // Build quick pick items | ||
| const quickPickItems: (IProfileQuickPickItem | IQuickPickSeparator)[] = []; | ||
| const configProfiles = profiles.filter(e => !e.isAutoDetected); | ||
| const autoDetectedProfiles = profiles.filter(e => e.isAutoDetected); | ||
|
|
||
| if (configProfiles.length > 0) { | ||
| quickPickItems.push({ type: 'separator', label: nls.localize('terminalProfiles', "profiles") }); | ||
| quickPickItems.push(...this._sortProfileQuickPickItems(configProfiles.map(e => this._createProfileQuickPickItem(e)), defaultProfileName!)); | ||
| } | ||
|
|
||
| quickPickItems.push({ type: 'separator', label: nls.localize('ICreateContributedTerminalProfileOptions', "contributed") }); | ||
| const contributedProfiles: IProfileQuickPickItem[] = []; | ||
| for (const contributed of this._terminalProfileService.contributedProfiles) { | ||
| if (typeof contributed.icon === 'string' && contributed.icon.startsWith('$(')) { | ||
| contributed.icon = contributed.icon.substring(2, contributed.icon.length - 1); | ||
| } | ||
| const icon = contributed.icon && typeof contributed.icon === 'string' ? (iconRegistry.get(contributed.icon) || Codicon.terminal) : Codicon.terminal; | ||
| const uriClasses = getUriClasses(contributed, this._themeService.getColorTheme().type, true); | ||
| const colorClass = getColorClass(contributed); | ||
| const iconClasses = []; | ||
| if (uriClasses) { | ||
| iconClasses.push(...uriClasses); | ||
| } | ||
| if (colorClass) { | ||
| iconClasses.push(colorClass); | ||
| } | ||
| contributedProfiles.push({ | ||
| label: `$(${icon.id}) ${contributed.title}`, | ||
| profile: { | ||
| extensionIdentifier: contributed.extensionIdentifier, | ||
| title: contributed.title, | ||
| icon: contributed.icon, | ||
| id: contributed.id, | ||
| color: contributed.color | ||
| }, | ||
| profileName: contributed.title, | ||
| iconClasses | ||
| }); | ||
| } | ||
|
|
||
| if (contributedProfiles.length > 0) { | ||
| quickPickItems.push(...this._sortProfileQuickPickItems(contributedProfiles, defaultProfileName!)); | ||
| } | ||
|
|
||
| if (autoDetectedProfiles.length > 0) { | ||
| quickPickItems.push({ type: 'separator', label: nls.localize('terminalProfiles.detected', "detected") }); | ||
| quickPickItems.push(...this._sortProfileQuickPickItems(autoDetectedProfiles.map(e => this._createProfileQuickPickItem(e)), defaultProfileName!)); | ||
| } | ||
| const styleElement = getColorStyleElement(this._themeService.getColorTheme()); | ||
| document.body.appendChild(styleElement); | ||
|
|
||
| const result = await this._quickInputService.pick(quickPickItems, options); | ||
| document.body.removeChild(styleElement); | ||
| if (!result) { | ||
| return undefined; | ||
| } | ||
| if (keyMods) { | ||
| result.keyMods = keyMods; | ||
| } | ||
| return result; | ||
| } | ||
|
|
||
| private _createProfileQuickPickItem(profile: ITerminalProfile): IProfileQuickPickItem { | ||
| const buttons: IQuickInputButton[] = [{ | ||
| iconClass: ThemeIcon.asClassName(configureTerminalProfileIcon), | ||
| tooltip: nls.localize('createQuickLaunchProfile', "Configure Terminal Profile") | ||
| }]; | ||
| const icon = (profile.icon && ThemeIcon.isThemeIcon(profile.icon)) ? profile.icon : Codicon.terminal; | ||
| const label = `$(${icon.id}) ${profile.profileName}`; | ||
| const colorClass = getColorClass(profile); | ||
| const iconClasses = []; | ||
| if (colorClass) { | ||
| iconClasses.push(colorClass); | ||
| } | ||
|
|
||
| if (profile.args) { | ||
| if (typeof profile.args === 'string') { | ||
| return { label, description: `${profile.path} ${profile.args}`, profile, profileName: profile.profileName, buttons, iconClasses }; | ||
| } | ||
| const argsString = profile.args.map(e => { | ||
| if (e.includes(' ')) { | ||
| return `"${e.replace('/"/g', '\\"')}"`; | ||
| } | ||
| return e; | ||
| }).join(' '); | ||
| return { label, description: `${profile.path} ${argsString}`, profile, profileName: profile.profileName, buttons, iconClasses }; | ||
| } | ||
| return { label, description: profile.path, profile, profileName: profile.profileName, buttons, iconClasses }; | ||
| } | ||
|
|
||
| private _sortProfileQuickPickItems(items: IProfileQuickPickItem[], defaultProfileName: string) { | ||
| return items.sort((a, b) => { | ||
| if (b.profileName === defaultProfileName) { | ||
| return 1; | ||
| } | ||
| if (a.profileName === defaultProfileName) { | ||
| return -1; | ||
| } | ||
| return a.profileName.localeCompare(b.profileName); | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| export interface IProfileQuickPickItem extends IQuickPickItem { | ||
| profile: ITerminalProfile | IExtensionTerminalProfile; | ||
| profileName: string; | ||
| keyMods?: IKeyMods | undefined; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.