VSCodeVim/Vim

Cannot map Function / F-keys with vim.insertModeKeyBindings

Open

#1963 opened on Aug 10, 2017

View on GitHub
 (1 comment) (37 reactions) (0 assignees)TypeScript (12,664 stars) (1,271 forks)batch import
area/remaphelp wanted

Description

  • Click thumbs-up 👍 on this issue if you want it!
  • Click confused 😕 on this issue if not having it makes VSCodeVim unusable.

The VSCodeVim team prioritizes issues based on reaction count.

Is this a BUG REPORT or FEATURE REQUEST? (choose one): BUG REPORT

Environment:

  • VSCode Version: 1.14.2
  • VsCodeVim Version: 0.9.0
  • OS: macOS 10.12.6

What happened:

  1. Set up this keybinding:
    "vim.insertModeKeyBindings": [
        {
            "before": ["<F1>"],
            "after": ["<Esc>"]
        }
    ]
  1. Enter insert mode on a file
  2. Press F1
  3. You remain in insert mode

What did you expect to happen: Exit insert mode back to normal mode.

How to reproduce it: See above. This is supposed to be the equivalent of:

map!   <F1>   <Esc>

I don't see function keys handled here, so I'm not sure if it's currently possible to map them: https://github.com/VSCodeVim/Vim/blob/eae183596104d820ca2f87a1934d7a03097dd32c/src/notation.ts#L6

Contributor guide

Tech stack
typescript
Domain
developer experience
Issue type
bug
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate the notation.ts file at src/notation.ts to understand how key notations are parsed. The issue indicates that function keys like <F1> are not handled in the notation map. The fix would involve adding entries for function keys F1 F12 to map them to their respective VSCode key sequences. Also check how VSCode emits function key events and ensure the mapping is correct. Review any existing documentation or test files related to keybindings.