#28617 - implemented according to comments in PR #28952

cristianhosu · 2017-06-18T07:20:06Z

No description provided.

mention-bot · 2017-06-18T07:20:08Z

@cristianhosu, thanks for your PR! By analyzing the history of the files in this pull request, we identified @jrieken and @bpasero to be potential reviewers.

jrieken · 2017-06-19T07:52:11Z

Why should that be a command and not proper API?

cristianhosu · 2017-06-19T07:58:33Z

@bpasero gave an example on how this should be done on the previous pull request. I have deleted that one since my fork got messed up and had to clean/pull from upstream.
The example given was for _workbench.open

bpasero

Some feedback provided.

As for the name of the command, not sure if @jrieken has objections with vscode.quickOpen. For a user I think the difference between the picker (e.g. showQuickPick) and our quick open thing is not so obvious. For a user it will always be the picker.

Alternatively we could introduce real API like showQuickPick(prefix: string) that will bring up quick open with the prefix. That might be easier to understand.

bpasero · 2017-06-19T10:39:19Z

src/vs/workbench/api/node/extHostApiCommands.ts

@@ -239,6 +240,16 @@ export class ExtHostApiCommands {
 					{ name: 'column', description: '(optional) Column in which to open', constraint: v => v === void 0 || typeof v === 'number' }
 				]
 			});
+
+		this._register('vscode.quickOpen', (prefix: string, showOptions: IShowOptions) => {


I am not sure about exposing IShowOptions to extensions, I would not do this until we hear otherwise.

bpasero · 2017-06-19T10:40:02Z

src/vs/workbench/browser/parts/quickopen/quickopen.ts

 		super(id, label);

 		this.order = 100; // Allow other actions to position before or after
 		this.class = 'quickopen';
 	}

-	public run(): TPromise<any> {
-		this.quickOpenService.show(null);
+	public run(prefix?: string, showOptions?: IShowOptions): TPromise<any> {


I think we can remove prefix and showOptions from this action right? We are not using these arguments anywhere. The extension is using the command.

bpasero · 2017-06-19T10:40:16Z

src/vs/workbench/electron-browser/commands.ts

@@ -422,4 +423,13 @@ export function registerCommands(): void {
 			return void 0;
 		});
 	});
+
+	CommandsRegistry.registerCommand('_workbench.quickOpen', function (accessor: ServicesAccessor, args: [string, IShowOptions]) {
+		const quickOpenService = accessor.get(IQuickOpenService);


Remove IShowOptions

jrieken · 2017-06-19T13:49:23Z

As for the name of the command, not sure if @jrieken has objections with vscode.quickOpen. For a user I think the difference between the picker (e.g. showQuickPick) and our quick open thing is not so obvious. For a user it will always be the picker.

Unsure, about overloading showQuickPick because today it allows you to pick an item from a list of items. We won't be able to do that with the prefix. I do have a bunch of requests to make the quick-pick API and richer and prefixed-picks are part of that but these feature requests sit behind a pile a debt that needs to be removed first.

What I don't understand is why another command (vscode.quickOpen) is introduced at all. There is already workbench.action.quickOpen which is no more or less API then such a command would be. Introducing another command seems confusing and like boiler plate code. IMO the right thing to do here is making the workbench.action.quickOpen-command accept an argument

bpasero · 2017-06-19T14:02:09Z

@jrieken yes I like that. is every command we register on the workbench side automatically available from extensions?

@cristianhosu can we introduce a command with the same ID as the action and use that from the action?

jrieken · 2017-06-19T14:46:46Z

is every command we register on the workbench side automatically available from extensions?

Yes, every command is everywhere. By convention commands starting with an underscore are internal and shouldn't be used.

cristianhosu · 2017-06-19T15:02:54Z

can we introduce a command with the same ID as the action and use that from the action?

I don't think so. i believe that the shortcut will look into both actions and commands and search for one with the given name, thus it might be error prone to have the same name. We could however remove the action altogether and leave only the action so to reduce the ambiguity.

What I don't understand is why another command (vscode.quickOpen) is introduced at all. There is already workbench.action.quickOpen which is no more or less API then such a command would be. Introducing another command seems confusing and like boiler plate code. IMO the right thing to do here is making the workbench.action.quickOpen-command accept an argument

Initially that's how it was made, but maybe a command is easier to migrate to an actual API if needed in the future (I'm just guessing).
But we could as I mentioned remove the action.
Either way... Whatever you guys decide, I'll do it :)

bpasero · 2017-06-19T16:31:56Z

Yes, replacing the action with a command sounds good to me. As long as the action still shows up in the command palette.

cristianhosu · 2017-06-19T19:46:01Z

Now, the command executes the show method from the service. The same one that gets executed from the action. The command has _ because it is executed by an API command vscode.quickOpen. I would change all the current bindings of the action to execute the command instead and leave the action as is so that if anyone has a keybinding to this action to not disrupt it. If you meant something else by your comment, please give more details as I did not quite understand. Also i've made the requested changes.

bpasero · 2017-06-20T06:30:58Z

Thanks, I will have a look.

jrieken · 2017-06-20T07:34:01Z

src/vs/workbench/browser/parts/quickopen/quickopen.ts

 		super(id, label);

 		this.order = 100; // Allow other actions to position before or after
 		this.class = 'quickopen';
 	}

 	public run(): TPromise<any> {
-		this.quickOpenService.show(null);
+		this.commandService.executeCommand('vscode.quickOpen');


This is madness. Don't add a new command, replace the action with a command having the same id, register the command to the command palette. Don't add an API command

I don't really think this is madness per se, but okay. I see what you mean. It's not okay to have both a command and an action that do the same thing. But for my piece of mind and since I've just started working on VS Code, can you please detail what;s the difference between an API command, a command and an action? what are they each used for?

Sorry for being harsh. There is a world of debt and basically an action is a command with extras. A command is basically just a function with an identifier. Then we use that identifier to bind command execution to a user gesture, e.g. bind a keybinding to an identifier or bind a UI-botton to an identifier. These UI gestures basically all call executeCommand with their assigned id. That is why running exec-command from within an action is a double loop (the run is already the result of calling exec-command).

A simple sample of registering a command (id to function) and a menu item (button to id) can be found here: https://github.com/Microsoft/vscode/blob/master/src/vs/workbench/parts/html/browser/webview.ts#L28. Not shown in that sample, but commands have access to all services via the first argument passed to them.

So, my recommendation is to turn the GlobalQuickOpenCommand into a namespace which export (as const) the ID. That is because others use the ID and you wanna keep things simple. Then inside the namespace you can just do the registration and things should just work. Let me know if there something I can help out with

cristianhosu · 2017-06-20T19:27:56Z

@jrieken I've pushed another commit.
Now that I've also seen the code it kinda makes more sense. Hopefully I understood correctly :)
Wouldn't it be a good idea to modify most, if not all, of the commands from commands.ts to isolate them into their own namespace?

bpasero · 2017-06-21T04:22:56Z

src/vs/workbench/electron-browser/commands.ts

@@ -423,3 +424,16 @@ export function registerCommands(): void {
 		});
 	});
 }
+
+namespace GlobalQuickOpenCommand {
+	export const ID = 'vscode.quickOpen';


@cristianhosu shouldn't this be the same ID as the action we already have and not introduce a new command ID? And the action we had so far should use this command too.

In a previous comment, @jrieken commented on the exact line that i've modified in the action to call the command instead of the service.

These UI gestures basically all call executeCommand with their assigned id. That is why running exec-command from within an action is a double loop (the run is already the result of calling exec-command)

I'll try using the same ID and see if it works, but it could just execute both the command and the action, or maybe have a conflict between them, or randomly execute either the action or the command. I'll investigate this and come back with an actual response instead of an assumption.

Also the ID of the action is workbench.action.quickOpen and now it is implemented as a command instead of an action. Wouldn't this name induce confusion?

Edit: with the name changed the command is executed instead of the action. So maybe we could remove the action altogether?

Yes, that's what I meant. Nuke the action, the ID is now slight misleading but we don't wanna break existing keybinding customisations.

Merge upstream master to local master

cristianhosu · 2017-06-26T07:43:35Z

@jrieken : So much win! Thank you

…

On Mon, Jun 26, 2017 at 9:18 AM, Johannes Rieken ***@***.***> wrote: ***@***.**** approved this pull request. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#28952 (review)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AQ3E7vCu-CRICTcxpGtp7NZ7CI838yRDks5sH01RgaJpZM4N9bUu> .

-- Cristian Hosu +40740.058.711

bpasero · 2017-06-26T12:04:39Z

@cristianhosu what is the motivation of the change in watermark.ts?

bpasero · 2017-06-26T16:25:02Z

src/vs/workbench/parts/watermark/electron-browser/watermark.ts

@@ -18,7 +18,6 @@ import { IWorkspaceContextService } from 'vs/platform/workspace/common/workspace
 import { IWorkbenchContribution, IWorkbenchContributionsRegistry, Extensions as WorkbenchExtensions } from 'vs/workbench/common/contributions';


Please do not change watermark.ts

It had a reference to the Action. As I removed the action, this had to be removed as well

bpasero · 2017-06-26T16:25:11Z

src/vs/workbench/parts/terminal/electron-browser/terminal.contribution.ts

@@ -12,7 +12,6 @@ import * as nls from 'vs/nls';
 import * as panel from 'vs/workbench/browser/panel';
 import * as platform from 'vs/base/common/platform';
 import { Extensions, IConfigurationRegistry } from 'vs/platform/configuration/common/configurationRegistry';
-import { GlobalQuickOpenAction } from 'vs/workbench/browser/parts/quickopen/quickopen';


Please do not remove this.

It had a reference to the Action. As I removed the action, this had to be removed as well

bpasero · 2017-06-26T16:25:40Z

src/vs/workbench/electron-browser/commands.ts

@@ -423,3 +424,24 @@ export function registerCommands(): void {
 		});
 	});
 }
+
+namespace GlobalQuickOpenCommand {


@cristianhosu while this adds the command, it no longer shows up in the F1 command palette. @jrieken didn't we add support to contribute commands to the F1 list recently?

If there is support for this, i'll add it to F1

@cristianhosu looks like currently we are not using this explicitly but this test shows how to add a command to the F1 list: https://github.com/Microsoft/vscode/blob/master/src/vs/platform/actions/test/common/menuService.test.ts#L192

Can you add this?

bpasero · 2017-06-26T16:26:50Z

src/vs/workbench/electron-browser/commands.ts

@@ -423,3 +424,24 @@ export function registerCommands(): void {
 		});
 	});
 }
+


I think you can remove the namespace GlobalQuickOpenCommand here, not sure why we would want it.

@jrieken please validate this with @bpasero

@bpasero that makes this change smaller because GlobalQuickOpenCommand.ID is used here and there

cristianhosu · 2017-06-28T18:13:02Z

Of course. Are there any other changes that should be made? For the watermark file for example? Maybe somehow using the command instead of the action?

…

On Jun 28, 2017 5:59 PM, "Benjamin Pasero" ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In src/vs/workbench/electron-browser/commands.ts <#28952 (comment)>: > @@ -423,3 +424,24 @@ export function registerCommands(): void { }); }); } + +namespace GlobalQuickOpenCommand { @cristianhosu <https://github.com/cristianhosu> looks like currently we are not using this explicitly but this test shows how to add a command to the F1 list: https://github.com/Microsoft/vscode/blob/master/src/vs/ platform/actions/test/common/menuService.test.ts#L192 Can you add this? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#28952 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AQ3E7t7FpvcbK8V50WgS3gcGYthx-jaGks5sImpIgaJpZM4N9bUu> .

bpasero · 2017-06-29T04:17:08Z

@cristianhosu yes, instead of removing the references to the now deleted action, you should export the ID of your new command and use that instead.

- added command to watermark

cristianhosu · 2017-07-07T04:41:54Z

I don't know why the build is failing... can you guys help me out?

bpasero · 2017-07-07T04:51:02Z

@cristianhosu looks like an unrelated test failure that also happens on our master. let me know when you are ready for another review.

cristianhosu · 2017-07-07T06:18:24Z

Since the build failure is unrelated to my commit, then I think I am ready :)

…

On Jul 7, 2017 07:51, "Benjamin Pasero" ***@***.***> wrote: @cristianhosu <https://github.com/cristianhosu> looks like an unrelated test failure that also happens on our master. let me know when you are ready for another review. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#28952 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AQ3E7hM1YR30cT070n1HqleQzDYygeUnks5sLblOgaJpZM4N9bUu> .

bpasero · 2017-07-07T09:23:57Z

@cristianhosu thanks, I was not able to use your PR directly because of some changes still needed. I went ahead and pushed 0095617 on top of your work. Will make sure to mention you and this PR in our July release notes.

microsoft#28617 - implemented according to comments in PR

77751c9

msftclas added the cla-already-signed label Jun 18, 2017

ramya-rao-a assigned jrieken Jun 19, 2017

jrieken assigned bpasero and unassigned jrieken Jun 19, 2017

bpasero added this to the June 2017 milestone Jun 19, 2017

bpasero requested changes Jun 19, 2017

View reviewed changes

microsoft#28617 - changed according to PR 28952

c2134a2

bpasero modified the milestones: July 2017, June 2017, On Deck Jun 20, 2017

jrieken requested changes Jun 20, 2017

View reviewed changes

microsoft#28617 - modified according to PR comments

2cd6f12

bpasero requested changes Jun 21, 2017

View reviewed changes

cristianhosu added 4 commits June 23, 2017 08:25

microsoft#28617 - removed references to quick open action

7c5078e

merge monaco.d.ts

ebd7bb0

Merge remote-tracking branch 'upstream/master'

10ff9cb

Merge upstream master to local master

Merge from upstream/master

cd6c611

cristianhosu added 7 commits June 23, 2017 23:00

merge from upstream

b2d9137

Merge branch 'master' into microsoft#28617

1e98f71

fixed merge duplication

c1626a7

Merge remote-tracking branch 'upstream/master'

be27e6b

merge

0f20e2e

Merge branch 'microsoft#28617'

f16860f

Merge branch 'master' into microsoft#28617

02d5a9d

bpasero modified the milestones: Backlog, On Deck Jun 26, 2017

jrieken approved these changes Jun 26, 2017

View reviewed changes

bpasero requested changes Jun 26, 2017

View reviewed changes

bpasero modified the milestones: On Deck, Backlog Jun 27, 2017

cristianhosu added 3 commits July 7, 2017 06:47

microsoft#28617 - added command to menu registry

ee650e6

- added command to watermark

microsoft#28617

ce7b823

Merge branch 'master' into microsoft#28617

244df43

bpasero closed this Jul 7, 2017

bpasero modified the milestones: July 2017, On Deck Jul 7, 2017

github-actions bot locked and limited conversation to collaborators Mar 27, 2020

		@@ -18,7 +18,6 @@ import { IWorkspaceContextService } from 'vs/platform/workspace/common/workspace
		import { IWorkbenchContribution, IWorkbenchContributionsRegistry, Extensions as WorkbenchExtensions } from 'vs/workbench/common/contributions';

@@ @@ -423,3 +424,24 @@ export function registerCommands(): void { @@
               		});
               	});
               }

#28617 - implemented according to comments in PR #28952

#28617 - implemented according to comments in PR #28952

Conversation

cristianhosu commented Jun 18, 2017

mention-bot commented Jun 18, 2017

jrieken commented Jun 19, 2017

cristianhosu commented Jun 19, 2017

bpasero left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jrieken commented Jun 19, 2017

bpasero commented Jun 19, 2017

jrieken commented Jun 19, 2017 • edited Loading

cristianhosu commented Jun 19, 2017

bpasero commented Jun 19, 2017

cristianhosu commented Jun 19, 2017 via email • edited Loading

bpasero commented Jun 20, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jrieken Jun 20, 2017 • edited Loading

Choose a reason for hiding this comment

cristianhosu commented Jun 20, 2017

Choose a reason for hiding this comment

cristianhosu Jun 21, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cristianhosu commented Jun 26, 2017 via email

bpasero commented Jun 26, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cristianhosu commented Jun 28, 2017 via email

bpasero commented Jun 29, 2017

cristianhosu commented Jul 7, 2017

bpasero commented Jul 7, 2017

cristianhosu commented Jul 7, 2017 via email

bpasero commented Jul 7, 2017

jrieken commented Jun 19, 2017 •

edited

Loading

cristianhosu commented Jun 19, 2017 via email •

edited

Loading

jrieken Jun 20, 2017 •

edited

Loading

cristianhosu Jun 21, 2017 •

edited

Loading