Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
connor4312 merged 3 commits into from
Aug 1, 2022
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
182c0f0
⚙️ Define `npm.scriptHover` configuration parameter
babakks Jul 31, 2022
feec578
🌐 Add localized description for `npm.scriptHover` config parameter
babakks Jul 31, 2022
899486a
🎁 Respect `npm.scriptHover` config parameter in `NpmScriptHoverProvider`
babakks Jul 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions extensions/npm/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,6 +298,12 @@
"tags": [
"usesOnlineServices"
]
},
"npm.scriptHover": {
"type": "boolean",
"description": "%config.npm.scriptHover%",
"default": true,
"scope": "window"
}
}
},
Expand Down
1 change: 1 addition & 0 deletions extensions/npm/package.nls.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.",
Expand Down
13 changes: 13 additions & 0 deletions extensions/npm/src/scriptHover.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down