Closes #3016 adds setting to control dismiss on ESC

Author: eamodio

CHANGELOG.md

@@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 
 ## [Unreleased]
 
+### Added
+
+- Adds a `gitlens.fileAnnotations.dismissOnEscape` setting to specify whether pressing the `ESC` key dismisses the active file annotations — closes [#3016](https://github.com/gitkraken/vscode-gitlens/issues/3016)
+
 ## [14.6.1] - 2023-12-14
 
 ### Fixed
@@ -98,7 +102,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
   - View Cloud Patches from URLs shared to you and apply them to your working tree or to a new or existing branch
   - Manage your Cloud Patches from the new _Cloud Patches_ view in the GitLens side bar
   - Adds a _Share as Cloud Patch..._ command to the command palette and to the _Share_ submenu in applicable GitLens views
-  - Adds a `gitlens.cloudPatches.enabled` setting to specificy whether to enable Cloud Patches (defaults to `true`)
+  - Adds a `gitlens.cloudPatches.enabled` setting to specify whether to enable Cloud Patches (defaults to `true`)
 - Adds support to open multiple instances of the _Commit Graph_, _Focus_, and _Visual File History_ in the editor area
   - Adds a _Split Commit Graph_ command to the _Commit Graph_ tab context menu
   - Adds a `gitlens.graph.allowMultiple` setting to specify whether to allow opening multiple instances of the _Commit Graph_ in the editor area

package.json

@@ -4401,6 +4401,13 @@
 						"scope": "window",
 						"order": 40
 					},
+					"gitlens.fileAnnotations.dismissOnEscape": {
+						"type": "boolean",
+						"default": true,
+						"markdownDescription": "Specifies whether pressing the `ESC` key dismisses the active file annotations",
+						"scope": "window",
+						"order": 45
+					},
 					"gitlens.fileAnnotations.command": {
 						"type": [
 							"string",
@@ -15299,7 +15306,7 @@
 			{
 				"command": "gitlens.key.escape",
 				"key": "escape",
-				"when": "gitlens:key:escape && editorTextFocus && !findWidgetVisible && !quickFixWidgetVisible && !renameInputVisible && !suggestWidgetVisible && !isInEmbeddedEditor"
+				"when": "gitlens:key:escape && editorTextFocus && !findWidgetVisible && !quickFixWidgetVisible && !renameInputVisible && !suggestWidgetVisible && !referenceSearchVisible && !codeActionMenuVisible && !parameterHintsVisible && !isInEmbeddedEditor"
 			},
 			{
 				"command": "gitlens.gitCommands",

src/annotations/fileAnnotationController.ts

@@ -111,6 +111,16 @@ export class FileAnnotationController implements Disposable {
 			this.updateDecorations(false);
 		}
 
+		if (configuration.changed(e, 'fileAnnotations.dismissOnEscape')) {
+			if (configuration.get('fileAnnotations.dismissOnEscape')) {
+				if (window.visibleTextEditors.some(e => this.getProvider(e))) {
+					void this.attachKeyboardHook();
+				}
+			} else {
+				void this.detachKeyboardHook();
+			}
+		}
+
 		let toggleMode;
 		if (configuration.changed(e, 'blame.toggleMode')) {
 			toggleMode = configuration.get('blame.toggleMode');
@@ -426,6 +436,8 @@ export class FileAnnotationController implements Disposable {
 	}
 
 	private async attachKeyboardHook() {
+		if (!configuration.get('fileAnnotations.dismissOnEscape')) return;
+
 		// Allows pressing escape to exit the annotations
 		if (this._keyboardScope == null) {
 			this._keyboardScope = await this.container.keyboard.beginScope({

src/config.ts

@@ -79,6 +79,7 @@ export interface Config {
 	};
 	readonly fileAnnotations: {
 		readonly command: string | null;
+		readonly dismissOnEscape: boolean;
 	};
 	readonly focus: {
 		readonly allowMultiple: boolean;