Refactor bindings and README #513

theol0403 · 2021-01-05T07:34:51Z

This is my work in progress for refactoring keybindings and readme. I hope you agree with the changes, and I will explain some of the keybindings at a later time. For now, I just want to show my progress, and see if you have any suggestions or feedback.

Would it be better to split this into two PRs? I put them in one because the readme needs to be changed to reflect the keybindings anyways.

Todo:

asvetliakov · 2021-01-06T01:49:59Z

Would it be better to split this into two PRs?

Whatever will be easier for you.

For keybindings, also can suggest these ones:

  {
    "key": "ctrl+p",
    "command": "list.focusUp",
    "when": "inReferenceSearchEditor"
  },
  {
    "key": "ctrl+n",
    "command": "list.focusDown",
    "when": "inReferenceSearchEditor"
  }

These are for selecting prev/next reference in peek view

Shatur · 2021-01-06T10:15:55Z

=z in Vim shows spell suggestions. How about use it to open quick fix suggestions menu? Spell extensions in VSCode also use quick fix menu for spell suggestions.

nnoremap z= <Cmd>call VSCodeNotify('editor.action.quickFix')<CR>

I use the following command for multiply cursors instead of m:

nnoremap <C-Down> i<Cmd>call VSCodeNotify('editor.action.insertCursorBelow')<CR>
nnoremap <C-Up> i<Cmd>call VSCodeNotify('editor.action.insertCursorAbove')<CR>

This requires much less keystrokes. What do you think?

Shatur · 2021-01-06T15:12:19Z

Also how about gx to open current link? This shortcut is provided by built-in netrw plugin (:h netrw-gx)?

nnoremap gx <Cmd>call VSCodeNotify('editor.action.openLink')<CR>

David-Else · 2021-01-06T16:30:32Z

@Shatur95 Regarding =z to open quickfix, it means that an integrated spellchecker could not use the correct shortcut #506

gx already opens the current link, I just double-checked in a markdown file. I am using the Linux appimage on Centos 8.3.

Shatur · 2021-01-06T19:26:49Z

@Shatur95 Regarding =z to open quickfix, it means that an integrated spellchecker could not use the correct shortcut #506

Is built-in spellchecking suggestions works?

gx already opens the current link, I just double-checked in a markdown file. I am using the Linux appimage on Centos 8.3.

Did not know that netrw handles it well :) I just have netrw disabled, so I binded this shortcut manually.

David-Else · 2021-01-06T19:32:50Z

Is built-in spellchecking suggestions works?

Not really, but check out the thread... I think it could be possible in the future.

Shatur · 2021-01-06T19:41:03Z

Not really, but check out the thread... I think it could be possible in the future.

Yes, checked, thanks. I think it's okay to trigger quickfix via z= since future built-in spellchecking can be displayed in quickfix in future.

theol0403 · 2021-01-16T08:14:31Z

Sorry for the silence... been (and will keep being in the near future) busy.

Shatur · 2021-01-16T08:40:52Z

@theol0403, I think it worth to merge it as is. No one like big PR's.

theol0403 · 2021-04-02T04:53:04Z

=z in Vim shows spell suggestions. How about use it to open quick fix suggestions menu? Spell extensions in VSCode also use quick fix menu for spell suggestions.

While I do like the idea (and we can remove it if vim spellcheck gets fixed - though I think vscode spellcheck is fine), it's not very useful because you can't navigate the quickfix items with the keyboard. I think I will instead provide instructions to use the keyboard quickfix plugin, until #469 gets addressed.

Sorry for the long delay everyone, hopefully I can get this into a mergeable state sometime soon.

Shatur · 2021-04-02T07:00:04Z

While I do like the idea (and we can remove it if vim spellcheck gets fixed - though I think vscode spellcheck is fine), it's not very useful because you can't navigate the quickfix items with the keyboard. I think I will instead provide instructions to use the keyboard quickfix plugin, until #469 gets addressed.

Sorry, I didn't mean quickfix like I did when refactoring. In this context, I mean the context menu that poups for spell suggestions. You can navigate it with keyboard arrows.

theol0403 · 2021-04-02T07:09:45Z

Sorry, I didn't mean quickfix like I did when refactoring. In this context, I mean the context menu that poups for spell suggestions. You can navigate it with keyboard arrows.

Sure, even though keyboard arrows are of limited use, I don't see a reason not to add it 👍

theol0403 · 2021-04-02T08:00:53Z

Calling it for tonight, but end is in sight 👍

I took a lot of liberty in this PR by changing whatever I saw fit, please feel free to veto anything you aren't comfortable with.

Todo in OP has been updated.

Do not capture the Escape key when parameter hints or the problem popup is open.

trkoch

Maybe you could split this PR and get the non-controversial parts merged?

trkoch · 2021-04-15T19:59:46Z

package.json

-    "displayName": "Neo Vim",
-    "description": "Real VIM in your Visual Studio Code",
+    "displayName": "VSCode Neovim",
+    "description": "Real VSCode Neovim Integration",


I liked the previous description better.

I'm open to discussion, but I guess I was trying to make the "branding" more consistent. "VSCode Neovim - VSCode Neovim Integration". I changed it in my last few commits, let me know if you still prefer the old version.

trkoch · 2021-04-15T20:03:45Z

package.json

+                "command": "vscode-neovim.send",
+                "key": "home",
+                "when": "editorTextFocus && neovim.init && neovim.mode != insert || neovim.recording",
+                "args": "<Home>"


Would this break native scroll navigation when pressing Home/End?

Not sure what you mean. In vscode, home/end moves to the beginning and end of the line - this is what neovim also does.

trkoch · 2021-04-15T20:04:30Z

vim/vscode-code-actions.vim

@@ -93,5 +93,9 @@ xnoremap <C-w>gd <Cmd>call VSCodeNotify('editor.action.revealDefinitionAside')<C
 xnoremap <expr> <C-/> <SID>vscodeCommentary()
 nnoremap <expr> <C-/> <SID>vscodeCommentary() . '_'

+" open quickfix menu for spelling corrections and refactoring
+" only keyboard arrows can be used to navigate, for a solution, see https://github.com/asvetliakov/vscode-neovim#keyboard-quickfix
+nnoremap z= <Cmd>call VSCodeNotify('editor.action.quickFix')<CR>


Not sure this is something of universal use. Users can remap this easily in their local installation.

While I do agree, I think that it does not hurt to have some default functionality for a common keybinding, rather than it not working at all.

trkoch · 2021-04-15T20:05:06Z

package.json

@@ -393,6 +393,106 @@
                "key": "ctrl+p",
                "when": "listFocus && !inputFocus"
            },
+            {
+                "key": "j",


So this is for navigating lists with j/k?

Yes, it is. Taken from VSCodeVim.

theol0403 · 2021-06-01T07:36:38Z

Maybe you could split this PR and get the non-controversial parts merged?

I feel bad for taking forever to complete this PR, but I think everything should be done at once - the keybindings are coupled with the readme, and I don't want to work on the readme in two passes (write docs for the new bindings in the old format, and then convert to the new format). And then, since the whole readme is being refactored, it would also be a good time to change the branding and whatever.

I will be ready to submit this PR for review after I complete the new peek mode bindings and adding a table of contents. Probably I can get that done in the next couple days.

After this is merged, I'll also look into moving a lot of the information into the wiki, and possibly adding more stuff in terms of opinionated mappings - the readme is already getting very big.

theol0403 · 2021-06-02T06:42:48Z

I have merged #604 into my PR, I hope they still get recognition for it. I did it because I needed to modify it to also close the peek editor.

asvetliakov · 2021-06-02T07:04:07Z

I'm eager to merge it once it done. Awesome!

theol0403 · 2021-06-02T07:16:34Z

Well, I think everything I plan to do is complete 🎉!

However, give me a day or two to just go over it and make sure everything is perfect. I think the only thing I might change is the order of some bindings in the readme, and possibly squash some meaningless commits.

If you want to start the review, however, feel free!

theol0403 · 2021-06-03T05:54:43Z

I have made some more improvements, and rebased/squashed some of my commits to make it easier to read and know what changed.

I think this is ready to be merged! 🎉

Of course, please make sure you agree with all the decisions I made before merging 👍

theol0403 · 2021-06-03T06:05:27Z

Sorry for all the force pushes, I just keep finding little things I want to change that don't deserve a new commit 😅.

Do you want me to press the merge button, or do you want to do it?

asvetliakov · 2021-06-03T06:06:13Z

Go (merge it!) 🚗 😄

theol0403 · 2021-06-03T06:11:19Z

Last question, do you want to squash, or keep commits as-is? The latter might be better, to better isolate the individual changes, but there is also a bit of commit mess.

asvetliakov · 2021-06-03T06:16:06Z

it's not very important. squashing helps when you're doing some kind of deploy-per-commit, but it's not relevant to this repo. so whatever you feel right. I'd squash it

theol0403 · 2021-06-03T06:20:33Z

Finally!! Hopefully people will like the new changes 😄

Thanks again for your awesome work on this plugin ❤️! I hope to see it grow in the future.

Just a small thing, can you capitalize the i in "VSCode Neovim integration" in the github description to stay consistent?

asvetliakov · 2021-06-03T06:22:44Z

awesome work! thank you

Just a small thing, can you capitalize the i in "VSCode Neovim integration" in the github description to stay consistent?

done

theol0403 force-pushed the refactor-bindings branch from 59002f0 to d0facd1 Compare January 5, 2021 07:42

theol0403 force-pushed the refactor-bindings branch from d0facd1 to ae22b5c Compare January 16, 2021 08:14

theol0403 force-pushed the refactor-bindings branch from ae22b5c to ee4dcc3 Compare April 2, 2021 04:27

Enable closing parameter hints and problem popup with Escape

b231469

Do not capture the Escape key when parameter hints or the problem popup is open.

trkoch reviewed Apr 15, 2021

View reviewed changes

theol0403 added 3 commits May 31, 2021 22:38

Add tree navigation

6775c8f

Add tree manipulation (experimental)

e8d55ed

Make <C-C> binding customizable

660e746

theol0403 force-pushed the refactor-bindings branch from 4dedbaa to 812d56a Compare June 1, 2021 07:19

theol0403 force-pushed the refactor-bindings branch from 4f16dfe to 466ff95 Compare June 2, 2021 06:49

theol0403 changed the title ~~[WIP] Refactor bindings and README~~ Refactor bindings and README Jun 2, 2021

theol0403 marked this pull request as ready for review June 2, 2021 07:17

theol0403 force-pushed the refactor-bindings branch from 84aaa63 to 91c4bcc Compare June 3, 2021 04:34

theol0403 added 9 commits June 2, 2021 22:50

Rename plugin from "Neo Vim" to "VSCode Neovim"

9ac305e

More readme improvements

e66b9d1

Add note on conditionally activating plugins with vim-plug

80b79dc

Add note on keyboard quickfix and add default quickfix binding

4025ec9

Document first two keybinding commits

cd2581a

Enable prose wrap for readme

c9a6a6c

Refactor readme once again

55b507c

Add table of contents and lint README

8ca37cd

Shuffle keybindings in readme

634857c

theol0403 force-pushed the refactor-bindings branch from 8a11197 to 05d54bd Compare June 3, 2021 05:51

theol0403 force-pushed the refactor-bindings branch from 05d54bd to fa0a9a3 Compare June 3, 2021 06:01

asvetliakov approved these changes Jun 3, 2021

View reviewed changes

A bit more readme refactoring

4d812eb

theol0403 force-pushed the refactor-bindings branch from fa0a9a3 to 4d812eb Compare June 3, 2021 06:03

theol0403 merged commit 8ee0c96 into vscode-neovim:master Jun 3, 2021

theol0403 deleted the refactor-bindings branch June 3, 2021 06:17

theol0403 mentioned this pull request Jun 3, 2021

Use vim syntax highlighting in README #627

Closed

theol0403 restored the refactor-bindings branch June 3, 2021 06:40

This was referenced Jun 4, 2021

Rebranding and better docs #163

Closed

<c-c> leaves insert mode even if control-keys are disabled #243

Closed

Proposal: Logo #325

Closed

Make it clearer that nightly appimage works #578

Closed

theol0403 deleted the refactor-bindings branch June 30, 2022 15:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor bindings and README #513

Refactor bindings and README #513

theol0403 commented Jan 5, 2021 •

edited

asvetliakov commented Jan 6, 2021

Shatur commented Jan 6, 2021 •

edited

Shatur commented Jan 6, 2021

David-Else commented Jan 6, 2021 •

edited

Shatur commented Jan 6, 2021

David-Else commented Jan 6, 2021 •

edited

Shatur commented Jan 6, 2021 •

edited

theol0403 commented Jan 16, 2021 •

edited

Shatur commented Jan 16, 2021

theol0403 commented Apr 2, 2021

Shatur commented Apr 2, 2021 •

edited

theol0403 commented Apr 2, 2021

theol0403 commented Apr 2, 2021

trkoch left a comment

trkoch Apr 15, 2021

theol0403 Jun 1, 2021

trkoch Apr 15, 2021

theol0403 Jun 1, 2021

trkoch Apr 15, 2021

theol0403 Jun 1, 2021

trkoch Apr 15, 2021

theol0403 Jun 1, 2021

theol0403 commented Jun 1, 2021

theol0403 commented Jun 2, 2021

asvetliakov commented Jun 2, 2021

theol0403 commented Jun 2, 2021

theol0403 commented Jun 3, 2021

theol0403 commented Jun 3, 2021

asvetliakov commented Jun 3, 2021 •

edited

theol0403 commented Jun 3, 2021

asvetliakov commented Jun 3, 2021

theol0403 commented Jun 3, 2021

asvetliakov commented Jun 3, 2021 •

edited

Refactor bindings and README #513

Refactor bindings and README #513

Conversation

theol0403 commented Jan 5, 2021 • edited

asvetliakov commented Jan 6, 2021

Shatur commented Jan 6, 2021 • edited

Shatur commented Jan 6, 2021

David-Else commented Jan 6, 2021 • edited

Shatur commented Jan 6, 2021

David-Else commented Jan 6, 2021 • edited

Shatur commented Jan 6, 2021 • edited

theol0403 commented Jan 16, 2021 • edited

Shatur commented Jan 16, 2021

theol0403 commented Apr 2, 2021

Shatur commented Apr 2, 2021 • edited

theol0403 commented Apr 2, 2021

theol0403 commented Apr 2, 2021

trkoch left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

theol0403 commented Jun 1, 2021

theol0403 commented Jun 2, 2021

asvetliakov commented Jun 2, 2021

theol0403 commented Jun 2, 2021

theol0403 commented Jun 3, 2021

theol0403 commented Jun 3, 2021

asvetliakov commented Jun 3, 2021 • edited

theol0403 commented Jun 3, 2021

asvetliakov commented Jun 3, 2021

theol0403 commented Jun 3, 2021

asvetliakov commented Jun 3, 2021 • edited

theol0403 commented Jan 5, 2021 •

edited

Shatur commented Jan 6, 2021 •

edited

David-Else commented Jan 6, 2021 •

edited

David-Else commented Jan 6, 2021 •

edited

Shatur commented Jan 6, 2021 •

edited

theol0403 commented Jan 16, 2021 •

edited

Shatur commented Apr 2, 2021 •

edited

asvetliakov commented Jun 3, 2021 •

edited

asvetliakov commented Jun 3, 2021 •

edited