Implementing a leap plugin #8197

cuixiaorui · 2023-01-06T08:37:12Z

What this PR does / why we need it:

I have implemented a leap functionality plugin in vscodevim

leap is currently a very popular mobile plugin in the neovim community, and it is really efficient. I believe there are many vscodevim users waiting for its arrival #8144

Functional Features

s c c -> search down
S c c -> Search up
s c -> Show cue marker points
s <enter> -> Execute the previous search
s c <space> -> Search c + \t

You can see how it behaves in vscodevim

Docs

You can read leap documentation for more detailed information

Compare the functional differences between leap.nvim

Because the implementation of vscodevim is different from neovim. So in some functions it is not the same as leap.nvim

No automatic jumping to the first marker point
Selection of multiple markers
No support for using operators together

Does not automatically jump to the first marker point

When matching multiple tag points, it does not automatically jump to the first tag point position.

In leap.nvim you can recognize that when you press a character that is the tag of a marker point then it will automatically jump to the marker point, otherwise it will execute the character as if it was a command in normal mode, but unfortunately this is not possible in vscodevim.

Another problem is that this feature can be confusing. Sometimes it jumps automatically and sometimes it doesn't (for example when there are multiple jump points, or you set the corresponding configuration). So I simply killed this feature in my implementation.

Instead of jumping to the first match point by default, the implementation now requires you to press an s. This s can be modified by the configuration

Of course, if only one marker is matched, then it will automatically jump over

Multiple markers are selected in the following way

In leap.nvim, if there are too many matching tokens, then the selection method is to select the corresponding group by /.The problem with this method is that if three groups are matched, then needs to be pressed twice to select them. (Of course, this is a very extreme case, so you will not encounter it)

In my implementation, I refer to easymotion's jump implementation, which starts with one letter and uses two letters if it goes beyond that, so the advantage is that no matter how many matches are made, the two letters will directly locate the marker point.Of course, another reason is that this implementation is unified with easymotion. Because some mobile scenes use easymotion. So it would be difficult to have two sets of selections. (I believe many users of vscodeVim also use easymotion, so this behavior may be more preferable for them, but I'm not sure... haha... what do you think?)

Use with operators is not supported

Unfortunately, this feature is also not supported, again because of the underlying implementation of vscodevim. Currently there is no way to do this

But this feature scenario is not used very often

Can I map other keys if I don't want to use s S?

You can refer to the following configuration

Replace s with f

"vim.normalModeKeyBindingsNonRecursive": [
  {

      "before":[
        "f"
      ],

      "after":[
        "s"
      ]
    },

    {

      "before":[
        "s"
      ],

      "after":[
        "c",
        "l"
      ]
    },
]

How should I experience this feature before this pr merge?

You can install the experience locally based on my code branch

From time to time, I will merge new code from vscodevim into my branch until this pr is merged.

Here's how to do it:

Download my code branch
yarn
yarn package
code --install-extension vim-1.25.2.vsix --force
set vim.leap.enable = true on setting.json

There is another easy way to download my compiled files directly
download vim-1.25.2.vsix

Issues

Conflict of S keys in visualization mode

the s/S in visualization mode contains both characters of the match
But now the problem is that S is used by the surround plugin.
How can I solve this key conflict problem? Does anyone have any good ideas?

Update

Support for using leap in visual mode

Use x / X instead of s / S on visual mode, because s/S is already taken by the surround plugin.

Support bidirectional search

set vim.leap.bidirectionalSearch": true enable the feature

Because I feel a little uncomfortable using ’S’. I need to reflect between ’s’ and ’S’ and ’S’ makes me press an extra ’shift’.
It also supports ’s’ and ’x’ in visual mode

kabouzeid · 2023-01-07T11:27:31Z

The settings need to be contributed to the package.json such that eg vim.leap=true can be set from the GUI.

cuixiaorui · 2023-01-08T05:11:06Z

The settings need to be contributed to the package.json such that eg vim.leap=true can be set from the GUI.

thx your tips, it's fixed now.

elazarcoh

Hi, I would love to see this PR get merge. Already built you version into my custom VSCodeVim build I'm using for my everyday work.
In the meantime, I made a review.
My main complaint is that you use ! too freely for my taste 🙃

elazarcoh · 2023-01-08T16:12:42Z

src/actions/plugins/leap/Marker.ts

+  private marker!: Marker;
+  private textEditorDecorationType: vscode.TextEditorDecorationType;
+
+  private static backgroundColors = ['#ccff88', '#99ccff'];


probably need to be configurable (or theme dependent)

src/actions/plugins/leap/Marker.ts

elazarcoh · 2023-01-08T16:23:59Z

src/configuration/configuration.ts

+  leap = false;
+  leapShowMarkerPosition = 'after';
+  leapLabels = 'sklyuiopnm,qwertzxcvbahdgjf;';
+  leapCaseSensitive = false;


probably should be added to IConfiguration as well

elazarcoh · 2023-01-08T16:40:28Z

src/actions/plugins/leap/match.ts

+    let pattern = '';
+    if (secondChar === ' ') {
+      pattern = firstChar + '\\s' + '|' + firstChar + '$';
+    } else {
+      pattern = firstChar + secondChar;
+    }


Suggested change

let pattern = '';

if (secondChar === ' ') {

pattern = firstChar + '\\s' + '|' + firstChar + '$';

} else {

pattern = firstChar + secondChar;

}

const pattern =

secondChar === ' '

? `${firstChar}\\s|${firstChar}$'

: `${firstChar}{secondChar}`;

for me, this is clearer. maybe only for me, tough.

haha I forget to refactor this code, Thank you for reminding me

elazarcoh · 2023-01-08T17:51:17Z

src/actions/plugins/leap/match.ts

+  return new RegExp(getPattern(searchString), getFlags());
+}
+
+const MATCH_LINE_COUNT = 50;


It should be possible to get visible range of the document, instead of hard-coding it.
https://code.visualstudio.com/api/references/vscode-api#TextEditor

elazarcoh · 2023-01-08T17:59:56Z

src/actions/plugins/leap/leap.ts

+  previousMode!: Mode;
+  isRepeatLastSearch: boolean = false;
+  direction?: LeapSearchDirection;
+  leapAction?: LeapAction;
+  firstSearchString?: string;
+
+  constructor(vimState: VimState) {
+    this.vimState = vimState;
+  }


Suggested change

previousMode!: Mode;

isRepeatLastSearch: boolean = false;

direction?: LeapSearchDirection;

leapAction?: LeapAction;

firstSearchString?: string;

constructor(vimState: VimState) {

this.vimState = vimState;

}

previousMode: Mode;

isRepeatLastSearch: boolean = false;

direction?: LeapSearchDirection;

leapAction?: LeapAction;

firstSearchString?: string;

constructor(vimState: VimState) {

this.vimState = vimState;

this.previousMode = vimState.currentMode;

}

How about this?

src/actions/plugins/leap/LeapAction.ts

kabouzeid · 2023-01-11T14:42:17Z

in visual mode x and X don't jump to the right character. and s and S are not there at all.

cuixiaorui · 2023-01-12T04:07:57Z

@kabouzeid I just found this detail

The x in visualization mode does not contain the match, while the s in visualization mode contains both characters of the match
But now the problem is that S is used by the surround plugin.
How can I solve this key conflict problem? Do you have any good ideas?

cuixiaorui · 2023-01-15T08:39:53Z

fixed the bug that in visual mode x and X don't jump to the right character

in visual mode x and X don't jump to the right character. and s and S are not there at all.

Leiyi548 · 2023-02-09T16:00:20Z

@cuixiaorui leap.nvim can be set to support two-way search, do you plan to support it later?

cuixiaorui · 2023-02-10T01:27:10Z

@cuixiaorui leap.nvim can be set to support two-way search, do you plan to support it later?

Is there a description document for two-way search? I'll look into it.

Leiyi548 · 2023-02-10T07:13:29Z

@cuixiaorui

more information please see https://github.com/ggandor/leap.nvim#calling-leap-with-custom-arguments

cuixiaorui · 2023-02-10T10:31:36Z

@cuixiaorui more information please see https://github.com/ggandor/leap.nvim#calling-leap-with-custom-arguments

Haha
Interesting feature
Sometimes I really don't like to use S because I have to press one more shift
I will implement this feature when I have time in a few days
I will update the documentation and then

Leiyi548 · 2023-02-10T11:51:44Z

Yes, sometimes I have to think in my head whether to press shift or not, and it bothers me.

cuixiaorui · 2023-03-11T04:20:17Z

@Leiyi548

I finally finished implementing this function yesterday
You can use it to see
If you have problems, just give me feedback!

set vim.leap.bidirectionalSearch": true enable the feature

Shaker-Pelcro · 2023-03-23T16:42:42Z

Would love to see this merged.

J-Fields · 2023-03-27T20:07:55Z

package.json

@@ -621,6 +621,31 @@
          "markdownDescription": "Enable the [CamelCaseMotion](https://github.com/bkad/CamelCaseMotion) plugin for Vim.",
          "default": false
        },
+        "vim.leap": {


Let's make this vim.leap.enabled and change others to vim.leap.showMarkerPosition, for instance

J-Fields · 2023-03-27T20:09:05Z

package.json

@@ -1190,6 +1215,7 @@
    "ts-loader": "9.4.2",
    "tslint": "6.1.3",
    "typescript": "4.9.5",
+    "vitest": "^0.29.2",


I think this is unintended?

Leiyi548 · 2023-04-06T06:03:57Z

@cuixiaorui Can you add the option to uncheck visual mode x leap search, because most of the time I checked x for delete

cuixiaorui · 2023-04-07T03:20:27Z

Hi @J-Fields @elazarcoh
thank you very much for taking the time to review Leap's code.
I have just fixed all the issues mentioned above. In addition, I have also updated the following features:

Added the functionality of bidirectional search.
Supported marker background color and font color configuration.
Refactored the way to get Leap (removed it from vimState).

Please feel free to contact me if you have any questions.
I really like vscodeVim and promote it in many places.
I sincerely hope that vscodeVim will become better and better.

Alan-MQ · 2023-04-07T03:52:28Z

I have a suggestion, make the first match always be "j", or have a setting where user can choose what character they want to jumo to the first match point. (you know they did similar stuff in neovim ,in neovim they support command , but that's whole another thing though)
eg: use "Sse" here , "j" will get me to the "use" of this line since in this line we have the first match. am I making myself clear?

Alan-MQ · 2023-04-07T04:20:09Z

I have a suggestion, make the first match always be "j", or have a setting where user can choose what character they want to jumo to the first match point. (you know they did similar stuff in neovim ,in neovim they support command , but that's whole another thing though) eg: use "Sse" here , "j" will get me to the "use" of this line since in this line we have the first match. am I making myself clear?

You know what maybe make the first match the last command character
if the command = "sse" make the firt match jumping character is e, if command = "sid" make the first match jumping character is d. dynamic.

cuixiaorui · 2023-04-07T04:59:48Z

I have a suggestion, make the first match always be "j", or have a setting where user can choose what character they want to jumo to the first match point. (you know they did similar stuff in neovim ,in neovim they support command , but that's whole another thing though) eg: use "Sse" here , "j" will get me to the "use" of this line since in this line we have the first match. am I making myself clear?

You can set vim.leap.labels to modify the default value of "sklyuiopnm,qwertzxcvbahdgjf;", where "s" is the first jumping point.

rennsax · 2023-06-28T05:24:01Z

This PR wasn't merged yet?

archilkarchava · 2023-06-28T18:56:43Z

@cuixiaorui, thanks a lot for the plugin implementation.
I found a small issue. When multiple cursors are present and the leap plugin is invoked the extension gets stuck in Leap mode and it's not possible to move the cursor until the file is closed and reopened. The issue is reproducible with multiple cursors both in normal and visual modes.

Screen.Recording.2023-06-28.at.22.48.02.mp4

It's an easy fix, we just need to check for !vimState.isMultiCursor inside the doesActionApply function archilkarchava@2af6856.
In this case, the sneak plugin will be used instead as long as it is enabled.

archilkarchava · 2023-06-29T16:33:59Z

@cuixiaorui, the leap action is dot-repeatable, which is not desirable. Here's how we can exclude it from being marked as dot-repeatable archilkarchava@12da1ca.

archilkarchava · 2023-06-29T16:39:44Z

@cuixiaorui, also, I've discovered that the <s-Enter> to execute the previous search is disabled in the code for some reason if the vim.leap.bidirectionalSearch enabled.
I've reenabled it in my fork archilkarchava@e0d0f96 and it looks like it's working just fine.

archilkarchava · 2023-07-03T17:25:29Z

I've been daily driving this plugin for a couple of days and discovered a significant performance degradation over time when it comes to displaying the markers.
It turns out that calling the this.textEditorDecorationType.dispose is not enough and we can fix it by adding the this.editor.setDecorations(this.textEditorDecorationType, []); call to the dispose method on the marker.
Here's how I've fixed it in my fork archilkarchava@41b444d.

Here's a demo:

Before the fix

vscode-vim-leap-before-the-fix.mp4

After the fix

vscode-vim-after-the-fix.mp4

cuixiaorui · 2023-07-04T08:06:01Z

I want to express my sincere gratitude for bringing these issues to my attention. Your feedback has been incredibly useful.

I have addressed and resolved the problems you pointed out. The code has been updated accordingly. I truly appreciate your help in improving the quality of this project.

Please feel free to check the updated code and let me know if you encounter any other issues. Your continued support and feedback are always welcome.

Thank you once again for your valuable contribution. @archilkarchava

dykwok · 2023-08-08T01:13:55Z

@J-Fields is this PR okay to merge?

clamydo · 2023-08-08T07:45:22Z

Love it!

For further reference and inspiration, if required, there is yet another alternative https://github.com/folke/flash.nvim, that also features remote actions, which I find rather ingenious.

Remote actions work like that:

Cursor is at position A
Start remote action: for example for yanking remotely press yr and then leap to a position B
Do a motion, e.g. iw or another leap
Cursor jumps back to A

cuixiaorui · 2023-08-09T03:25:05Z

Love it!

For further reference and inspiration, if required, there is yet another alternative https://github.com/folke/flash.nvim, that also features remote actions, which I find rather ingenious.

Remote actions work like that:

Cursor is at position A

Start remote action: for example for yanking remotely press yr and then leap to a position B

Do a motion, e.g. iw or another leap

Cursor jumps back to A

Soon I will implement flash-like functionality in vscodeVim!
Progress will be synchronized to this issue

archilkarchava · 2023-10-06T20:22:05Z

@cuixiaorui, thanks for your kind words. I've been using this plugin ever since and it's been a major improvement to my workflow.
I found another small issue: all matches get a label. This includes cases where a search string has a single match.
These labels only confuse the user since the cursor will jump to the match automatically without pressing a label key.

We can fix the issue by not assigning a label in case a search string only has a single corresponding match: archilkarchava@318fd31.

Before the fix

Screen.Recording.2023-10-07.at.00.08.55.mp4

After the fix

Screen.Recording.2023-10-07.at.00.04.07.mp4

cooljser · 2024-03-04T10:58:03Z

Why this PR not be merged? This is a realy used plugin for vim user.

cuixiaorui changed the title ~~Feat implementation leap plugin~~ Implementing a leap plugin Jan 6, 2023

cuixiaorui force-pushed the leap branch from bb2edd1 to 9d74fdd Compare January 8, 2023 05:04

Feat implementation leap plugin

22dafea

cuixiaorui force-pushed the leap branch from 9d74fdd to 22dafea Compare January 8, 2023 05:05

elazarcoh suggested changes Jan 8, 2023

View reviewed changes

cuixiaorui added 4 commits January 11, 2023 14:04

Feat leap support visual

9bfe07f

Update leap configuration

d245e30

Docs update leap

96922cf

Test add test case for leap

25114ac

Update leap select range on visual mode

fa8595f

Refactor leapget match position logic

6084d71

cuixiaorui added 4 commits March 9, 2023 21:26

Merge branch 'leap' of github.com:cuixiaorui/VSCodeVim into leap

d2d7815

Feat leap support bidirectional search

37ab6be

Feat leap optimize bidirectional search and support visual

2e3a35b

Update leap docs

9783c6b

Fix leap search bug when have folding code

de96144

J-Fields reviewed Mar 27, 2023

View reviewed changes

cuixiaorui added 2 commits March 31, 2023 22:41

Update leap plugin

5cdb1ac

Merge branch 'master' of github.com:VSCodeVim/Vim into leap

b8c345f

cuixiaorui force-pushed the leap branch from 65344c7 to b8c345f Compare March 31, 2023 14:46

Update leap add config for set marker background color and char color

f088aba

cuixiaorui added 2 commits April 6, 2023 20:59

Merge branch 'master' of github.com:VSCodeVim/Vim into leap

eb5d88e

Refactor get leap install logic

ad3c8be

Alan-MQ and others added 2 commits April 9, 2023 21:58

fix: README.md typo caseSensitive fixed (VSCodeVim#1)

d8c9a5e

Merge branch 'leap' of github.com:cuixiaorui/VSCodeVim into leap

35cb7d3

cuixiaorui added 5 commits July 4, 2023 15:43

Merge branch 'master' of github.com:VSCodeVim/Vim into leap

5184366

feat: don't mark leap action as repeatable

391f7d8

feat: leap support repeat last search

db749ab

fix: performance degradation linked to improper disposal of leap marks

9bc995f

fix: disable leap when multiple cursors are spawned

3bf9b48

cuixiaorui mentioned this pull request Sep 17, 2023

Implementing flash functionality in neovim #8567

Open

Implementing a leap plugin #8197

Are you sure you want to change the base?

Implementing a leap plugin #8197

Conversation

cuixiaorui commented Jan 6, 2023 • edited

What this PR does / why we need it:

Functional Features

Docs

Compare the functional differences between leap.nvim

Does not automatically jump to the first marker point

Multiple markers are selected in the following way

Use with operators is not supported

Can I map other keys if I don't want to use s S?

How should I experience this feature before this pr merge?

Issues

Conflict of S keys in visualization mode

Update

Support for using leap in visual mode

Support bidirectional search

kabouzeid commented Jan 7, 2023

cuixiaorui commented Jan 8, 2023

elazarcoh left a comment

Choose a reason for hiding this comment

elazarcoh Jan 8, 2023 • edited

Choose a reason for hiding this comment

elazarcoh Jan 8, 2023

Choose a reason for hiding this comment

elazarcoh Jan 8, 2023

Choose a reason for hiding this comment

cuixiaorui Jan 11, 2023

Choose a reason for hiding this comment

elazarcoh Jan 8, 2023

Choose a reason for hiding this comment

elazarcoh Jan 8, 2023

Choose a reason for hiding this comment

kabouzeid commented Jan 11, 2023

cuixiaorui commented Jan 12, 2023

cuixiaorui commented Jan 15, 2023

Leiyi548 commented Feb 9, 2023

cuixiaorui commented Feb 10, 2023 • edited

Leiyi548 commented Feb 10, 2023

cuixiaorui commented Feb 10, 2023

Leiyi548 commented Feb 10, 2023

cuixiaorui commented Mar 11, 2023 • edited

Shaker-Pelcro commented Mar 23, 2023

J-Fields Mar 27, 2023

Choose a reason for hiding this comment

J-Fields Mar 27, 2023

Choose a reason for hiding this comment

Leiyi548 commented Apr 6, 2023

cuixiaorui commented Apr 7, 2023

Alan-MQ commented Apr 7, 2023

Alan-MQ commented Apr 7, 2023

cuixiaorui commented Apr 7, 2023 • edited

rennsax commented Jun 28, 2023

archilkarchava commented Jun 28, 2023 • edited

archilkarchava commented Jun 29, 2023

archilkarchava commented Jun 29, 2023 • edited

archilkarchava commented Jul 3, 2023

Before the fix

After the fix

cuixiaorui commented Jul 4, 2023

dykwok commented Aug 8, 2023

clamydo commented Aug 8, 2023

cuixiaorui commented Aug 9, 2023 • edited

archilkarchava commented Oct 6, 2023

Before the fix

After the fix

cooljser commented Mar 4, 2024

cuixiaorui commented Jan 6, 2023 •

edited

elazarcoh Jan 8, 2023 •

edited

cuixiaorui commented Feb 10, 2023 •

edited

cuixiaorui commented Mar 11, 2023 •

edited

cuixiaorui commented Apr 7, 2023 •

edited

archilkarchava commented Jun 28, 2023 •

edited

archilkarchava commented Jun 29, 2023 •

edited

cuixiaorui commented Aug 9, 2023 •

edited