Web API: registerCommand() (fix microsoft#90569)

Benjamin Pasero · Benjamin Pasero · commit c366e628032a · 2020-02-13T07:45:03.000+01:00
diff --git a/src/vs/workbench/browser/web.main.ts b/src/vs/workbench/browser/web.main.ts
@@ -93,20 +93,16 @@ class BrowserMain extends Disposable {
 
 		// Layout
 		const viewport = platform.isIOS && (<any>window).visualViewport ? (<any>window).visualViewport /** Visual viewport */ : window /** Layout viewport */;
-		this._register(addDisposableListener(viewport, EventType.RESIZE, () => {
-			workbench.layout();
-		}));
+		this._register(addDisposableListener(viewport, EventType.RESIZE, () => workbench.layout()));
 
 		// Prevent the back/forward gestures in macOS
-		this._register(addDisposableListener(this.domElement, EventType.WHEEL, (e) => {
-			e.preventDefault();
-		}, { passive: false }));
+		this._register(addDisposableListener(this.domElement, EventType.WHEEL, e => e.preventDefault(), { passive: false }));
 
 		// Prevent native context menus in web
-		this._register(addDisposableListener(this.domElement, EventType.CONTEXT_MENU, (e) => EventHelper.stop(e, true)));
+		this._register(addDisposableListener(this.domElement, EventType.CONTEXT_MENU, e => EventHelper.stop(e, true)));
 
 		// Prevent default navigation on drop
-		this._register(addDisposableListener(this.domElement, EventType.DROP, (e) => EventHelper.stop(e, true)));
+		this._register(addDisposableListener(this.domElement, EventType.DROP, e => EventHelper.stop(e, true)));
 
 		// Workbench Lifecycle
 		this._register(workbench.onBeforeShutdown(event => {
diff --git a/src/vs/workbench/workbench.web.api.ts b/src/vs/workbench/workbench.web.api.ts
@@ -16,6 +16,7 @@ import { IUpdateProvider, IUpdate } from 'vs/workbench/services/update/browser/u
 import { Event, Emitter } from 'vs/base/common/event';
 import { Disposable, IDisposable } from 'vs/base/common/lifecycle';
 import { IWorkspaceProvider, IWorkspace } from 'vs/workbench/services/host/browser/browserHostService';
+import { CommandsRegistry } from 'vs/platform/commands/common/commands';
 
 interface IResourceUriProvider {
 	(uri: URI): URI;
@@ -36,18 +37,23 @@ interface IExternalUriResolver {
 
 interface TunnelOptions {
 	remoteAddress: { port: number, host: string };
-	// The desired local port. If this port can't be used, then another will be chosen.
+	/**
+	 * The desired local port. If this port can't be used, then another will be chosen.
+	 */
 	localAddressPort?: number;
 	label?: string;
 }
 
-interface Tunnel {
+interface Tunnel extends IDisposable {
 	remoteAddress: { port: number, host: string };
-	//The complete local address(ex. localhost:1234)
+	/**
+	 * The complete local address(ex. localhost:1234)
+	 */
 	localAddress: string;
-	// Implementers of Tunnel should fire onDidDispose when dispose is called.
+	/**
+	 * Implementers of Tunnel should fire onDidDispose when dispose is called.
+	 */
 	onDidDispose: Event<void>;
-	dispose(): void;
 }
 
 interface ITunnelFactory {
@@ -186,14 +192,43 @@ interface IWorkbenchConstructionOptions {
 	readonly driver?: boolean;
 }
 
+interface ICommandHandler {
+	(...args: any[]): void;
+}
+
+interface IWorkbench {
+
+	/**
+	 * Register a command with the provided identifier and handler with
+	 * the workbench. The command can be called from extensions using the
+	 * `vscode.commands.executeCommand` API.
+	 */
+	registerCommand(id: string, command: ICommandHandler): IDisposable;
+}
+
 /**
  * Creates the workbench with the provided options in the provided container.
  *
  * @param domElement the container to create the workbench in
  * @param options for setting up the workbench
+ *
+ * @returns the workbench facade with additional methods to call on.
  */
-function create(domElement: HTMLElement, options: IWorkbenchConstructionOptions): Promise<void> {
-	return main(domElement, options);
+async function create(domElement: HTMLElement, options: IWorkbenchConstructionOptions): Promise<IWorkbench> {
+
+	// Startup workbench
+	await main(domElement, options);
+
+	// Return facade
+	return {
+		registerCommand: (id: string, command: ICommandHandler): IDisposable => {
+			return CommandsRegistry.registerCommand(id, (accessor, ...args: any[]) => {
+				// we currently only pass on the arguments but not the accessor
+				// to the command to reduce our exposure of internal API.
+				command(...args);
+			});
+		}
+	};
 }
 
 export {
@@ -202,6 +237,10 @@ export {
 	create,
 	IWorkbenchConstructionOptions,
 
+	// Workbench Facade
+	IWorkbench,
+	ICommandHandler,
+
 	// Basic Types
 	URI,
 	UriComponents,
