microsoft/vscode
1
0
Fork 0
mirror of https://github.com/microsoft/vscode.git synced 2025-12-11 10:13:36 -06:00
Code Issues Packages Projects Releases 177 Wiki Activity

Add Basic Troubleshooting section

Alex Dima 2020-09-16 11:17:04 +02:00
parent 41cbf0ce92
commit 1d09d3bbeb
No known key found for this signature in database
GPG Key ID: 6E58D7B045760DA0
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Keybinding-Issues.md

@ -4,6 +4,7 @@
This page documents workarounds for known issues related to VS Code keybindings and explains how VS Code handles keybindings and why it does what it does for the curious.
## TOC
* [Basic Troubleshooting](#basic-troubleshooting)
* Quick troubleshoot
* [Troubleshoot keybindings on Linux](#troubleshoot-linux-keybindings)
* [Troubleshoot keybindings on Mac](#troubleshoot-mac-keybindings)
@ -16,6 +17,27 @@ This page documents workarounds for known issues related to VS Code keybindings
## Troubleshoot
### Basic Troubleshooting
* Run the command `Developer: Toggle Keyboard Shortcuts Troubleshooting`
* This will activate logging of dispatched keyboard shortcuts and will open an output panel with the corresponding log file.
* You can then press your desired keybinding and check what keyboard shortcut VS Code detects and what command is invoked.
For example, when pressing `cmd+/` in a code editor on macOS, the logging output would be:
```
[KeybindingService]: / Received keydown event - modifiers: [meta], code: MetaLeft, keyCode: 91, key: Meta
[KeybindingService]: | Converted keydown event - modifiers: [meta], code: MetaLeft, keyCode: 57 ('Meta')
[KeybindingService]: \ Keyboard event cannot be dispatched.
[KeybindingService]: / Received keydown event - modifiers: [meta], code: Slash, keyCode: 191, key: /
[KeybindingService]: | Converted keydown event - modifiers: [meta], code: Slash, keyCode: 85 ('/')
[KeybindingService]: | Resolving meta+[Slash]
[KeybindingService]: \ From 2 keybinding entries, matched editor.action.commentLine, when: editorTextFocus && !editorReadonly, source: built-in.
```
The first keydown event is for the `MetaLeft` key (`cmd`) and cannot be dispatched. The second keydown event is for the `Slash` key (`/`) and is dispatched as `meta+[Slash]`. There were two keybinding entries mapped from `meta+[Slash]` and the one that matched was for the command `editor.action.commentLine`, which has the `when` condition `editorTextFocus && !editorReadonly` and is a built-in keybinding entry.
### Troubleshoot Linux Keybindings
* Are you connecting to the Linux machine via some form of virtualization or remote desktop software?