Add visualModesKeyBindings

README.md

@@ -241,9 +241,9 @@ Here's some ideas on what you can do with neovim integration:
 
 There's several different mechanisms you can use to define custom remappings. Also see the [`useCtrlKeys`](#vimusectrlkeys) and [`handleKeys`](#vimhandlekeys) settings.
 
-#### `"vim.insertModeKeyBindings"`/`"vim.otherModesKeyBindings"`
+#### `"vim.insertModeKeyBindings"`/`"vim.otherModesKeyBindings"`/`"vim.visualModesKeyBindings"`
 
-* Keybinding overrides to use for insert and other (non-insert) modes.
+* Keybinding overrides to use for insert, visual and other (non-insert) modes.
 * Bind `jj` to `<Esc>` in insert mode:
 
 ```json
@@ -316,7 +316,7 @@ There's several different mechanisms you can use to define custom remappings. Al
     ]
 ```
 
-#### `"vim.insertModeKeyBindingsNonRecursive"`/`"otherModesKeyBindingsNonRecursive"`
+#### `"vim.insertModeKeyBindingsNonRecursive"`/`"otherModesKeyBindingsNonRecursive"`/`"visualModesKeyBindingsNonRecursive"`
 
 * Non-recursive keybinding overrides to use for insert and other (non-insert) modes (similar to `:noremap`)
 * *Example:* Bind `j` to `gj`. Notice that if you attempted this binding normally, the j in gj would be expanded into gj, on and on forever. Stop this recursive expansion using insertModeKeyBindingsNonRecursive and/or otherModesKeyBindingNonRecursive.

package.json

@@ -388,6 +388,14 @@
           "type": "array",
           "description": "Non-recursive keybinding overrides to use for insert mode. Allows mapping to vim commands or vscode actions. See README for more."
         },
+        "vim.visualModeKeyBindings": {
+          "type": "array",
+          "description": "Remapped keys in visual mode. Allows mapping to vim commands or vscode actions. See README for more."
+        },
+        "vim.visualModeKeyBindingsNonRecursive": {
+          "type": "array",
+          "description": "Non-recursive keybinding overrides to use for visual mode. Allows mapping to vim commands or vscode actions. See README for more."
+        },
         "vim.textwidth": {
           "type": "number",
           "description": "Width to word-wrap to when using gq.",

src/configuration/configuration.ts

@@ -95,6 +95,8 @@ class Configuration implements IConfiguration {
       this.insertModeKeyBindingsNonRecursive,
       this.otherModesKeyBindings,
       this.otherModesKeyBindingsNonRecursive,
+      this.visualModesKeyBindings,
+      this.visualModesKeyBindingsNonRecursive,
     ];
     for (const keybindings of keybindingList) {
       for (let remapping of keybindings) {
@@ -331,6 +333,8 @@ class Configuration implements IConfiguration {
   insertModeKeyBindingsNonRecursive: IKeyRemapping[] = [];
   otherModesKeyBindings: IKeyRemapping[] = [];
   otherModesKeyBindingsNonRecursive: IKeyRemapping[] = [];
+  visualModesKeyBindings: IKeyRemapping[] = [];
+  visualModesKeyBindingsNonRecursive: IKeyRemapping[] = [];
 }
 
 function overlapSetting(args: {

src/configuration/iconfiguration.ts

@@ -218,4 +218,6 @@ export interface IConfiguration {
   insertModeKeyBindingsNonRecursive: IKeyRemapping[];
   otherModesKeyBindings: IKeyRemapping[];
   otherModesKeyBindingsNonRecursive: IKeyRemapping[];
+  visualModesKeyBindings: IKeyRemapping[];
+  visualModesKeyBindingsNonRecursive: IKeyRemapping[];
 }

src/configuration/remapper.ts

@@ -28,8 +28,10 @@ export class Remappers implements IRemapper {
     this.remappers = [
       new InsertModeRemapper(true),
       new OtherModesRemapper(true),
+      new VisualModesRemapper(true),
       new InsertModeRemapper(false),
       new OtherModesRemapper(false),
+      new VisualModesRemapper(false),
     ];
   }
 
@@ -205,3 +207,13 @@ class OtherModesRemapper extends Remapper {
     );
   }
 }
+
+class VisualModesRemapper extends Remapper {
+  constructor(recursive: boolean) {
+    super(
+      'visualModesKeyBindings' + (recursive ? '' : 'NonRecursive'),
+      [ModeName.Visual, ModeName.VisualLine, ModeName.VisualBlock],
+      recursive
+    );
+  }
+}

test/configuration/remapper.test.ts

@@ -29,12 +29,25 @@ suite('Remapper', () => {
       ],
     },
   ];
+  const visualModeKeyBindings = [
+    {
+      before: ['leader', 'w'],
+      after: [],
+      commands: [
+        {
+          command: 'workbench.action.closeActiveEditor',
+          args: [],
+        },
+      ],
+    },
+  ];
 
   setup(async () => {
     let configuration = new Configuration();
     configuration.leader = leaderKey;
     configuration.insertModeKeyBindings = insertModeKeyBindings;
     configuration.otherModesKeyBindings = otherModeKeysRebindings;
+    configuration.visualModesKeyBindings = visualModeKeyBindings;
 
     await setupWorkspace(configuration);
     modeHandler = await getAndUpdateModeHandler();
@@ -78,4 +91,36 @@ suite('Remapper', () => {
     assert.equal(actual, true);
     assert.equal(vscode.window.visibleTextEditors.length, 0);
   });
+
+  test('remapped command with leader, only on visual mode', async () => {
+    // setup - normal mode
+    let remapper = new Remappers();
+    assertEqual(modeHandler.currentMode.name, ModeName.Normal);
+
+    // act
+    try {
+      await remapper.sendKey([leaderKey, 'w'], modeHandler, modeHandler.vimState);
+    } catch (e) {
+      assert.ok(true);
+    }
+
+    // assert
+    assert.equal(vscode.window.visibleTextEditors.length, 1);
+
+    // setup - visual mode
+    await modeHandler.handleKeyEvent('v');
+    assertEqual(modeHandler.currentMode.name, ModeName.Visual);
+
+    // act
+    let actual = false;
+    try {
+      actual = await remapper.sendKey([leaderKey, 'w'], modeHandler, modeHandler.vimState);
+    } catch (e) {
+      assert.fail(e);
+    }
+
+    // assert
+    assert.equal(actual, true);
+    assert.equal(vscode.window.visibleTextEditors.length, 0);
+  });
 });

test/testConfiguration.ts

@@ -70,4 +70,6 @@ export class Configuration implements IConfiguration {
   insertModeKeyBindingsNonRecursive: IKeyRemapping[] = [];
   otherModesKeyBindings: IKeyRemapping[] = [];
   otherModesKeyBindingsNonRecursive: IKeyRemapping[] = [];
+  visualModesKeyBindings: IKeyRemapping[] = [];
+  visualModesKeyBindingsNonRecursive: IKeyRemapping[] = [];
 }