Add yank highlighting

Fixes VSCodeVim#2333 Fixes VSCodeVim#2916
darfink · Oct 11, 2018 · eae14df · eae14df
1 parent 00bb9af
commit eae14df
Show file tree

Hide file tree

Showing 7 changed files with 34 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -130,6 +130,7 @@ These settings are specific to VSCodeVim.
 | vim.substituteGlobalFlag         | Similar to Vim's `gdefault` setting. `/g` flag in a substitute command replaces all occurrences in the line. Without this flag, replacement occurs only for the first occurrence in each line. With this setting enabled, the `g` is on by default.                                                                                                                                                                            | Boolean | false                    |
 | vim.useCtrlKeys                  | Enable Vim ctrl keys overriding common VSCode operations such as copy, paste, find, etc.                                                                                                                                                                                                                                                                                                                                       | Boolean | true                     |
 | vim.visualstar                   | In visual mode, start a search with `*` or `#` using the current selection                                                                                                                                                                                                                                                                                                                                                     | Boolean | false                    |
+| vim.yankHighlightColor           | Set the color of yank highlights                                                                                                                                                                                                                                                                                                                                                                                               | String  | rgba(250, 240, 170, 0.5) |
 
 ### Neovim Integration
 

diff --git a/package.json b/package.json
@@ -369,6 +369,11 @@
           "description": "Color of the search highlight.",
           "default": "rgba(150, 150, 255, 0.3)"
         },
+        "vim.yankHighlightColor": {
+          "type": "string",
+          "description": "Color of the yank highlight.",
+          "default": "rgba(250, 240, 170, 0.5)"
+        },
         "vim.useSystemClipboard": {
           "type": "boolean",
           "description": "Use system clipboard for unnamed register.",

diff --git a/src/actions/operator.ts b/src/actions/operator.ts
@@ -3,6 +3,7 @@ import * as vscode from 'vscode';
 import { Position, PositionDiff } from './../common/motion/position';
 import { Range } from './../common/motion/range';
 import { configuration } from './../configuration/configuration';
+import { Decoration } from '../configuration/decoration';
 import { ModeName } from './../mode/mode';
 import { Register, RegisterMode } from './../register/register';
 import { VimState } from './../state/vimState';
@@ -265,7 +266,8 @@ export class YankOperator extends BaseOperator {
       end = end.getLineEnd();
     }
 
-    let text = TextEditor.getText(new vscode.Range(start, end));
+    const range = new vscode.Range(start, end);
+    let text = TextEditor.getText(range);
 
     // If we selected the newline character, add it as well.
     if (
@@ -275,6 +277,7 @@ export class YankOperator extends BaseOperator {
       text = text + '\n';
     }
 
+    Decoration.yankHighlight(vimState, [range]);
     Register.put(text, vimState, this.multicursorIndex);
 
     vimState.currentMode = ModeName.Normal;
@@ -636,17 +639,20 @@ export class YankVisualBlockMode extends BaseOperator {
     return false;
   }
 
-  public async run(vimState: VimState, start: Position, end: Position): Promise<VimState> {
+  public async run(vimState: VimState, startPos: Position, endPos: Position): Promise<VimState> {
     let toCopy: string = '';
+    const ranges: vscode.Range[] = [];
 
-    for (const { line } of Position.IterateLine(vimState)) {
+    for (const { line, start, end } of Position.IterateLine(vimState)) {
+      ranges.push(new vscode.Range(start, end));
       toCopy += line + '\n';
     }
 
+    Decoration.yankHighlight(vimState, ranges);
     Register.put(toCopy, vimState, this.multicursorIndex);
 
     vimState.currentMode = ModeName.Normal;
-    vimState.cursorPosition = start;
+    vimState.cursorPosition = startPos;
     return vimState;
   }
 }

diff --git a/src/configuration/configuration.ts b/src/configuration/configuration.ts
@@ -268,6 +268,8 @@ class Configuration implements IConfiguration {
 
   searchHighlightColor = 'rgba(150, 150, 255, 0.3)';
 
+  yankHighlightColor = 'rgba(250, 240, 170, 0.5)';
+
   @overlapSetting({ settingName: 'tabSize', defaultValue: 8 })
   tabstop: number;
 

diff --git a/src/configuration/decoration.ts b/src/configuration/decoration.ts
@@ -1,6 +1,7 @@
 import * as vscode from 'vscode';
 
 import { configuration } from '../configuration/configuration';
+import { VimState } from '../state/vimState';
 
 export class Decoration {
   static readonly Default = vscode.window.createTextEditorDecorationType({
@@ -24,4 +25,13 @@ export class Decoration {
   static readonly EasyMotion = vscode.window.createTextEditorDecorationType({
     backgroundColor: configuration.searchHighlightColor,
   });
+
+  static yankHighlight(vimState: VimState, range: vscode.Range[]) {
+    const decoration = vscode.window.createTextEditorDecorationType({
+      backgroundColor: configuration.yankHighlightColor,
+    });
+
+    vimState.editor.setDecorations(decoration, range);
+    setTimeout(() => decoration.dispose(), 200);
+  }
 }
diff --git a/src/configuration/iconfiguration.ts b/src/configuration/iconfiguration.ts
@@ -160,6 +160,11 @@ export interface IConfiguration {
    */
   searchHighlightColor: string;
 
+  /**
+   * Color of yank highlights.
+   */
+  yankHighlightColor: string;
+
   /**
    * Size of a tab character.
    */

diff --git a/test/testConfiguration.ts b/test/testConfiguration.ts
@@ -55,6 +55,7 @@ export class Configuration implements IConfiguration {
     loggingLevel: 'warn';
   };
   searchHighlightColor = 'rgba(150, 150, 255, 0.3)';
+  yankHighlightColor = 'rgba(250, 240, 170, 0.5)';
   tabstop = 2;
   editorCursorStyle = vscode.TextEditorCursorStyle.Line;
   expandtab = true;