Context menu support (clarkio#115)

* Remove highlights by context-menu

* Updated changelog

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Released]
 
+## [0.5.1]
+
+### Added
+
+- Context menu support to remove highlights. You can now remove highlights by right-clicking on them. Additionally, you can remove all highlights by right-clicking the editor tab.
+
 ## [0.5.0]
 
 ### Rewrite

package.json

@@ -2,7 +2,7 @@
   "name": "twitch-highlighter",
   "displayName": "Twitch Highlighter",
   "description": "Allow your Twitch viewers to help in spotting bugs, typos, etc. by sending a command in chat that will highlight the line of code they want you to check.",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "preview": true,
   "publisher": "clarkio",
   "engines": {
@@ -84,6 +84,11 @@
         "command": "twitchHighlighter.disconnect",
         "title": "Stop Listening to Chat",
         "category": "Twitch Highlighter"
+      },
+      {
+        "command": "twitchHighlighter.context.unhighlight",
+        "title": "Remove Highlight",
+        "category": "Twitch Highlighter"
       }
     ],
     "menus": {
@@ -111,6 +116,10 @@
         {
           "command": "twitchHighlighter.requestUnhighlightAll",
           "when": "false"
+        },
+        {
+          "command": "twitchHighlighter.context.unhighlight",
+          "when": "false"
         }
       ],
       "view/title": [
@@ -126,6 +135,20 @@
           "when": "view == twitchHighlighterTreeView || view == twitchHighlighterTreeView-explorer || view == twitchHighlighterTreeView-debug",
           "group": "edit"
         }
+      ],
+      "editor/context": [
+        {
+          "command": "twitchHighlighter.context.unhighlight",
+          "group": "1_modification",
+          "when": "editorHasHighlights"
+        }
+      ],
+      "editor/title/context": [
+        {
+          "command": "twitchHighlighter.unhighlightAll",
+          "group": "3_open",
+          "when": "editorHasHighlights"
+        }
       ]
     },
     "viewsContainers": {

src/app.ts

@@ -1,7 +1,7 @@
 import * as vscode from 'vscode';
 
 import { HighlighterAPI, IHighlightRequested, IUnhighlightRequested, IUnhighlightAllRequested } from './api';
-import { Commands, LogLevel, Configuration, Settings } from './enums';
+import { Commands, LogLevel, Configuration, Settings, AppContexts } from './enums';
 import { Logger, log } from './logger';
 import {
   HighlightManager,
@@ -56,7 +56,9 @@ export class App implements vscode.Disposable {
 
       vscode.commands.registerCommand(Commands.requestHighlight, this.requestHighlightHandler, this),
       vscode.commands.registerCommand(Commands.requestUnhighlight, this.requestUnhighlightHandler, this),
-      vscode.commands.registerCommand(Commands.requestUnhighlightAll, this.requestUnhighlightAllHandler, this)
+      vscode.commands.registerCommand(Commands.requestUnhighlightAll, this.requestUnhighlightAllHandler, this),
+
+      vscode.commands.registerCommand(Commands.contextMenuUnhighlight, this.contextMenuUnhighlightHandler, this)
     );
 
     this.log('Initialized line highlighter.');
@@ -126,13 +128,31 @@ export class App implements vscode.Disposable {
     }
   }
 
+  /**
+   * Sets the 'editorHasHighlights' to true or false.
+   * The 'editorHasHighlights' context is used to determine if the
+   * 'Remove Highlight' and 'Remove All Highlights' context menu items
+   * are visible or not.
+   */
+  private setEditorHasHighlightsContext() {
+    if (vscode.window.activeTextEditor) {
+      const editor = vscode.window.activeTextEditor;
+      if (this._highlightManager.GetDecorations(editor.document.fileName).length > 0) {
+        vscode.commands.executeCommand('setContext', AppContexts.editorHasHighlights, true);
+      } else {
+        vscode.commands.executeCommand('setContext', AppContexts.editorHasHighlights, false);
+      }
+    }
+  }
+
   private onDidChangeActiveTextEditorHandler(editor?: vscode.TextEditor): void {
     if (editor) {
       this.currentDocument = editor.document;
     }
     else {
       this.currentDocument = undefined;
     }
+    this.setEditorHasHighlightsContext();
   }
 
   private refreshTreeviewHandler(): void {
@@ -154,6 +174,7 @@ export class App implements vscode.Disposable {
   }
 
   private refresh(): void {
+    this.setEditorHasHighlightsContext();
     vscode.window.visibleTextEditors.forEach(te => {
       te.setDecorations(
         this.highlightDecorationType,
@@ -293,4 +314,11 @@ export class App implements vscode.Disposable {
     this._highlightManager.Clear(service);
     this._onUnhighlightAllRequested.fire({service, callerId});
   }
+
+  private contextMenuUnhighlightHandler() {
+    if (vscode.window.activeTextEditor) {
+      const lineNumber = vscode.window.activeTextEditor.selection.active.line;
+      this._highlightManager.Remove(vscode.window.activeTextEditor.document, 'self', lineNumber + 1);
+    }
+  }
 }

src/enums/AppContexts.ts

@@ -0,0 +1,3 @@
+export enum AppContexts {
+  'editorHasHighlights' = 'editorHasHighlights'
+}

src/enums/Commands.ts

@@ -34,5 +34,6 @@ export enum Commands {
   'signIn' = 'twitchHighlighter.signIn',
   'signOut' = 'twitchHighlighter.signOut',
   'connect' = 'twitchHighlighter.connect',
-  'disconnect' = 'twitchHighlighter.disconnect'
+  'disconnect' = 'twitchHighlighter.disconnect',
+  'contextMenuUnhighlight' = 'twitchHighlighter.context.unhighlight'
 }

src/enums/index.ts

@@ -5,3 +5,4 @@ export * from './LogLevel';
 export * from './Configuration';
 export * from './KeytarKeys';
 export * from './TwitchKeys';
+export * from './AppContexts';

src/extension.ts

@@ -39,3 +39,7 @@ export function deactivate() {
   ttvchat.dispose();
   liveshare.dispose();
 }
+
+export const editorHasDecorations = () => {
+  return true;
+}

types/app.d.ts

@@ -17,6 +17,13 @@ export declare class App implements vscode.Disposable {
     private onDidChangeTextDocumentHandler;
     private onDidChangeConfigurationHandler;
     private onDidChangeVisibleTextEditorsHandler;
+    /**
+     * Sets the 'editorHasHighlights' to true or false.
+     * The 'editorHasHighlights' context is used to determine if the
+     * 'Remove Highlight' and 'Remove All Highlights' context menu items
+     * are visible or not.
+     */
+    private setEditorHasHighlightsContext;
     private onDidChangeActiveTextEditorHandler;
     private refreshTreeviewHandler;
     private createTextEditorDecorationType;
@@ -31,4 +38,5 @@ export declare class App implements vscode.Disposable {
     private requestHighlightHandler;
     private requestUnhighlightHandler;
     private requestUnhighlightAllHandler;
+    private contextMenuUnhighlightHandler;
 }

types/enums/Commands.d.ts

@@ -11,5 +11,6 @@ export declare enum Commands {
     'signIn' = "twitchHighlighter.signIn",
     'signOut' = "twitchHighlighter.signOut",
     'connect' = "twitchHighlighter.connect",
-    'disconnect' = "twitchHighlighter.disconnect"
+    'disconnect' = "twitchHighlighter.disconnect",
+    'contextMenuUnhighlight' = "twitchHighlighter.context.unhighlight"
 }

types/enums/index.d.ts

@@ -5,3 +5,4 @@ export * from './LogLevel';
 export * from './Configuration';
 export * from './KeytarKeys';
 export * from './TwitchKeys';
+export * from './AppContexts';

types/extension.d.ts

@@ -1,3 +1,4 @@
 import * as vscode from 'vscode';
 export declare function activate(context: vscode.ExtensionContext): import("./api").HighlighterAPI;
 export declare function deactivate(): void;
+export declare const editorHasDecorations: () => boolean;