Microsoft/vscode

Search Editor: Add keybinding for double-click action, e.g. to open to the side

Open

#194,044 opened on Sep 25, 2023

View on GitHub
 (6 comments) (3 reactions) (1 assignee)TypeScript (74,848 stars) (10,221 forks)batch import
feature-requesthelp wantedsearch

Description

In the Search Editor, there are currently keybindings / keyboard shortcuts for opening results in the current editor group, and double-clicking can be configured to open to the side, but there are currently no keybindings for opening to the side:

In the Search Editor, results can be navigated to using Go to Definition actions, such as F12 to open the source location in the current editor group, or ⌘K F12 to open the location in an editor to the side. Additionally, double-clicking can optionally open the source location, configurable with the search.searchEditor.doubleClickBehaviour setting.

  // Configure effect of double-clicking a result in a search editor.
  //  - selectWord: Double-clicking selects the word under the cursor.
  //  - goToLocation: Double-clicking opens the result in the active editor group.
  //  - openLocationToSide: Double-clicking opens the result in the editor group to the side, creating one if it does not yet exist.
  "search.searchEditor.doubleClickBehaviour": "goToLocation",

It'd be great to add a keybinding to do the same action as double-click, which users can already configure to openLocationToSide. (Looks like enter / cmd+enter are currently available.)

Contributor guide

Tech stack
typescriptnodejs
Domain
frontenddeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic TypeScriptFamiliarity with VS Code keybinding configurationUnderstanding of Search Editor functionality
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The feature requires adding a new keybinding command for opening a search result to the side. Look at existing search editor keybindings defined in the package.json file (e.g., in the 'keybindings' section). The command likely involves the searchEditorService or similar. Refer to the documentation linked in the issue (https://code.visualstudio.com/docs/editor/codebasics# search editor) for context. A possible implementation is to add a keybinding for the existing command 'search.action.openToSide' or create a new one. Check the keybindings in src/vs/workbench/contrib/searchEditor/package.json and the command registration in the searchEditor module. Also, review the setting 'search.searchEditor.doubleClickBehaviour' and how double click is currently handled.