From 218b8bd8dac58991f13fe4784e7d542b93aec711 Mon Sep 17 00:00:00 2001 From: Ladislau Szomoru <3372902+lszomoru@users.noreply.github.com> Date: Fri, 14 Apr 2023 13:55:14 +0200 Subject: [PATCH] SCM - Add `document` property to expose the text document (#171504) --- extensions/vscode-api-tests/package.json | 1 + src/vs/workbench/api/browser/mainThreadSCM.ts | 6 +++-- .../workbench/api/common/extHost.api.impl.ts | 2 +- .../workbench/api/common/extHost.protocol.ts | 2 +- src/vs/workbench/api/common/extHostSCM.ts | 26 ++++++++++++++++--- .../contrib/scm/browser/scmViewPane.ts | 15 ++--------- src/vs/workbench/contrib/scm/common/scm.ts | 1 + .../common/extensionsApiProposals.ts | 1 + .../vscode.proposed.scmTextDocument.d.ts | 19 ++++++++++++++ 9 files changed, 52 insertions(+), 21 deletions(-) create mode 100644 src/vscode-dts/vscode.proposed.scmTextDocument.d.ts diff --git a/extensions/vscode-api-tests/package.json b/extensions/vscode-api-tests/package.json index 835214dbd88..94ba38957a5 100644 --- a/extensions/vscode-api-tests/package.json +++ b/extensions/vscode-api-tests/package.json @@ -27,6 +27,7 @@ "resolvers", "scmActionButton", "scmSelectedProvider", + "scmTextDocument", "scmValidation", "taskPresentationGroup", "terminalDataWriteEvent", diff --git a/src/vs/workbench/api/browser/mainThreadSCM.ts b/src/vs/workbench/api/browser/mainThreadSCM.ts index 9e744429ff5..8f7c4742fea 100644 --- a/src/vs/workbench/api/browser/mainThreadSCM.ts +++ b/src/vs/workbench/api/browser/mainThreadSCM.ts @@ -117,6 +117,7 @@ class MainThreadSCMProvider implements ISCMProvider, QuickDiffProvider { get handle(): number { return this._handle; } get label(): string { return this._label; } get rootUri(): URI | undefined { return this._rootUri; } + get inputBoxDocumentUri(): URI { return this._inputBoxDocumentUri; } get contextValue(): string { return this._contextValue; } get commitTemplate(): string { return this.features.commitTemplate || ''; } @@ -143,6 +144,7 @@ class MainThreadSCMProvider implements ISCMProvider, QuickDiffProvider { private readonly _contextValue: string, private readonly _label: string, private readonly _rootUri: URI | undefined, + private readonly _inputBoxDocumentUri: URI, private readonly _quickDiffService: IQuickDiffService ) { } @@ -317,8 +319,8 @@ export class MainThreadSCM implements MainThreadSCMShape { this._disposables.dispose(); } - $registerSourceControl(handle: number, id: string, label: string, rootUri: UriComponents | undefined): void { - const provider = new MainThreadSCMProvider(this._proxy, handle, id, label, rootUri ? URI.revive(rootUri) : undefined, this.quickDiffService); + $registerSourceControl(handle: number, id: string, label: string, rootUri: UriComponents | undefined, inputBoxDocumentUri: UriComponents): void { + const provider = new MainThreadSCMProvider(this._proxy, handle, id, label, rootUri ? URI.revive(rootUri) : undefined, URI.revive(inputBoxDocumentUri), this.quickDiffService); const repository = this.scmService.registerSCMProvider(provider); this._repositories.set(handle, repository); diff --git a/src/vs/workbench/api/common/extHost.api.impl.ts b/src/vs/workbench/api/common/extHost.api.impl.ts index 6b1dff49933..54037ceb504 100644 --- a/src/vs/workbench/api/common/extHost.api.impl.ts +++ b/src/vs/workbench/api/common/extHost.api.impl.ts @@ -180,7 +180,7 @@ export function createApiFactoryAndRegisterActors(accessor: ServicesAccessor): I const extHostFileSystem = rpcProtocol.set(ExtHostContext.ExtHostFileSystem, new ExtHostFileSystem(rpcProtocol, extHostLanguageFeatures)); const extHostFileSystemEvent = rpcProtocol.set(ExtHostContext.ExtHostFileSystemEventService, new ExtHostFileSystemEventService(rpcProtocol, extHostLogService, extHostDocumentsAndEditors)); const extHostQuickOpen = rpcProtocol.set(ExtHostContext.ExtHostQuickOpen, createExtHostQuickOpen(rpcProtocol, extHostWorkspace, extHostCommands)); - const extHostSCM = rpcProtocol.set(ExtHostContext.ExtHostSCM, new ExtHostSCM(rpcProtocol, extHostCommands, extHostLogService)); + const extHostSCM = rpcProtocol.set(ExtHostContext.ExtHostSCM, new ExtHostSCM(rpcProtocol, extHostCommands, extHostDocuments, extHostLogService)); const extHostQuickDiff = rpcProtocol.set(ExtHostContext.ExtHostQuickDiff, new ExtHostQuickDiff(rpcProtocol, uriTransformer)); const extHostComment = rpcProtocol.set(ExtHostContext.ExtHostComments, createExtHostComments(rpcProtocol, extHostCommands, extHostDocuments)); const extHostProgress = rpcProtocol.set(ExtHostContext.ExtHostProgress, new ExtHostProgress(rpcProtocol.getProxy(MainContext.MainThreadProgress))); diff --git a/src/vs/workbench/api/common/extHost.protocol.ts b/src/vs/workbench/api/common/extHost.protocol.ts index b7acb99d2c8..a1d238329d6 100644 --- a/src/vs/workbench/api/common/extHost.protocol.ts +++ b/src/vs/workbench/api/common/extHost.protocol.ts @@ -1283,7 +1283,7 @@ export type SCMRawResourceSplices = [ ]; export interface MainThreadSCMShape extends IDisposable { - $registerSourceControl(handle: number, id: string, label: string, rootUri: UriComponents | undefined): void; + $registerSourceControl(handle: number, id: string, label: string, rootUri: UriComponents | undefined, inputBoxDocumentUri: UriComponents): void; $updateSourceControl(handle: number, features: SCMProviderFeatures): void; $unregisterSourceControl(handle: number): void; diff --git a/src/vs/workbench/api/common/extHostSCM.ts b/src/vs/workbench/api/common/extHostSCM.ts index e19c8f8781f..0280e5f2855 100644 --- a/src/vs/workbench/api/common/extHostSCM.ts +++ b/src/vs/workbench/api/common/extHostSCM.ts @@ -22,6 +22,8 @@ import { ThemeIcon } from 'vs/base/common/themables'; import { IMarkdownString } from 'vs/base/common/htmlContent'; import { MarkdownString } from 'vs/workbench/api/common/extHostTypeConverters'; import { checkProposedApiEnabled, isProposedApiEnabled } from 'vs/workbench/services/extensions/common/extensions'; +import { ExtHostDocuments } from 'vs/workbench/api/common/extHostDocuments'; +import { Schemas } from 'vs/base/common/network'; type ProviderHandle = number; type GroupHandle = number; @@ -200,6 +202,7 @@ export interface IValidateInput { export class ExtHostSCMInputBox implements vscode.SourceControlInputBox { #proxy: MainThreadSCMShape; + #extHostDocuments: ExtHostDocuments; private _value: string = ''; @@ -283,7 +286,14 @@ export class ExtHostSCMInputBox implements vscode.SourceControlInputBox { this.#proxy.$setInputBoxVisibility(this._sourceControlHandle, visible); } - constructor(private _extension: IExtensionDescription, proxy: MainThreadSCMShape, private _sourceControlHandle: number) { + get document(): vscode.TextDocument { + checkProposedApiEnabled(this._extension, 'scmTextDocument'); + + return this.#extHostDocuments.getDocument(this._documentUri); + } + + constructor(private _extension: IExtensionDescription, _extHostDocuments: ExtHostDocuments, proxy: MainThreadSCMShape, private _sourceControlHandle: number, private _documentUri: URI) { + this.#extHostDocuments = _extHostDocuments; this.#proxy = proxy; } @@ -584,6 +594,7 @@ class ExtHostSourceControl implements vscode.SourceControl { constructor( private readonly _extension: IExtensionDescription, + _extHostDocuments: ExtHostDocuments, proxy: MainThreadSCMShape, private _commands: ExtHostCommands, private _id: string, @@ -592,8 +603,14 @@ class ExtHostSourceControl implements vscode.SourceControl { ) { this.#proxy = proxy; - this._inputBox = new ExtHostSCMInputBox(_extension, this.#proxy, this.handle); - this.#proxy.$registerSourceControl(this.handle, _id, _label, _rootUri); + const inputBoxDocumentUri = URI.from({ + scheme: Schemas.vscodeSourceControl, + path: `${_id}/scm${this.handle}/input`, + query: _rootUri ? `rootUri=${encodeURIComponent(_rootUri.toString())}` : undefined + }); + + this._inputBox = new ExtHostSCMInputBox(_extension, _extHostDocuments, this.#proxy, this.handle, inputBoxDocumentUri); + this.#proxy.$registerSourceControl(this.handle, _id, _label, _rootUri, inputBoxDocumentUri); } private createdResourceGroups = new Map(); @@ -699,6 +716,7 @@ export class ExtHostSCM implements ExtHostSCMShape { constructor( mainContext: IMainContext, private _commands: ExtHostCommands, + private _extHostDocuments: ExtHostDocuments, @ILogService private readonly logService: ILogService ) { this._proxy = mainContext.getProxy(MainContext.MainThreadSCM); @@ -757,7 +775,7 @@ export class ExtHostSCM implements ExtHostSCMShape { }); const handle = ExtHostSCM._handlePool++; - const sourceControl = new ExtHostSourceControl(extension, this._proxy, this._commands, id, label, rootUri); + const sourceControl = new ExtHostSourceControl(extension, this._extHostDocuments, this._proxy, this._commands, id, label, rootUri); this._sourceControls.set(handle, sourceControl); const sourceControls = this._sourceControlsByExtension.get(extension.identifier) || []; diff --git a/src/vs/workbench/contrib/scm/browser/scmViewPane.ts b/src/vs/workbench/contrib/scm/browser/scmViewPane.ts index 12cc5ea9be1..274aefe4cf4 100644 --- a/src/vs/workbench/contrib/scm/browser/scmViewPane.ts +++ b/src/vs/workbench/contrib/scm/browser/scmViewPane.ts @@ -57,7 +57,6 @@ import * as platform from 'vs/base/common/platform'; import { compare, format } from 'vs/base/common/strings'; import { SuggestController } from 'vs/editor/contrib/suggest/browser/suggestController'; import { SnippetController2 } from 'vs/editor/contrib/snippet/browser/snippetController2'; -import { Schemas } from 'vs/base/common/network'; import { ServiceCollection } from 'vs/platform/instantiation/common/serviceCollection'; import { ModesHoverController } from 'vs/editor/contrib/hover/browser/hover'; import { ColorDetector } from 'vs/editor/contrib/colorPicker/browser/colorDetector'; @@ -92,6 +91,7 @@ import { defaultButtonStyles, defaultCountBadgeStyles } from 'vs/platform/theme/ import { GhostTextController } from 'vs/editor/contrib/inlineCompletions/browser/ghostTextController'; import { CodeActionController } from 'vs/editor/contrib/codeAction/browser/codeActionController'; import { IResolvedTextEditorModel, ITextModelContentProvider, ITextModelService } from 'vs/editor/common/services/resolverService'; +import { Schemas } from 'vs/base/common/network'; type TreeElement = ISCMRepository | ISCMInput | ISCMActionButton | ISCMResourceGroup | IResourceNode | ISCMResource; @@ -1763,18 +1763,7 @@ class SCMInputWidget { return; } - let query: string | undefined; - - if (input.repository.provider.rootUri) { - query = `rootUri=${encodeURIComponent(input.repository.provider.rootUri.toString())}`; - } - - const uri = URI.from({ - scheme: Schemas.vscodeSourceControl, - path: `${input.repository.provider.contextValue}/${input.repository.provider.id}/input`, - query - }); - + const uri = input.repository.provider.inputBoxDocumentUri; if (this.configurationService.getValue('editor.wordBasedSuggestions', { resource: uri }) !== false) { this.configurationService.updateValue('editor.wordBasedSuggestions', false, { resource: uri }, ConfigurationTarget.MEMORY); } diff --git a/src/vs/workbench/contrib/scm/common/scm.ts b/src/vs/workbench/contrib/scm/common/scm.ts index 6c405998a2c..4c4c3cc3729 100644 --- a/src/vs/workbench/contrib/scm/common/scm.ts +++ b/src/vs/workbench/contrib/scm/common/scm.ts @@ -60,6 +60,7 @@ export interface ISCMProvider extends IDisposable { readonly onDidChangeResources: Event; readonly rootUri?: URI; + readonly inputBoxDocumentUri: URI; readonly count?: number; readonly commitTemplate: string; readonly onDidChangeCommitTemplate: Event; diff --git a/src/vs/workbench/services/extensions/common/extensionsApiProposals.ts b/src/vs/workbench/services/extensions/common/extensionsApiProposals.ts index c7422d3e8cb..888c6c4c689 100644 --- a/src/vs/workbench/services/extensions/common/extensionsApiProposals.ts +++ b/src/vs/workbench/services/extensions/common/extensionsApiProposals.ts @@ -62,6 +62,7 @@ export const allApiProposals = Object.freeze({ resolvers: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.resolvers.d.ts', 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', + scmTextDocument: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.scmTextDocument.d.ts', scmValidation: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.scmValidation.d.ts', semanticSimilarity: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.semanticSimilarity.d.ts', showLocal: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.showLocal.d.ts', diff --git a/src/vscode-dts/vscode.proposed.scmTextDocument.d.ts b/src/vscode-dts/vscode.proposed.scmTextDocument.d.ts new file mode 100644 index 00000000000..8533c039a3f --- /dev/null +++ b/src/vscode-dts/vscode.proposed.scmTextDocument.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. + *--------------------------------------------------------------------------------------------*/ + +declare module 'vscode' { + // https://github.com/microsoft/vscode/issues/166615 + + /** + * Represents the input box in the Source Control viewlet. + */ + export interface SourceControlInputBox { + + /** + * The {@link TextDocument text} of the input box. + */ + readonly document: TextDocument; + } +}