feat(leap): support dim unconcerned characters when enabling leap.

README.md

@@ -536,6 +536,8 @@ Based on [vim-leap](https://github.com/ggandor/leap.nvim) and configured through
 | vim.leap.bidirectionalSearch | Enable/disable bidirectional search          | Boolean | false                          |                    |
 | vim.leap.marker.backgroundColors              | The background colors of the marker box.                                                                  | Array  | ['#ccff88', '#99ccff']                                            |
 | vim.leap.marker.charColor              | The color of the marker char.                                                                  | String  | "#000000"                                            |
+| vim.leap.dim           | Enable/Disable dim for leap | Boolean | true | |
+| vim.leap.dimColor           | The dim color | String  | "#777777"                                            | |
 
 Once leap is active, initiate motions using the following commands.After you initiate the motion, text decorators/markers will be displayed and you can press the keys displayed to jump to that position. For visual mode leap uses x instead of s because s is already taken by the surround plugin.
 

package.json

@@ -659,6 +659,16 @@
           "markdownDescription": "The color of the marker char",
           "default": "#000000"
         },
+        "vim.leap.dim": {
+          "type": "boolean",
+          "default": true,
+          "markdownDescription": "Enable the dimming of characters when using Leap"
+        },
+        "vim.leap.dimColor": {
+          "type": "string",
+          "default": "#777777",
+          "markdownDescription": "Set a custom color for the leap dimmed characters when `#vim.leap.dim#` is set to true."
+        },
         "vim.easymotion": {
           "type": "boolean",
           "markdownDescription": "Enable the [EasyMotion](https://github.com/easymotion/vim-easymotion) plugin for Vim.",
@@ -1238,4 +1248,4 @@
     "*.{ts,js,json,md,yml}": "prettier --write",
     "*.ts": "tslint --fix"
   }
-}
+}

src/actions/plugins/leap/LeapAction.ts

@@ -47,6 +47,7 @@ export class LeapPrepareAction extends BaseCommand {
     );
 
     leap.showMarkers();
+    leap.setDimmingZones();
     await vimState.setCurrentMode(Mode.LeapPrepareMode);
   }
 

src/actions/plugins/leap/leap.ts

@@ -5,6 +5,7 @@ import { VimState } from '../../../state/vimState';
 import { LeapAction } from './LeapAction';
 import { Position } from 'vscode';
 import { configuration } from '../../../configuration/configuration';
+import * as vscode from 'vscode';
 
 export enum LeapSearchDirection {
   Forward = -1,
@@ -21,6 +22,10 @@ export class Leap {
   direction?: LeapSearchDirection;
   leapAction?: LeapAction;
   firstSearchString?: string;
+  dimmingZone = vscode.window.createTextEditorDecorationType({
+    // to prevent empty string of dimColor
+    color: configuration.leap.dimColor || '#777777',
+  });
 
   constructor(vimState: VimState) {
     this.vimState = vimState;
@@ -37,6 +42,21 @@ export class Leap {
     return this.markers;
   }
 
+  public setDimmingZones() {
+    if (!configuration.leap.dim) return;
+    const dimmingZones: vscode.DecorationOptions[] = [];
+    const dimmingRenderOptions: vscode.ThemableDecorationRenderOptions = {
+      // we update the color here again in case the configuration has changed
+      color: configuration.leap.dimColor || '#777777',
+    };
+    dimmingZones.push({
+      // fill the whole document
+      range: new vscode.Range(0, 0, this.vimState.editor.document.lineCount, 0),
+      renderOptions: dimmingRenderOptions,
+    });
+    this.vimState.editor.setDecorations(this.dimmingZone, dimmingZones);
+  }
+
   private setMarkersName() {
     const map: Map<string, Marker[]> = new Map();
 
@@ -147,6 +167,11 @@ export class Leap {
     this.markers = [];
   }
 
+  public cleanupDimmingZones() {
+    if (!configuration.leap.dim) return;
+    this.vimState.editor.setDecorations(this.dimmingZone, []);
+  }
+
   public showMarkers() {
     this.markers.forEach((marker) => {
       marker.show();
@@ -236,5 +261,6 @@ export function getLeapInstance(): Leap {
 }
 
 export function disposeLeap() {
-  leap?.cleanupMarkers()
+  leap?.cleanupMarkers();
+  leap?.cleanupDimmingZones();
 }

src/configuration/configuration.ts

@@ -275,6 +275,8 @@ class Configuration implements IConfiguration {
       backgroundColors: ['#ccff88', '#99ccff'],
       charColor: '#000000',
     },
+    dim: true,
+    dimColor: '#777777',
   };
 
   targets: ITargetsConfiguration = {

src/configuration/iconfiguration.ts

@@ -96,6 +96,8 @@ export interface ILeapConfiguration {
     backgroundColors: string[];
     charColor: string;
   };
+  dim: boolean;
+  dimColor: string;
 }
 
 export interface IConfiguration {

test/testConfiguration.ts

@@ -37,8 +37,10 @@ export class Configuration implements IConfiguration {
     bidirectionalSearch: false,
     marker: {
       backgroundColors: ['#ccff88', '#99ccff'],
-      charColor:"#000000"
+      charColor: '#000000',
     },
+    dim: true,
+    dimColor: '#777777',
   };
   surround = false;
   argumentObjectSeparators = [','];