publish

Author: bzy-debug

README.md

@@ -1,3 +1,36 @@
 # Flash Jump
 
-Flash jump to anywhere in the editor. Highly inspired by the [neovim flash extension](https://github.com/folke/flash.nvim)
+Flash jump to anywhere in the editor. Inspired by the [neovim flash extension](https://github.com/folke/flash.nvim)
+
+<video controls muted>
+  <source src="https://github.com/bzy-debug-orgnization/vscode-extension-flash/raw/refs/heads/main/assets/example.mp4" type="video/mp4"/>
+</video>
+
+## Features
+
+- `flash-jump.flash`: start flash jump
+- `flash-jump.cancel`: cancel flash jump during input, biding to `escape` by default
+
+## For vscode vim users
+
+1. If you find this extension does not work, add following to your `settings.json`:
+
+   ```json
+     "extensions.experimental.affinity": {
+       "vscodevim.vim": 1
+     },
+   ```
+
+   This setting also [improves vscode vim's performance](https://github.com/VSCodeVim/Vim?tab=readme-ov-file#-faq), you might find it helpful to enable it even if you don't use this extension
+
+1. If you find that `escape` shortcut of `flash-jump.cancel` does not work, app following to the end of your `keybindings.json`:
+
+   ```json
+     {
+       "key": "escape",
+       "command": "flash-jump.cancel",
+       "when": "editorTextFocus && flash-jump.active"
+     },
+   ```
+
+   The order matters here since the latter keybindings have higher priorities.

assets/example.mp4

@@ -22,11 +22,11 @@
     "commands": [
       {
         "command": "flash-jump.flash",
-        "title": "Flash: start"
+        "title": "Flash Jump: start"
       },
       {
         "command": "flash-jump.cancel",
-        "title": "Flash: cancel"
+        "title": "Flash Jump: cancel"
       }
     ],
     "keybindings": [

package.json

@@ -8,7 +8,7 @@ function placeholder(char: string): vscode.TextEditorDecorationType {
   return vscode.window.createTextEditorDecorationType({
     before: {
       contentText: char,
-      backgroundColor: "rgb(60, 179, 113)",
+      backgroundColor: "rgb(255, 105, 180)",
       color: "rgb(255, 255, 255)",
       textDecoration: `none; z-index: 1; position: absolute`,
     },
@@ -73,6 +73,11 @@ async function flash(editor: vscode.TextEditor) {
           vscode.TextEditorRevealType.InCenter,
         );
       };
+      if (lastPlaceholders.length === 1 && text === "\n") {
+        jump(lastPlaceholders[0].position);
+        cancel();
+        return;
+      }
       for (const ph of lastPlaceholders) {
         if (ph.char === text) {
           jump(ph.position);
@@ -117,11 +122,11 @@ async function flash(editor: vscode.TextEditor) {
           }
         }
       }
-      if (ranges.length === 1) {
-        jump(ranges[0].end);
-        cancel();
-        return;
-      }
+      // if (ranges.length === 1) {
+      //   jump(ranges[0].end);
+      //   cancel();
+      //   return;
+      // }
       if (ranges.length === 0) {
         cancel();
         return;