Suggestion of VSCodeVim mappings

[oyarsa]

The Vim page has the following:

This is a call for someone to share their VIM re-mappings.

I'm migrating from neovim, where I use vim-sexp, vim-sexp-for-humans and Conjure. Here are my mappings for VSCodeVim inspired by them:

settings.json:

"vim.visualModeKeyBindingsNonRecursive": [
    {
        "before": [
            ";",
            "e",
            "e"
        ],
        "commands": [
            "calva.evaluateSelection"
        ]
    },
    {
        "before": [
            ";",
            "e",
            "!"
        ],
        "commands": [
            "calva.evaluateSelectionReplace"
        ]
    },
    {
        "before": [
            ";",
            "e",
            "c",
            "e"
        ],
        "commands": [
            "calva.evaluateSelectionAsComment"
        ]
    },
],
"vim.normalModeKeyBindingsNonRecursive": [
    {
        "before": [
            ">",
            "("
        ],
        "commands": [
            "paredit.barfSexpBackward"
        ]
    },
    {
        "before": [
            "<",
            ")"
        ],
        "commands": [
            "paredit.barfSexpForward"
        ]
    },
    {
        "before": [
            "<",
            "("
        ],
        "commands": [
            "paredit.slurpSexpBackward"
        ]
    },
    {
        "before": [
            ">",
            ")"
        ],
        "commands": [
            "paredit.slurpSexpForward"
        ]
    },
    {
        "before": [
            ";",
            "i"
        ],
        "commands": [
            "paredit.wrapAroundParens"
        ]
    },
    {
        "before": [
            ";",
            "["
        ],
        "commands": [
            "paredit.wrapAroundSquare"
        ]
    },
    {
        "before": [
            ";",
            "{"
        ],
        "commands": [
            "paredit.wrapAroundCurly"
        ]
    },
    {
        "before": [
            ";",
            "'"
        ],
        "commands": [
            "paredit.wrapAroundQuote"
        ]
    },
    {
        "before": [
            ";",
            "@"
        ],
        "commands": [
            "paredit.spliceSexp"
        ]
    },
    {
        "before": [
            ";",
            "o"
        ],
        "commands": [
            "paredit.raiseSexp"
        ]
    },
    {
        "before": [
            ";",
            "e",
            "r"
        ],
        "commands": [
            "calva.evaluateCurrentTopLevelForm"
        ]
    },
    {
        "before": [
            ";",
            "e",
            "e"
        ],
        "commands": [
            "calva.evaluateSelection"
        ]
    },
    {
        "before": [
            ";",
            "e",
            "i"
        ],
        "commands": [
            "calva.interruptAllEvaluations"
        ]
    },
    {
        "before": [
            ";",
            "l",
            "v"
        ],
        "commands": [
            "calva.showOutputWindow"
        ]
    },
    {
        "before": [
            ";",
            "e",
            "c",
            "e"
        ],
        "commands": [
            "calva.evaluateSelectionAsComment"
        ]
    },
    {
        "before": [
            ";",
            "e",
            "c",
            "r"
        ],
        "commands": [
            "calva.evaluateTopLevelFormAsComment"
        ]
    },
    {
        "before": [
            ";",
            "e",
            "f"
        ],
        "commands": [
            "calva.loadFile"
        ]
    },
    {
        "before": [
            ";",
            "e",
            "b"
        ],
        "commands": [
            "calva.evaluateStartOfFileToCursor"
        ]
    },
    {
        "before": [
            ";",
            "s",
            "q"
        ],
        "commands": [
            "calva.disconnect"
        ]
    },
    {
        "before": [
            ";",
            "s",
            "f"
        ],
        "commands": [
            "calva.jackIn"
        ]
    },
    {
        "before": [
            ";",
            "e",
            "!"
        ],
        "commands": [
            "calva.evaluateSelectionReplace"
        ]
    },
],
"calva.paredit.defaultKeyMap": "strict",
"calva.paredit.hijackVSCodeDefaults": false,
"vim.normalModeKeyBindingsNonRecursive": [
    {
        "before": [
            ">",
            "("
        ],
        "commands": [
            "paredit.barfSexpBackward"
        ]
    },
    {
        "before": [
            "<",
            ")"
        ],
        "commands": [
            "paredit.barfSexpForward"
        ]
    },
    {
        "before": [
            "<",
            "("
        ],
        "commands": [
            "paredit.slurpSexpBackward"
        ]
    },
    {
        "before": [
            ">",
            ")"
        ],
        "commands": [
            "paredit.slurpSexpForward"
        ]
    },
    {
        "before": [
            ";",
            "i"
        ],
        "commands": [
            "paredit.wrapAroundParens"
        ]
    },
    {
        "before": [
            ";",
            "["
        ],
        "commands": [
            "paredit.wrapAroundSquare"
        ]
    },
    {
        "before": [
            ";",
            "{"
        ],
        "commands": [
            "paredit.wrapAroundCurly"
        ]
    },
    {
        "before": [
            ";",
            "'"
        ],
        "commands": [
            "paredit.wrapAroundQuote"
        ]
    },
    {
        "before": [
            ";",
            "@"
        ],
        "commands": [
            "paredit.spliceSexp"
        ]
    },
    {
        "before": [
            ";",
            "o"
        ],
        "commands": [
            "paredit.raiseSexp"
        ]
    },
    {
        "before": [
            ";",
            "e",
            "r"
        ],
        "commands": [
            "calva.evaluateCurrentTopLevelForm"
        ]
    },
    {
        "before": [
            ";",
            "e",
            "e"
        ],
        "commands": [
            "calva.evaluateSelection"
        ]
    },
    {
        "before": [
            ";",
            "e",
            "i"
        ],
        "commands": [
            "calva.interruptAllEvaluations"
        ]
    },
    {
        "before": [
            ";",
            "l",
            "v"
        ],
        "commands": [
            "calva.showOutputWindow"
        ]
    },
    {
        "before": [
            ";",
            "e",
            "c",
            "e"
        ],
        "commands": [
            "calva.evaluateSelectionAsComment"
        ]
    },
    {
        "before": [
            ";",
            "e",
            "c",
            "r"
        ],
        "commands": [
            "calva.evaluateTopLevelFormAsComment"
        ]
    },
    {
        "before": [
            ";",
            "e",
            "f"
        ],
        "commands": [
            "calva.loadFile"
        ]
    },
    {
        "before": [
            ";",
            "e",
            "b"
        ],
        "commands": [
            "calva.evaluateStartOfFileToCursor"
        ]
    },
    {
        "before": [
            ";",
            "s",
            "q"
        ],
        "commands": [
            "calva.disconnect"
        ]
    },
    {
        "before": [
            ";",
            "s",
            "f"
        ],
        "commands": [
            "calva.jackIn"
        ]
    },
    {
        "before": [
            ";",
            "e",
            "!"
        ],
        "commands": [
            "calva.evaluateSelectionReplace"
        ]
    },
],
"calva.paredit.defaultKeyMap": "strict",
"calva.paredit.hijackVSCodeDefaults": false,

keybindings.json

{
    "key": "escape",
    "command": "-calva.clearInlineResults"
},
{
    "key": "shift+escape",
    "command": "calva.clearInlineResults",
    "when": "editorTextFocus && !editorHasMultipleSelections && !editorReadOnly && !hasOtherSuggestions && !suggestWidgetVisible && editorLangId == 'clojure'"
},

They're not 1:1 because Calva only has one Wrap command per delimiter, whereas vim-sexp has wrap form and wrap element. Conjure has some commands to manipulate sessions that I couldn't find an equivalent for in Calva (e.g. how do you restart the REPL? All I can see is disconnecting and jacking in again), and the distinction between form, element and word.

I did my best to accommodate the basic use case, however. My favourites are the barf/slurp mappings from vim-sexp-mappings-for-regular-people.

[bpringe]

Thanks for sharing! @PEZ, do you think we should link to this on that doc page?

how do you restart the REPL? All I can see is disconnecting and jacking in again

There's no Calva command for restarting the REPL. Maybe that should be added? I don't know the details of how that should work. If the repl was started with jack-in, then I could see that being applicable, but not otherwise. Thoughts here, @PEZ?

[PEZ]

There's no Calva command for restarting the REPL. Maybe that should be added? I don't know the details of how that should work.

Jacking in again will first stop any running process, so it is essentially a restart. In fact the menu brought up from the REPL status bar icon has a restart option, that just points to the jack-in command.

[bpringe]

Thanks for reminding me! Somehow I forgot about that. 😅

[PEZ]

Thanks for sharing, @oyarsa!

vim-sexp has wrap form and wrap element

What is an element?

the distinction between form, element and word

Same question here. 😄 Can you give some examples?

[PEZ]

So it was actually form that I should have asked about. 😄

You can create those bindings for Calva using Joyride.

Or, depending on what the vim keybinding settings allow, you can chain. So for wrap around form you would chain, Up sexpr, Wrap, Undo cursor. Or something.

[PEZ]

I'm pretty sure we don't want to introduce those advanced concepts from vim-sexp in Calva.

[oyarsa]

I wasn't aware of Joyride. But I'll take a look!

Regarding chaining, that was actually what I was thinking of doing too. However, documenting this would still be helpful if someone came from Vim and wanted to understand the differences. If I implement these, I'll update the original post.

[PEZ]

You're right, we could document the differences in concepts somewhere. We have a Vim page on the docs site, but I don't know if that's the place, because it could also cause confusion if people are not coming from vim-sexp per se.

[bpringe]

We have a Vim page on the docs site, but I don't know if that's the place, because it could also cause confusion if people are not coming from vim-sexp per se.

I think a section on that page that clearly states that the content in that section is about vim-sexp would make sense.