🎁 Add option to disable script hovers in package.json files (microsoft#156752)

babakks · web-flow · commit 215047080439 · 2022-08-01T09:43:31.000-07:00
* ⚙️ Define `npm.scriptHover` configuration parameter

Signed-off-by: Babak K. Shandiz &lt;babak.k.shandiz@gmail.com&gt;

* 🌐 Add localized description for `npm.scriptHover` config parameter

Signed-off-by: Babak K. Shandiz &lt;babak.k.shandiz@gmail.com&gt;

* 🎁 Respect `npm.scriptHover` config parameter in `NpmScriptHoverProvider`

Signed-off-by: Babak K. Shandiz &lt;babak.k.shandiz@gmail.com&gt;
diff --git a/extensions/npm/package.json b/extensions/npm/package.json
@@ -298,6 +298,12 @@
           "tags": [
             "usesOnlineServices"
           ]
+        },
+        "npm.scriptHover": {
+            "type": "boolean",
+            "description": "%config.npm.scriptHover%",
+            "default": true,
+            "scope": "window"
         }
       }
     },
diff --git a/extensions/npm/package.nls.json b/extensions/npm/package.nls.json
@@ -15,6 +15,7 @@
 	"config.npm.scriptExplorerExclude": "An array of regular expressions that indicate which scripts should be excluded from the NPM Scripts view.",
 	"config.npm.enableRunFromFolder": "Enable running npm scripts contained in a folder from the Explorer context menu.",
 	"config.npm.fetchOnlinePackageInfo": "Fetch data from https://registry.npmjs.org and https://registry.bower.io to provide auto-completion and information on hover features on npm dependencies.",
+	"config.npm.scriptHover": "Display hover with 'Run' and 'Debug' commands for scripts.",
 	"npm.parseError": "Npm task detection: failed to parse the file {0}",
 	"taskdef.script": "The npm script to customize.",
 	"taskdef.path": "The path to the folder of the package.json file that provides the script. Can be omitted.",
diff --git a/extensions/npm/src/scriptHover.ts b/extensions/npm/src/scriptHover.ts
@@ -33,16 +33,29 @@ export function invalidateHoverScriptsCache(document?: TextDocument) {
 }
 
 export class NpmScriptHoverProvider implements HoverProvider {
+	private enabled: boolean;
 
 	constructor(private context: ExtensionContext) {
 		context.subscriptions.push(commands.registerCommand('npm.runScriptFromHover', this.runScriptFromHover, this));
 		context.subscriptions.push(commands.registerCommand('npm.debugScriptFromHover', this.debugScriptFromHover, this));
 		context.subscriptions.push(workspace.onDidChangeTextDocument((e) => {
 			invalidateHoverScriptsCache(e.document);
 		}));
+
+		const isEnabled = () => workspace.getConfiguration('npm').get<boolean>('scriptHover', true);
+		this.enabled = isEnabled();
+		context.subscriptions.push(workspace.onDidChangeConfiguration((e) => {
+			if (e.affectsConfiguration('npm.scriptHover')) {
+				this.enabled = isEnabled();
+			}
+		}));
 	}
 
 	public provideHover(document: TextDocument, position: Position, _token: CancellationToken): ProviderResult<Hover> {
+		if (!this.enabled) {
+			return;
+		}
+
 		let hover: Hover | undefined = undefined;
 
 		if (!cachedDocument || cachedDocument.fsPath !== document.uri.fsPath) {

Original file line number	Diff line number	Diff line change
`@@ -298,6 +298,12 @@`
`298`	`298`	`"tags": [`
`299`	`299`	`"usesOnlineServices"`
`300`	`300`	`]`
	`301`	`+ },`
	`302`	`+ "npm.scriptHover": {`
	`303`	`+ "type": "boolean",`
	`304`	`+ "description": "%config.npm.scriptHover%",`
	`305`	`+ "default": true,`
	`306`	`+ "scope": "window"`
`301`	`307`	`}`
`302`	`308`	`}`
`303`	`309`	`},`