-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
stub TerminalCompletionProvider proposed API
fixes #14604 contributed on behalf of STMicroelectronics Signed-off-by: Remi Schnekenburger <[email protected]>
- Loading branch information
1 parent
d8022a1
commit d230207
Showing
4 changed files
with
184 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
143 changes: 143 additions & 0 deletions
143
packages/plugin/src/theia.proposed.terminalCompletionProvider.d.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| // ***************************************************************************** | ||
| // Copyright (C) 2025 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. | ||
| *--------------------------------------------------------------------------------------------*/ | ||
| // code copied and modified from https://github.com/microsoft/vscode/blob/1.96.2/src/vscode-dts/vscode.proposed.terminalCompletionProvider.d.ts | ||
|
|
||
| declare module '@theia/plugin' { | ||
|
|
||
| // https://github.com/microsoft/vscode/issues/226562 | ||
|
|
||
| export interface TerminalCompletionProvider<T extends TerminalCompletionItem> { | ||
| id: string; | ||
| /** | ||
| * Provide completions for the given position and document. | ||
| * @param terminal The terminal for which completions are being provided. | ||
| * @param context Information about the terminal's current state. | ||
| * @param token A cancellation token. | ||
| * @return A list of completions. | ||
| */ | ||
| provideTerminalCompletions(terminal: Terminal, context: TerminalCompletionContext, token: CancellationToken): ProviderResult<T[] | TerminalCompletionList<T>>; | ||
| } | ||
|
|
||
| export interface TerminalCompletionItem { | ||
| /** | ||
| * The label of the completion. | ||
| */ | ||
| label: string; | ||
|
|
||
| /** | ||
| * The index of the start of the range to replace. | ||
| */ | ||
| replacementIndex: number; | ||
|
|
||
| /** | ||
| * The length of the range to replace. | ||
| */ | ||
| replacementLength: number; | ||
|
|
||
| /** | ||
| * The completion's detail which appears on the right of the list. | ||
| */ | ||
| detail?: string; | ||
|
|
||
| /** | ||
| * The completion's kind. Note that this will map to an icon. | ||
| */ | ||
| kind?: TerminalCompletionItemKind; | ||
| } | ||
|
|
||
| /** | ||
| * Terminal item kinds. | ||
| */ | ||
| export enum TerminalCompletionItemKind { | ||
| File = 0, | ||
| Folder = 1, | ||
| Flag = 2, | ||
| Method = 3, | ||
| Argument = 4 | ||
| } | ||
|
|
||
| export interface TerminalCompletionContext { | ||
| /** | ||
| * The complete terminal command line. | ||
| */ | ||
| commandLine: string; | ||
| /** | ||
| * The index of the | ||
| * cursor in the command line. | ||
| */ | ||
| cursorPosition: number; | ||
| } | ||
|
|
||
| export namespace window { | ||
| /** | ||
| * Register a completion provider for a certain type of terminal. | ||
| * | ||
| * @param provider The completion provider. | ||
| * @returns A {@link Disposable} that unregisters this provider when being disposed. | ||
| * @stubbed | ||
| */ | ||
| export function registerTerminalCompletionProvider<T extends TerminalCompletionItem>(provider: TerminalCompletionProvider<T>, ...triggerCharacters: string[]): Disposable; | ||
| } | ||
|
|
||
| /** | ||
| * Represents a collection of {@link TerminalCompletionItem completion items} to be presented | ||
| * in the terminal. | ||
| */ | ||
| export class TerminalCompletionList<T extends TerminalCompletionItem = TerminalCompletionItem> { | ||
|
|
||
| /** | ||
| * Resources that should be shown in the completions list for the cwd of the terminal. | ||
| */ | ||
| resourceRequestConfig?: TerminalResourceRequestConfig; | ||
|
|
||
| /** | ||
| * The completion items. | ||
| */ | ||
| items: T[]; | ||
|
|
||
| /** | ||
| * Creates a new completion list. | ||
| * | ||
| * @param items The completion items. | ||
| * @param resourceRequestConfig Indicates which resources should be shown as completions for the cwd of the terminal. | ||
| */ | ||
| constructor(items?: T[], resourceRequestConfig?: TerminalResourceRequestConfig); | ||
| } | ||
|
|
||
| export interface TerminalResourceRequestConfig { | ||
| /** | ||
| * Show files as completion items. | ||
| */ | ||
| filesRequested?: boolean; | ||
| /** | ||
| * Show folders as completion items. | ||
| */ | ||
| foldersRequested?: boolean; | ||
| /** | ||
| * If no cwd is provided, no resources will be shown as completions. | ||
| */ | ||
| cwd?: Uri; | ||
| /** | ||
| * The path separator to use when constructing paths. | ||
| */ | ||
| pathSeparator: string; | ||
| } | ||
| } |