VSCodeVim / VSCodeVim/Vim

Cannot map Function / F-keys with vim.insertModeKeyBindings

Open
#1,963 1 comment 37 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

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

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

Start by reading src/notation.ts at the linked location to see how key notation is parsed and whether Function/F-key names are represented. Trace the insertModeKeyBindings path for the reported before/after mapping, then verify that pressing F1 exits insert mode as expected.

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
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.