Help view isn't updated with customized keybindings

First of all, I just want to saying thank you making this extension. I love it. I tried it with VSCode Vim, I thought it doesn’t work even after I apply the keybinding.json. I kept pressing the key in the static help text.

First, it would be clearer in the readme to mention what keys are remapped to.

Second, the help text is very hard to read with all the “-ing” in the dwim commands, and I don’t see those “-ings” in the magit. I assuming the wording is because those actions are in a popup?

Third, it would be nice to have syntax highlighting in the help text.

Forth, since the key bindings are configurable, people are going to change it so the help text will be incorrect. I am proposing to have the help text be configurable in extension’s settings, so that user can change they key binding and also change the help text. Ideally, I wish the help text is generated from the key bindings; however, I don’t believe there is such API for extension to fetch key bindings. Since we are not going to capture all the keys like VSCode Vim, I think this is a middle ground solution while providing customization.

Fifth, the vim search function with / is not working.

I can help with working on any of those. I want to see what’s your take on the issue(s) before I work on it. Again, thank you for creating this extension 😃

Here is a screenshot of spacemacs’ help text as a reference Here is my additional keybindings that match spacemacs’

  {
    "key": "tab",
    "command": "extension.vim_tab",
    "when": "editorFocus && vim.active && !inDebugRepl && vim.mode != 'Insert' && !editorLangId == 'magit'"
  },
  {
    "key": "tab",
    "command": "-extension.vim_tab",
    "when": "editorFocus && vim.active && !inDebugRepl && vim.mode != 'Insert'"
  },
  {
    "key": "x",
    "command": "magit.discard-at-point",
    "when": "editorTextFocus && editorLangId == 'magit'"
  },
  {
    "key": "k",
    "command": "-magit.discard-at-point",
    "when": "editorTextFocus && editorLangId == 'magit'"
  },
  {
    "key": "-",
    "command": "magit.reverse-at-point",
    "when": "editorTextFocus && editorLangId == 'magit'"
  },
  {
    "key": "v",
    "command": "-magit.reverse-at-point",
    "when": "editorTextFocus && editorLangId == 'magit'"
  },
  {
    "key": "shift+-",
    "command": "magit.reverting",
    "when": "editorTextFocus && editorLangId == 'magit'"
  },
  {
    "key": "shift+v",
    "command": "-magit.reverting",
    "when": "editorTextFocus && editorLangId == 'magit'"
  },
  {
    "key": "shift+o",
    "command": "magit.resetting",
    "when": "editorTextFocus && editorLangId == 'magit'"
  },
  {
    "key": "shift+x",
    "command": "-magit.resetting",
    "when": "editorTextFocus && editorLangId == 'magit'"
  },
  {
    "key": "x",
    "command": "-magit.reset-mixed",
    "when": "editorTextFocus && editorLangId == 'magit'"
  },
  {
    "key": "ctrl+u x",
    "command": "-magit.reset-hard",
    "when": "editorTextFocus && editorLangId == 'magit'"
  }

[stevenguh]

Oh the idea you said where another extension would only contains the key bindings “correction” for vim is interesting. That might offer a better open the box experience. The current pollution in keybinding.json is not too bad. I think once we have the help text config, it would be nice to consider a evil-edamagit which can be an extension bundle and contains the corrected key bindings and help text config. And I agree that the two duplicated extensions might not be the way to go, and a general solution in this repo is preferred.

As in right now, I tried the key bindings you on the README.txt. It works pretty good 😃 Thanks again for the quick turn around. This extension is amazing, loving it.

[kahole]

I thought about something similar (edamagit.evil flag). I also feel like it might be too complex / difficult to explain.