Keybinding Suggestions and Contribution Opportunities

[glennsl]

This is the place to be if you want to suggest a keybinding, or find a nice and (usually) easy task to start contributing.

Suggestions

Name	Command/ Default	Assignee/ PR/Issue
✔️ Save	workbench.action.files.save Mod+S	@jakeday #1426
Focus Tab #	workbench.action.openEditorAtIndex[1-9] Mod+1 - Mod+9	@leavengood
✔️ Previous Tab	workbench.action.previousEditor Mod+PgUp / Cmd+Shift+[	@leavengood #778/#1447
✔️ Next Tab	workbench.action.nextEditor Mod+PgDn / Cmd+Shift+]	@leavengood #778/#1447
Copy	input.copy? Mod+C	@fanantoxa #1233
Cut	input.cut? Mod+X	@fanantoxa #1233
Paste	input.paste? Mod+V	@fanantoxa #1233
Go to next error	editor.action.marker.nextInFiles F8	#1349
Go to previous error	editor.action.marker.prevInFiles Shift + F8	#1349
Go to next search result	search.action.focusNextSearchResult F4
Go to previous search result	search.action.focusPreviousSearchResult Shift + F4
Open settings	workbench.action.openSettings Cmd+,
✔️ Zoom In	workbench.action.zoomIn Ctrl++	@ArtemDrozdov #1556/#1629
✔️ Zoom Out	workbench.action.zoomOut Ctrl+-	@ArtemDrozdov #1556/#1629
✔️ Zoom Reset	workbench.action.zoomReset Ctrl+0	@ArtemDrozdov #1556/#1629

Do you have other suggestions? Post a comment below! If the keybinding exists in vscode as well, it would be nice if you could post the name, command and default keybinding used there.

How to contribute

Keybindings are defined in KeyBindingsStoreConnector. Here's the keybinding for unfo, for example:

oni2/src/Store/KeyBindingsStoreConnector.re

Lines 162 to 166 in bb2df4c

	{
	key: "<D-Z>",
	command: "undo",
	condition: "editorTextFocus" |> WhenExpr.parse,
	},

When invoked this will generate a Command("undo") action, which needs to be handled in a Store somewhere. The undo comamnd is handled in VimStoreConnector here:

oni2/src/Store/VimStoreConnector.re

Line 855 in bb2df4c

| Command("undo") => (state, undoEffect)

Which invokes the effect defined a bit further up, here:

oni2/src/Store/VimStoreConnector.re

Lines 827 to 834 in bb2df4c

	let undoEffect =
	Isolinear.Effect.create(~name="vim.undo", () => {
	let _ = Vim.input("<esc>");
	let _ = Vim.input("<esc>");
	let cursors = Vim.input("u");
	updateActiveEditorCursors(cursors);
	();
	});

A lot of keybindings will be like this, just delegating to libvim to handle it. Some might require a bit more though, but a good place to start is to look into how this is done and vim, and whether it can be delegated in the same manner as this.

If you feel ready to tackle one of the suggestions above, post a comment below to lets us know, then dive in! If you have questions, the best place to ask is in the #dev channel on our Discord server.

[irevived1]

Hello,
would be nice if we have something like vim-tmux-navigator which allows user to seamlessly navigate through vim splits/terminals/file trees via ctrl+(h,j,k,l)

would also be nice to alias j and k to down and up for non-input fields too.

thanks for welcoming suggestions!

[fanantoxa]

@glennsl Select All already implemented with Selection PR

[escorponox]

I would like to be able to "kind of import" my mappings from init.vim regarding tabs and splits.

" windows
nnoremap ,z <C-W>\|
nnoremap ,h <C-W>h
nnoremap ,j <C-W>j
nnoremap ,k <C-W>k
nnoremap ,l <C-W>l
nnoremap ,= <C-W>=
nnoremap ,x <C-W>x
nnoremap ,c :close<CR>

" tabs
nnoremap ,tg :tabnew<CR>
nnoremap ,tt :tabn<CR>
nnoremap ,tr :tabc<CR>
nnoremap ,tp :tabp<CR>

[glennsl]

@irevived1 Yeah, that's definitely planned, although probably using Ctrl+W - h/j/k/l. It's a feature that require significantly more work than just adding some keybindings though, since at the moment we have no concept of where parts of the UI are relative to each other. I don't think there's an issue for it, but we have it noted down elsewhere and it's on the top of our minds since it's an essential part of the UX we're aiming for.

@fanantoxa Oh, lol, of course. I just use it all the time! Removed from the list.

@escorponox There's already experimental support for VimL, including remapping. See https://onivim.github.io/docs/configuration/settings#experimental

[jakeday]

@glennsl The save request is handled via #1426 and is good to go!

[glennsl]

Thanks @jakeday. Noted.

[leavengood]

The VSCode actions for focusing tabs by number is workbench.action.openEditorAtIndex[1-9]. And there are key bindings for Ctrl-[num] and Cmd-[num] (on macOS at least.)

I think I will look into adding this and the nextEditor/previousEditor commands.

I will probably will make a loop for defining the commands and key bindings for the numbered ones, and then map those to :b1-:b9. Also :bnext and :bprevious don't seem to be implemented yet, so it might make sense to implement those and just connect nextEditor/previousEditor to them. I don't yet know how to do that though.

[glennsl]

Thanks @leavengood. I've updated the OP and assigned you to those.

Also :bnext and :bprevious don't seem to be implemented yet

I think they are, but they're pretty broken? No idea what the problem might be though. Maybe @bryphe has some ideas.