Skip to content

Show command descriptions as tooltips in Command Palette #284609

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.

Sign up for GitHub

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

Open
Riya-chandra wants to merge 8 commits into
base: main
Choose a base branch
from
+13 −1
Open

Show command descriptions as tooltips in Command Palette #284609

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
eaf4e38
Show command descriptions as tooltips in Command Palette
Riya-chandra Dec 21, 2025
5460ede
Merge branch 'main' into main
Riya-chandra Dec 21, 2025
08dc81a
Merge branch 'main' into main
Riya-chandra Dec 21, 2025
6558511
Merge branch 'main' into main
Riya-chandra Dec 22, 2025
8e8e866
Merge branch 'main' into main
Riya-chandra Dec 22, 2025
094452d
Scope command description tooltips to Command Palette only
Riya-chandra Dec 27, 2025
6e160fc
Merge branch 'main' of https://github.com/Riya-chandra/vscode
Riya-chandra Dec 27, 2025
cf1cd0e
Merge branch 'main' into main
Riya-chandra Dec 27, 2025
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
14 changes: 13 additions & 1 deletion src/vs/platform/quickinput/browser/commandsQuickAccess.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ import { IQuickAccessProviderRunOptions } from '../common/quickAccess.js';
import { IKeyMods, IQuickPickSeparator } from '../common/quickInput.js';
import { IStorageService, StorageScope, StorageTarget, WillSaveStateReason } from '../../storage/common/storage.js';
import { ITelemetryService } from '../../telemetry/common/telemetry.js';
import { CommandsRegistry } from '../../commands/common/commands.js';
import { Categories } from '../../action/common/actionCommonCategories.js';

export interface ICommandQuickPick extends IPickerQuickAccessItem {
Expand Down Expand Up @@ -274,7 +275,18 @@ export abstract class AbstractCommandsQuickAccessProvider extends PickerQuickAcc
if (commandPick.type === 'separator') {
return commandPick;
}

if (!commandPick.tooltip) {
const command = CommandsRegistry.getCommand(commandPick.commandId);
if (command?.metadata?.description) {
commandPick = {
...commandPick,
tooltip:
typeof command.metadata.description === 'string'
? command.metadata.description
: command.metadata.description.value
};
}
}
Comment on lines +278 to +289
Copy link
Member

@TylerLeonhardt TylerLeonhardt Dec 28, 2025

Choose a reason for hiding this comment

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

the commandPick has the commandDescription already.

const keybinding = this.keybindingService.lookupKeybinding(commandPick.commandId);
const ariaLabel = keybinding ?
localize('commandPickAriaLabelWithKeybinding', "{0}, {1}", commandPick.label, keybinding.getAriaLabel()) :
Expand Down