VSCodeVim / VSCodeVim/Vim

Problem view doesn't close on Escape

Open
#8,866 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
15.2k
Forks
1.5k
Avg merge
3d 18h
Merged PRs (30d)
6

Description

Describe the bug
When the inline diagnostics / problem view is visible, the Esc key should be passed through to VSCode and close the popup (#3416). It doesn't do this by default, but when I create the exact same keybind manually, it does.

To Reproduce
Steps to reproduce the behavior:

  1. Have an error / warning in your code.
  2. Press F8 to jump to it. A preview opens describing the error.
  3. Press Esc. The problem view does not disappear.
  4. Add this to keybindings.json:
{
    "key": "escape",
    "command": "closeMarkersNavigation",
    "when": "editorFocus && markersNavigationVisible"
},
  1. Repeat steps 2 and 3. The problem view now disappears.

Expected behavior
The window should close on Esc without having the redefine the keybind.

Screenshots
Custom keybind that fixes the issue is identical to default one:
keybinds

Log output
Before custom keybind:

2024-02-02 01:47:28.721 [debug] Selection change: [47, 8], [47, 8], SelectionsLength: 1
2024-02-02 01:47:28.721 [debug] Selections: Changing Cursors from selection handler... [47, 8], [47, 8]
2024-02-02 01:47:33.418 [debug] Handling key: <Esc>

After custom keybind:

2024-02-02 01:47:38.444 [debug] Selection change: [47, 8], [47, 8], SelectionsLength: 1
2024-02-02 01:47:38.444 [debug] Selections: Changing Cursors from selection handler... [47, 8], [47, 8]

Environment (please complete the following information):

  • Extension (VsCodeVim) version: 1.27.2
  • VSCode version: 1.86
  • OS: Ubuntu 22.04.3 LTS

Additional context
Related open issues: #2258, #3716.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the F8 diagnostics preview and press Escape, then compare the default behavior with the keybindings.json entry for closeMarkersNavigation using editorFocus && markersNavigationVisible. Trace the extension's Escape handling and verify that the problem view closes without a custom keybinding, including the related behavior from issues #2258 and #3716.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript, vscode
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.