@codingame/monaco-vscode-api 1.83.14 → 1.83.15-next.0

package/vscode-dts/vscode.proposed.saveEditor.d.ts

@@ -0,0 +1,35 @@
+/*---------------------------------------------------------------------------------------------
+ *  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/178713
+
+declare module 'vscode' {
+
+	export namespace workspace {
+
+		/**
+		 * Saves the editor identified by the given resource and returns the resulting resource or `undefined`
+		 * if save was not successful or no editor with the given resource was found.
+		 *
+		 * **Note** that an editor with the provided resource must be opened in order to be saved.
+		 *
+		 * @param uri the associated uri for the opened editor to save.
+		 * @return A thenable that resolves when the save operation has finished.
+		 */
+		export function save(uri: Uri): Thenable<Uri | undefined>;
+
+		/**
+		 * Saves the editor identified by the given resource to a new file name as provided by the user and
+		 * returns the resulting resource or `undefined` if save was not successful or cancelled or no editor
+		 * with the given resource was found.
+		 *
+		 * **Note** that an editor with the provided resource must be opened in order to be saved as.
+		 *
+		 * @param uri the associated uri for the opened editor to save as.
+		 * @return A thenable that resolves when the save-as operation has finished.
+		 */
+		export function saveAs(uri: Uri): Thenable<Uri | undefined>;
+	}
+}

package/vscode-dts/vscode.proposed.scmActionButton.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/133935
+
+	export interface SourceControlActionButton {
+		command: Command;
+		secondaryCommands?: Command[][];
+		description?: string;
+		enabled: boolean;
+	}
+
+	export interface SourceControl {
+		actionButton?: SourceControlActionButton;
+	}
+}

package/vscode-dts/vscode.proposed.scmHistoryProvider.d.ts

@@ -0,0 +1,77 @@
+/*---------------------------------------------------------------------------------------------
+ *  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/185269
+
+	export interface SourceControl {
+		historyProvider?: SourceControlHistoryProvider;
+	}
+
+	export interface SourceControlHistoryProvider {
+		actionButton?: SourceControlActionButton;
+		currentHistoryItemGroup?: SourceControlHistoryItemGroup;
+
+		/**
+		 * Fires when the action button changes
+		 */
+		onDidChangeActionButton: Event<void>;
+
+		/**
+		 * Fires when the current history item group changes (ex: checkout)
+		 */
+		onDidChangeCurrentHistoryItemGroup: Event<void>;
+
+		/**
+		 * Fires when the history item groups change (ex: commit, push, fetch)
+		 */
+		// onDidChangeHistoryItemGroups: Event<SourceControlHistoryChangeEvent>;
+
+		provideHistoryItems(historyItemGroupId: string, options: SourceControlHistoryOptions, token: CancellationToken): ProviderResult<SourceControlHistoryItem[]>;
+		provideHistoryItemChanges(historyItemId: string, token: CancellationToken): ProviderResult<SourceControlHistoryItemChange[]>;
+
+		resolveHistoryItemGroupBase(historyItemGroupId: string, token: CancellationToken): ProviderResult<SourceControlHistoryItemGroup | undefined>;
+		resolveHistoryItemGroupCommonAncestor(historyItemGroupId1: string, historyItemGroupId: string, token: CancellationToken): ProviderResult<{ id: string; ahead: number; behind: number }>;
+	}
+
+	export interface SourceControlHistoryOptions {
+		readonly cursor?: string;
+		readonly limit?: number | { id?: string };
+	}
+
+	export interface SourceControlHistoryItemGroup {
+		readonly id: string;
+		readonly label: string;
+		readonly upstream?: SourceControlRemoteHistoryItemGroup;
+	}
+
+	export interface SourceControlRemoteHistoryItemGroup {
+		readonly id: string;
+		readonly label: string;
+	}
+
+	export interface SourceControlHistoryItem {
+		readonly id: string;
+		readonly parentIds: string[];
+		readonly label: string;
+		readonly description?: string;
+		readonly icon?: Uri | { light: Uri; dark: Uri } | ThemeIcon;
+		readonly timestamp?: number;
+	}
+
+	export interface SourceControlHistoryItemChange {
+		readonly uri: Uri;
+		readonly originalUri: Uri | undefined;
+		readonly modifiedUri: Uri | undefined;
+		readonly renameUri: Uri | undefined;
+	}
+
+	// export interface SourceControlHistoryChangeEvent {
+	// 	readonly added: Iterable<SourceControlHistoryItemGroup>;
+	// 	readonly removed: Iterable<SourceControlHistoryItemGroup>;
+	// 	readonly modified: Iterable<SourceControlHistoryItemGroup>;
+	// }
+
+}

package/vscode-dts/vscode.proposed.scmSelectedProvider.d.ts

@@ -0,0 +1,22 @@
+/*---------------------------------------------------------------------------------------------
+ *  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' {
+
+	// todo@joaomoreno add issue reference
+
+	export interface SourceControl {
+
+		/**
+		 * Whether the source control is selected.
+		 */
+		readonly selected: boolean;
+
+		/**
+		 * An event signaling when the selection state changes.
+		 */
+		readonly onDidChangeSelection: Event<boolean>;
+	}
+}

package/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;
+	}
+}

package/vscode-dts/vscode.proposed.scmValidation.d.ts

@@ -0,0 +1,60 @@
+/*---------------------------------------------------------------------------------------------
+ *  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' {
+
+	// todo@joaomoreno add issue reference
+
+	/**
+	 * Represents the validation type of the Source Control input.
+	 */
+	export enum SourceControlInputBoxValidationType {
+
+		/**
+		 * Something not allowed by the rules of a language or other means.
+		 */
+		Error = 0,
+
+		/**
+		 * Something suspicious but allowed.
+		 */
+		Warning = 1,
+
+		/**
+		 * Something to inform about but not a problem.
+		 */
+		Information = 2
+	}
+
+	export interface SourceControlInputBoxValidation {
+
+		/**
+		 * The validation message to display.
+		 */
+		readonly message: string | MarkdownString;
+
+		/**
+		 * The validation type.
+		 */
+		readonly type: SourceControlInputBoxValidationType;
+	}
+
+	/**
+	 * Represents the input box in the Source Control viewlet.
+	 */
+	export interface SourceControlInputBox {
+
+		/**
+		 * Shows a transient contextual message on the input.
+		 */
+		showValidationMessage(message: string | MarkdownString, type: SourceControlInputBoxValidationType): void;
+
+		/**
+		 * A validation function for the input box. It's possible to change
+		 * the validation provider simply by setting this property to a different function.
+		 */
+		validateInput?(value: string, cursorPosition: number): ProviderResult<SourceControlInputBoxValidation>;
+	}
+}

package/vscode-dts/vscode.proposed.shareProvider.d.ts

@@ -0,0 +1,74 @@
+/*---------------------------------------------------------------------------------------------
+ *  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/176316 @joyceerhl
+
+declare module 'vscode' {
+
+	/**
+	 * Data about an item which can be shared.
+	 */
+	export interface ShareableItem {
+		/**
+		 * A resource in the workspace that can be shared.
+		 */
+		resourceUri: Uri;
+
+		/**
+		 * If present, a selection within the `resourceUri`.
+		 */
+		selection?: Range;
+	}
+
+	/**
+	 * A provider which generates share links for resources in the editor.
+	 */
+	export interface ShareProvider {
+
+		/**
+		 * A unique ID for the provider.
+		 * This will be used to activate specific extensions contributing share providers if necessary.
+		 */
+		readonly id: string;
+
+		/**
+		 * A label which will be used to present this provider's options in the UI.
+		 */
+		readonly label: string;
+
+		/**
+		 * The order in which the provider should be listed in the UI when there are multiple providers.
+		 */
+		readonly priority: number;
+
+		/**
+		 *
+		 * @param item Data about an item which can be shared.
+		 * @param token A cancellation token.
+		 * @returns A {@link Uri} representing an external link or sharing text. The provider result
+		 * will be copied to the user's clipboard and presented in a confirmation dialog.
+		 */
+		provideShare(item: ShareableItem, token: CancellationToken): ProviderResult<Uri | string>;
+	}
+
+	export namespace window {
+
+		/**
+		 * Register a share provider. An extension may register multiple share providers.
+		 * There may be multiple share providers for the same {@link ShareableItem}.
+		 * @param selector A document selector to filter whether the provider should be shown for a {@link ShareableItem}.
+		 * @param provider A share provider.
+		 */
+		export function registerShareProvider(selector: DocumentSelector, provider: ShareProvider): Disposable;
+	}
+
+	export interface TreeItem {
+
+		/**
+		 * An optional property which, when set, inlines a `Share` option in the context menu for this tree item.
+		 */
+		shareableItem?: ShareableItem;
+	}
+}

package/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;
+	}
+}

package/vscode-dts/vscode.proposed.tabInputTextMerge.d.ts

@@ -0,0 +1,25 @@
+/*---------------------------------------------------------------------------------------------
+ *  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/153213
+
+declare module 'vscode' {
+
+	export class TabInputTextMerge {
+
+		readonly base: Uri;
+		readonly input1: Uri;
+		readonly input2: Uri;
+		readonly result: Uri;
+
+		constructor(base: Uri, input1: Uri, input2: Uri, result: Uri);
+	}
+
+	export interface Tab {
+
+		readonly input: TabInputText | TabInputTextDiff | TabInputTextMerge | TabInputCustom | TabInputWebview | TabInputNotebook | TabInputNotebookDiff | TabInputTerminal | unknown;
+
+	}
+}

package/vscode-dts/vscode.proposed.taskPresentationGroup.d.ts

@@ -0,0 +1,16 @@
+/*---------------------------------------------------------------------------------------------
+ *  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/47265
+
+	export interface TaskPresentationOptions {
+		/**
+		 * Controls whether the task is executed in a specific terminal group using split panes.
+		 */
+		group?: string;
+	}
+}

package/vscode-dts/vscode.proposed.telemetry.d.ts

@@ -0,0 +1,36 @@
+/*---------------------------------------------------------------------------------------------
+ *  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' {
+
+	export interface TelemetryConfiguration {
+		/**
+		 * Whether or not usage telemetry collection is allowed
+		 */
+		readonly isUsageEnabled: boolean;
+		/**
+		 * Whether or not crash error telemetry collection is allowed
+		 */
+		readonly isErrorsEnabled: boolean;
+		/**
+		 * Whether or not crash report collection is allowed
+		 */
+		readonly isCrashEnabled: boolean;
+	}
+
+	export namespace env {
+		/**
+		 * Indicates what telemetry is enabled / disabled
+		 * Can be observed to determine what telemetry the extension is allowed to send
+		 */
+		export const telemetryConfiguration: TelemetryConfiguration;
+
+		/**
+		 * An {@link Event} which fires when the collectable state of telemetry changes
+		 * Returns a {@link TelemetryConfiguration} object
+		 */
+		export const onDidChangeTelemetryConfiguration: Event<TelemetryConfiguration | undefined>;
+	}
+}

package/vscode-dts/vscode.proposed.terminalDataWriteEvent.d.ts

@@ -0,0 +1,32 @@
+/*---------------------------------------------------------------------------------------------
+ *  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/78502
+	//
+	// This API is still proposed but we don't intent on promoting it to stable due to problems
+	// around performance. See #145234 for a more likely API to get stabilized.
+
+	export interface TerminalDataWriteEvent {
+		/**
+		 * The {@link Terminal} for which the data was written.
+		 */
+		readonly terminal: Terminal;
+		/**
+		 * The data being written.
+		 */
+		readonly data: string;
+	}
+
+	namespace window {
+		/**
+		 * An event which fires when the terminal's child pseudo-device is written to (the shell).
+		 * In other words, this provides access to the raw data stream from the process running
+		 * within the terminal, including VT sequences.
+		 */
+		export const onDidWriteTerminalData: Event<TerminalDataWriteEvent>;
+	}
+}

package/vscode-dts/vscode.proposed.terminalDimensions.d.ts

@@ -0,0 +1,39 @@
+/*---------------------------------------------------------------------------------------------
+ *  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/55718
+
+	/**
+	 * An {@link Event} which fires when a {@link Terminal}'s dimensions change.
+	 */
+	export interface TerminalDimensionsChangeEvent {
+		/**
+		 * The {@link Terminal} for which the dimensions have changed.
+		 */
+		readonly terminal: Terminal;
+		/**
+		 * The new value for the {@link Terminal.dimensions terminal's dimensions}.
+		 */
+		readonly dimensions: TerminalDimensions;
+	}
+
+	export namespace window {
+		/**
+		 * An event which fires when the {@link Terminal.dimensions dimensions} of the terminal change.
+		 */
+		export const onDidChangeTerminalDimensions: Event<TerminalDimensionsChangeEvent>;
+	}
+
+	export interface Terminal {
+		/**
+		 * The current dimensions of the terminal. This will be `undefined` immediately after the
+		 * terminal is created as the dimensions are not known until shortly after the terminal is
+		 * created.
+		 */
+		readonly dimensions: TerminalDimensions | undefined;
+	}
+}

package/vscode-dts/vscode.proposed.terminalExecuteCommandEvent.d.ts

@@ -0,0 +1,46 @@
+/*---------------------------------------------------------------------------------------------
+ *  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/145234
+
+	export interface TerminalExecutedCommand {
+		/**
+		 * The {@link Terminal} the command was executed in.
+		 */
+		terminal: Terminal;
+		/**
+		 * The full command line that was executed, including both the command and the arguments.
+		 */
+		commandLine: string | undefined;
+		/**
+		 * The current working directory that was reported by the shell. This will be a {@link Uri}
+		 * if the string reported by the shell can reliably be mapped to the connected machine.
+		 */
+		cwd: Uri | string | undefined;
+		/**
+		 * The exit code reported by the shell.
+		 */
+		exitCode: number | undefined;
+		/**
+		 * The output of the command when it has finished executing. This is the plain text shown in
+		 * the terminal buffer and does not include raw escape sequences. Depending on the shell
+		 * setup, this may include the command line as part of the output.
+		 */
+		output: string | undefined;
+	}
+
+	export namespace window {
+		/**
+		 * An event that is emitted when a terminal with shell integration activated has completed
+		 * executing a command.
+		 *
+		 * Note that this event will not fire if the executed command exits the shell, listen to
+		 * {@link onDidCloseTerminal} to handle that case.
+		 */
+		export const onDidExecuteTerminalCommand: Event<TerminalExecutedCommand>;
+	}
+}

package/vscode-dts/vscode.proposed.terminalQuickFixProvider.d.ts

@@ -0,0 +1,83 @@
+/*---------------------------------------------------------------------------------------------
+ *  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/162950
+
+	export type SingleOrMany<T> = T[] | T;
+
+	export interface TerminalQuickFixProvider {
+		/**
+		 * Provides terminal quick fixes
+		 * @param commandMatchResult The command match result for which to provide quick fixes
+		 * @param token A cancellation token indicating the result is no longer needed
+		 * @return Terminal quick fix(es) if any
+		 */
+		provideTerminalQuickFixes(commandMatchResult: TerminalCommandMatchResult, token: CancellationToken): ProviderResult<SingleOrMany<TerminalQuickFixExecuteTerminalCommand | TerminalQuickFixOpener | Command>>;
+	}
+
+
+	export interface TerminalCommandMatchResult {
+		commandLine: string;
+		commandLineMatch: RegExpMatchArray;
+		outputMatch?: {
+			regexMatch: RegExpMatchArray;
+			outputLines: string[];
+		};
+	}
+
+	export namespace window {
+		/**
+			 * @param provider A terminal quick fix provider
+			 * @return A {@link Disposable} that unregisters the provider when being disposed
+			 */
+		export function registerTerminalQuickFixProvider(id: string, provider: TerminalQuickFixProvider): Disposable;
+	}
+
+	export class TerminalQuickFixExecuteTerminalCommand {
+		/**
+		 * The terminal command to run
+		 */
+		terminalCommand: string;
+		constructor(terminalCommand: string);
+	}
+	export class TerminalQuickFixOpener {
+		/**
+		 * The uri to open
+		 */
+		uri: Uri;
+		constructor(uri: Uri);
+	}
+
+	/**
+	 * A matcher that runs on a sub-section of a terminal command's output
+	 */
+	interface TerminalOutputMatcher {
+		/**
+		 * A string or regex to match against the unwrapped line. If this is a regex with the multiline
+		 * flag, it will scan an amount of lines equal to `\n` instances in the regex + 1.
+		 */
+		lineMatcher: string | RegExp;
+		/**
+		 * Which side of the output to anchor the {@link offset} and {@link length} against.
+		 */
+		anchor: TerminalOutputAnchor;
+		/**
+			 * The number of rows above or below the {@link anchor} to start matching against.
+			 */
+		offset: number;
+		/**
+		 * The number of wrapped lines to match against, this should be as small as possible for performance
+		 * reasons. This is capped at 40.
+		 */
+		length: number;
+	}
+
+	enum TerminalOutputAnchor {
+		Top = 0,
+		Bottom = 1
+	}
+}

package/vscode-dts/vscode.proposed.terminalSelection.d.ts

@@ -0,0 +1,16 @@
+/*---------------------------------------------------------------------------------------------
+ *  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/188173
+
+	export interface Terminal {
+		/**
+		 * The selected text of the terminal or undefined if there is no selection.
+		 */
+		readonly selection: string | undefined;
+	}
+}