Skip to content

Commit d92edfb

Browse files
committed
Remove database panel icon commands from command palette
This corrects what is an unfortunately common accidental antipattern, where creating a command meant just to be the handler of a user interface button ends up in the command palette unless you explicitly set `"when": "false"` in the command palette section of the configuration. Also enforce the naming convention that commands prefixed with `codeQLDatabases.` are those meant for the databases panel only, while prefixing `codeQL.` means that it's meant to be directly accessible through the command palette.
1 parent 6fdfade commit d92edfb

File tree

2 files changed

+24
-12
lines changed

2 files changed

+24
-12
lines changed

extensions/ql-vscode/package.json

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@
2727
"onView:codeQLQueryHistory",
2828
"onView:test-explorer",
2929
"onCommand:codeQL.checkForUpdatesToCLI",
30-
"onCommand:codeQL.chooseDatabaseFolder",
31-
"onCommand:codeQL.chooseDatabaseArchive",
32-
"onCommand:codeQL.chooseDatabaseInternet",
30+
"onCommand:codeQLDatabases.chooseDatabaseFolder",
31+
"onCommand:codeQLDatabases.chooseDatabaseArchive",
32+
"onCommand:codeQLDatabases.chooseDatabaseInternet",
3333
"onCommand:codeQL.setCurrentDatabase",
3434
"onCommand:codeQL.downloadDatabase",
3535
"onCommand:codeQLDatabases.chooseDatabase",
@@ -175,23 +175,23 @@
175175
"title": "CodeQL: Quick Query"
176176
},
177177
{
178-
"command": "codeQL.chooseDatabaseFolder",
178+
"command": "codeQLDatabases.chooseDatabaseFolder",
179179
"title": "Choose Database from Folder",
180180
"icon": {
181181
"light": "media/light/folder-opened-plus.svg",
182182
"dark": "media/dark/folder-opened-plus.svg"
183183
}
184184
},
185185
{
186-
"command": "codeQL.chooseDatabaseArchive",
186+
"command": "codeQLDatabases.chooseDatabaseArchive",
187187
"title": "Choose Database from Archive",
188188
"icon": {
189189
"light": "media/light/archive-plus.svg",
190190
"dark": "media/dark/archive-plus.svg"
191191
}
192192
},
193193
{
194-
"command": "codeQL.chooseDatabaseInternet",
194+
"command": "codeQLDatabases.chooseDatabaseInternet",
195195
"title": "Download database",
196196
"icon": {
197197
"light": "media/light/cloud-download.svg",
@@ -312,17 +312,17 @@
312312
"group": "navigation"
313313
},
314314
{
315-
"command": "codeQL.chooseDatabaseFolder",
315+
"command": "codeQLDatabases.chooseDatabaseFolder",
316316
"when": "view == codeQLDatabases",
317317
"group": "navigation"
318318
},
319319
{
320-
"command": "codeQL.chooseDatabaseArchive",
320+
"command": "codeQLDatabases.chooseDatabaseArchive",
321321
"when": "view == codeQLDatabases",
322322
"group": "navigation"
323323
},
324324
{
325-
"command": "codeQL.chooseDatabaseInternet",
325+
"command": "codeQLDatabases.chooseDatabaseInternet",
326326
"when": "view == codeQLDatabases",
327327
"group": "navigation"
328328
}
@@ -442,6 +442,18 @@
442442
"command": "codeQLDatabases.removeDatabase",
443443
"when": "false"
444444
},
445+
{
446+
"command": "codeQLDatabases.chooseDatabaseFolder",
447+
"when": "false"
448+
},
449+
{
450+
"command": "codeQLDatabases.chooseDatabaseArchive",
451+
"when": "false"
452+
},
453+
{
454+
"command": "codeQLDatabases.chooseDatabaseInternet",
455+
"when": "false"
456+
},
445457
{
446458
"command": "codeQLQueryHistory.openQuery",
447459
"when": "false"

extensions/ql-vscode/src/databases-ui.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -174,9 +174,9 @@ export class DatabaseUI extends DisposableObject {
174174
this.treeDataProvider = this.push(new DatabaseTreeDataProvider(ctx, databaseManager));
175175
this.push(window.createTreeView('codeQLDatabases', { treeDataProvider: this.treeDataProvider }));
176176

177-
ctx.subscriptions.push(commands.registerCommand('codeQL.chooseDatabaseFolder', this.handleChooseDatabaseFolder));
178-
ctx.subscriptions.push(commands.registerCommand('codeQL.chooseDatabaseArchive', this.handleChooseDatabaseArchive));
179-
ctx.subscriptions.push(commands.registerCommand('codeQL.chooseDatabaseInternet', this.handleChooseDatabaseInternet));
177+
ctx.subscriptions.push(commands.registerCommand('codeQLDatabases.chooseDatabaseFolder', this.handleChooseDatabaseFolder));
178+
ctx.subscriptions.push(commands.registerCommand('codeQLDatabases.chooseDatabaseArchive', this.handleChooseDatabaseArchive));
179+
ctx.subscriptions.push(commands.registerCommand('codeQLDatabases.chooseDatabaseInternet', this.handleChooseDatabaseInternet));
180180
ctx.subscriptions.push(commands.registerCommand('codeQL.setCurrentDatabase', this.handleSetCurrentDatabase));
181181
ctx.subscriptions.push(commands.registerCommand('codeQL.upgradeCurrentDatabase', this.handleUpgradeCurrentDatabase));
182182
ctx.subscriptions.push(commands.registerCommand('codeQL.clearCache', this.handleClearCache));

0 commit comments

Comments
 (0)