Alexr00/showLocalAPI (microsoft#173798)

* Propose "allowLocal" open dialog option API Part of microsoft#131138 * Update comment * allowUIResources API proposal Part of microsoft#131138 * Fix scheme ordering and update doc comment
mwadams · Feb 9, 2023 · 89c4f61 · 89c4f61
1 parent 7f48e7c
commit 89c4f61
Show file tree

Hide file tree

Showing 7 changed files with 31 additions and 4 deletions.
diff --git a/.eslintplugin/vscode-dts-interface-naming.ts b/.eslintplugin/vscode-dts-interface-naming.ts
@@ -8,7 +8,7 @@ import { TSESTree } from '@typescript-eslint/experimental-utils';
 
 export = new class ApiInterfaceNaming implements eslint.Rule.RuleModule {
 
-	private static _nameRegExp = /I[A-Z]/;
+	private static _nameRegExp = /^I[A-Z]/;
 
 	readonly meta: eslint.Rule.RuleMetaData = {
 		messages: {

diff --git a/src/vs/workbench/api/browser/mainThreadDialogs.ts b/src/vs/workbench/api/browser/mainThreadDialogs.ts
@@ -7,6 +7,7 @@ import { URI } from 'vs/base/common/uri';
 import { MainThreadDiaglogsShape, MainContext, MainThreadDialogOpenOptions, MainThreadDialogSaveOptions } from '../common/extHost.protocol';
 import { extHostNamedCustomer, IExtHostContext } from 'vs/workbench/services/extensions/common/extHostCustomers';
 import { IFileDialogService, IOpenDialogOptions, ISaveDialogOptions } from 'vs/platform/dialogs/common/dialogs';
+import { Schemas } from 'vs/base/common/network';
 
 @extHostNamedCustomer(MainContext.MainThreadDialogs)
 export class MainThreadDialogs implements MainThreadDiaglogsShape {
@@ -46,7 +47,7 @@ export class MainThreadDialogs implements MainThreadDiaglogsShape {
 			canSelectMany: options?.canSelectMany,
 			defaultUri: options?.defaultUri ? URI.revive(options.defaultUri) : undefined,
 			title: options?.title || undefined,
-			availableFileSystems: []
+			availableFileSystems: options?.allowUIResources ? [Schemas.vscodeRemote, Schemas.file] : []
 		};
 		if (options?.filters) {
 			result.filters = [];

diff --git a/src/vs/workbench/api/common/extHost.api.impl.ts b/src/vs/workbench/api/common/extHost.api.impl.ts
@@ -679,7 +679,7 @@ export function createApiFactoryAndRegisterActors(accessor: ServicesAccessor): I
 				return extHostQuickOpen.showInput(options, token);
 			},
 			showOpenDialog(options) {
-				return extHostDialogs.showOpenDialog(options);
+				return extHostDialogs.showOpenDialog(extension, options);
 			},
 			showSaveDialog(options) {
 				return extHostDialogs.showSaveDialog(options);

diff --git a/src/vs/workbench/api/common/extHost.protocol.ts b/src/vs/workbench/api/common/extHost.protocol.ts
@@ -174,6 +174,7 @@ export interface MainThreadDialogOpenOptions {
 	canSelectMany?: boolean;
 	filters?: { [name: string]: string[] };
 	title?: string;
+	allowUIResources?: boolean;
 }
 
 export interface MainThreadDialogSaveOptions {

diff --git a/src/vs/workbench/api/common/extHostDialogs.ts b/src/vs/workbench/api/common/extHostDialogs.ts
@@ -6,6 +6,8 @@
 import type * as vscode from 'vscode';
 import { URI } from 'vs/base/common/uri';
 import { MainContext, MainThreadDiaglogsShape, IMainContext } from 'vs/workbench/api/common/extHost.protocol';
+import { checkProposedApiEnabled } from 'vs/workbench/services/extensions/common/extensions';
+import { IRelaxedExtensionDescription } from 'vs/platform/extensions/common/extensions';
 
 export class ExtHostDialogs {
 
@@ -15,7 +17,10 @@ export class ExtHostDialogs {
 		this._proxy = mainContext.getProxy(MainContext.MainThreadDialogs);
 	}
 
-	showOpenDialog(options?: vscode.OpenDialogOptions): Promise<URI[] | undefined> {
+	showOpenDialog(extension: IRelaxedExtensionDescription, options?: vscode.OpenDialogOptions): Promise<URI[] | undefined> {
+		if (options?.allowUIResources) {
+			checkProposedApiEnabled(extension, 'showLocal');
+		}
 		return this._proxy.$showOpenDialog(options).then(filepaths => {
 			return filepaths ? filepaths.map(p => URI.revive(p)) : undefined;
 		});

diff --git a/src/vs/workbench/services/extensions/common/extensionsApiProposals.ts b/src/vs/workbench/services/extensions/common/extensionsApiProposals.ts
@@ -56,6 +56,7 @@ export const allApiProposals = Object.freeze({
 	scmActionButton: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.scmActionButton.d.ts',
 	scmSelectedProvider: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.scmSelectedProvider.d.ts',
 	scmValidation: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.scmValidation.d.ts',
+	showLocal: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.showLocal.d.ts',
 	tabInputTextMerge: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.tabInputTextMerge.d.ts',
 	taskPresentationGroup: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.taskPresentationGroup.d.ts',
 	telemetry: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.telemetry.d.ts',

diff --git a/src/vscode-dts/vscode.proposed.showLocal.d.ts b/src/vscode-dts/vscode.proposed.showLocal.d.ts
@@ -0,0 +1,19 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+// https://github.com/microsoft/vscode/issues/131138
+
+declare module 'vscode' {
+
+	export interface OpenDialogOptions {
+		/**
+		 * Controls whether the dialog allows users to select local files via the "Show Local" button.
+		 * Extensions that set this to `true` should check the scheme of the selected file.
+		 * Resources with the `file` scheme come from the same extension host as the extension.
+		 * Resources with the `vscode-local` scheme come from an extension host running in the same place as the UI.
+		 */
+		allowUIResources?: boolean;
+	}
+}