Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Stub registerMappedEditProvider #13681

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions packages/plugin-ext/src/plugin/plugin-context.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1218,9 +1218,17 @@ export function createAPIFactory(
}
};

const chat: typeof theia.chat = {
/** @stubbed MappedEditsProvider */
registerMappedEditsProvider(documentSelector: theia.DocumentSelector, provider: theia.MappedEditsProvider): Disposable {
return Disposable.NULL;
}
};

return <typeof theia>{
version: require('../../package.json').version,
authentication,
chat,
commands,
comments,
window,
Expand Down
1 change: 1 addition & 0 deletions packages/plugin/src/theia.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ import './theia.proposed.dropMetadata';
import './theia.proposed.editSessionIdentityProvider';
import './theia.proposed.extensionsAny';
import './theia.proposed.externalUriOpener';
import './theia.proposed.mappedEditsProvider';
import './theia.proposed.notebookCellExecutionState';
import './theia.proposed.notebookKernelSource';
import './theia.proposed.notebookMessaging';
Expand Down
59 changes: 59 additions & 0 deletions packages/plugin/src/theia.proposed.mappedEditsProvider.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
// *****************************************************************************
// Copyright (C) 2024 STMicroelectronics and others.
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License v. 2.0 which is available at
// http://www.eclipse.org/legal/epl-2.0.
//
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License v. 2.0 are satisfied: GNU General Public License, version 2
// with the GNU Classpath Exception which is available at
// https://www.gnu.org/software/classpath/license.html.
//
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
// *****************************************************************************

/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/

export module '@theia/plugin' {

export interface DocumentContextItem {
readonly uri: Uri;
readonly version: number;
readonly ranges: Range[];
}

export interface MappedEditsContext {
documents: DocumentContextItem[][];
}

/**
* Interface for providing mapped edits for a given document.
*/
export interface MappedEditsProvider {
/**
* Provide mapped edits for a given document.
* @param document The document to provide mapped edits for.
* @param codeBlocks Code blocks that come from an LLM's reply.
* "Insert at cursor" in the panel chat only sends one edit that the user clicks on, but inline chat can send multiple blocks
* and let the lang server decide what to do with them.
* @param context The context for providing mapped edits.
* @param token A cancellation token.
* @returns A provider result of text edits.
*/
provideMappedEdits(
document: TextDocument,
codeBlocks: string[],
context: MappedEditsContext,
token: CancellationToken
): ProviderResult<WorkspaceEdit | null>;
}

export namespace chat {
export function registerMappedEditsProvider(documentSelector: DocumentSelector, provider: MappedEditsProvider): Disposable;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe adding @stubbed here ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A priori, that makes no sense to me: this is the declaration of the API. Isn't the fact that it's stubbed a property of the implementation? Does the API comparator walk the API declarations to find the stubbed flag?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, the vscode-theia-comparator project runs through theia.d.ts and vscode.d.ts to generate the compatibility report. I would tend to do the same on the proposed.d.ts files.

Screenshot from 2024-05-06 15-38-39

}
}
Loading