mirror of
https://github.com/ckaczor/azuredatastudio.git
synced 2026-02-12 11:08:31 -05:00
Merge from vscode 5b9869eb02fa4c96205a74d05cad9164dfd06d60 (#5607)
This commit is contained in:
Anthony Dresser
236
src/vs/vscode.d.ts
vendored
236
src/vs/vscode.d.ts
vendored
@@ -5763,8 +5763,11 @@ declare module 'vscode' {
|
||||
* to allow using a static localhost port inside the webview that is resolved to random port that a service is
|
||||
* running on.
|
||||
*
|
||||
* If a webview accesses localhost content, we recomend that you specify port mappings even if
|
||||
* If a webview accesses localhost content, we recommend that you specify port mappings even if
|
||||
* the `webviewPort` and `extensionHostPort` ports are the same.
|
||||
*
|
||||
* *Note* that port mappings only work for `http` or `https` urls. Websocket urls (e.g. `ws://localhost:3000`)
|
||||
* cannot be mapped to another port.
|
||||
*/
|
||||
readonly portMapping?: ReadonlyArray<WebviewPortMapping>;
|
||||
}
|
||||
@@ -8940,6 +8943,237 @@ declare module 'vscode' {
|
||||
*/
|
||||
export const onDidChange: Event<void>;
|
||||
}
|
||||
|
||||
//#region Comments
|
||||
|
||||
/**
|
||||
* Collapsible state of a [comment thread](#CommentThread)
|
||||
*/
|
||||
export enum CommentThreadCollapsibleState {
|
||||
/**
|
||||
* Determines an item is collapsed
|
||||
*/
|
||||
Collapsed = 0,
|
||||
|
||||
/**
|
||||
* Determines an item is expanded
|
||||
*/
|
||||
Expanded = 1
|
||||
}
|
||||
|
||||
/**
|
||||
* Comment mode of a [comment](#Comment)
|
||||
*/
|
||||
export enum CommentMode {
|
||||
/**
|
||||
* Displays the comment editor
|
||||
*/
|
||||
Editing = 0,
|
||||
|
||||
/**
|
||||
* Displays the preview of the comment
|
||||
*/
|
||||
Preview = 1
|
||||
}
|
||||
|
||||
/**
|
||||
* A collection of [comments](#Comment) representing a conversation at a particular range in a document.
|
||||
*/
|
||||
export interface CommentThread {
|
||||
/**
|
||||
* The uri of the document the thread has been created on.
|
||||
*/
|
||||
readonly resource: Uri;
|
||||
|
||||
/**
|
||||
* The range the comment thread is located within the document. The thread icon will be shown
|
||||
* at the first line of the range.
|
||||
*/
|
||||
range: Range;
|
||||
|
||||
/**
|
||||
* The ordered comments of the thread.
|
||||
*/
|
||||
comments: ReadonlyArray<Comment>;
|
||||
|
||||
/**
|
||||
* Whether the thread should be collapsed or expanded when opening the document.
|
||||
* Defaults to Collapsed.
|
||||
*/
|
||||
collapsibleState: CommentThreadCollapsibleState;
|
||||
|
||||
/**
|
||||
* Context value of the comment thread. This can be used to contribute thread specific actions.
|
||||
* For example, a comment thread is given a context value as `editable`. When contributing actions to `comments/commentThread/title`
|
||||
* using `menus` extension point, you can specify context value for key `commentThread` in `when` expression like `commentThread == editable`.
|
||||
* ```
|
||||
* "contributes": {
|
||||
* "menus": {
|
||||
* "comments/commentThread/title": [
|
||||
* {
|
||||
* "command": "extension.deleteCommentThread",
|
||||
* "when": "commentThread == editable"
|
||||
* }
|
||||
* ]
|
||||
* }
|
||||
* }
|
||||
* ```
|
||||
* This will show action `extension.deleteCommentThread` only for comment threads with `contextValue` is `editable`.
|
||||
*/
|
||||
contextValue?: string;
|
||||
|
||||
/**
|
||||
* The optional human-readable label describing the [Comment Thread](#CommentThread)
|
||||
*/
|
||||
label?: string;
|
||||
|
||||
/**
|
||||
* Dispose this comment thread.
|
||||
*
|
||||
* Once disposed, this comment thread will be removed from visible editors and Comment Panel when approriate.
|
||||
*/
|
||||
dispose(): void;
|
||||
}
|
||||
|
||||
/**
|
||||
* Author information of a [comment](#Comment)
|
||||
*/
|
||||
export interface CommentAuthorInformation {
|
||||
/**
|
||||
* The display name of the author of the comment
|
||||
*/
|
||||
name: string;
|
||||
|
||||
/**
|
||||
* The optional icon path for the author
|
||||
*/
|
||||
iconPath?: Uri;
|
||||
}
|
||||
|
||||
/**
|
||||
* A comment is displayed within the editor or the Comments Panel, depending on how it is provided.
|
||||
*/
|
||||
export interface Comment {
|
||||
/**
|
||||
* The human-readable comment body
|
||||
*/
|
||||
body: string | MarkdownString;
|
||||
|
||||
/**
|
||||
* [Comment mode](#CommentMode) of the comment
|
||||
*/
|
||||
mode: CommentMode;
|
||||
|
||||
/**
|
||||
* The [author information](#CommentAuthorInformation) of the comment
|
||||
*/
|
||||
author: CommentAuthorInformation;
|
||||
|
||||
/**
|
||||
* Context value of the comment. This can be used to contribute comment specific actions.
|
||||
* For example, a comment is given a context value as `editable`. When contributing actions to `comments/comment/title`
|
||||
* using `menus` extension point, you can specify context value for key `comment` in `when` expression like `comment == editable`.
|
||||
* ```
|
||||
* "contributes": {
|
||||
* "menus": {
|
||||
* "comments/comment/title": [
|
||||
* {
|
||||
* "command": "extension.deleteComment",
|
||||
* "when": "comment == editable"
|
||||
* }
|
||||
* ]
|
||||
* }
|
||||
* }
|
||||
* ```
|
||||
* This will show action `extension.deleteComment` only for comments with `contextValue` is `editable`.
|
||||
*/
|
||||
contextValue?: string;
|
||||
|
||||
/**
|
||||
* Optional label describing the [Comment](#Comment)
|
||||
* Label will be rendered next to authorName if exists.
|
||||
*/
|
||||
label?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Command argument for actions registered in `comments/commentThread/actions`.
|
||||
*/
|
||||
export interface CommentReply {
|
||||
/**
|
||||
* The active [comment thread](#CommentThread)
|
||||
*/
|
||||
thread: CommentThread;
|
||||
|
||||
/**
|
||||
* The value in the comment editor
|
||||
*/
|
||||
text: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Commenting range provider for a [comment controller](#CommentController).
|
||||
*/
|
||||
export interface CommentingRangeProvider {
|
||||
/**
|
||||
* Provide a list of ranges which allow new comment threads creation or null for a given document
|
||||
*/
|
||||
provideCommentingRanges(document: TextDocument, token: CancellationToken): ProviderResult<Range[]>;
|
||||
}
|
||||
|
||||
/**
|
||||
* A comment controller is able to provide [comments](#CommentThread) support to the editor and
|
||||
* provide users various ways to interact with comments.
|
||||
*/
|
||||
export interface CommentController {
|
||||
/**
|
||||
* The id of this comment controller.
|
||||
*/
|
||||
readonly id: string;
|
||||
|
||||
/**
|
||||
* The human-readable label of this comment controller.
|
||||
*/
|
||||
readonly label: string;
|
||||
|
||||
/**
|
||||
* Optional commenting range provider. Provide a list [ranges](#Range) which support commenting to any given resource uri.
|
||||
*
|
||||
* If not provided, users can leave comments in any document opened in the editor.
|
||||
*/
|
||||
commentingRangeProvider?: CommentingRangeProvider;
|
||||
|
||||
/**
|
||||
* Create a [comment thread](#CommentThread). The comment thread will be displayed in visible text editors (if the resource matches)
|
||||
* and Comments Panel once created.
|
||||
*
|
||||
* @param resource The uri of the document the thread has been created on.
|
||||
* @param range The range the comment thread is located within the document.
|
||||
* @param comments The ordered comments of the thread.
|
||||
*/
|
||||
createCommentThread(uri: Uri, range: Range, comments: Comment[]): CommentThread;
|
||||
|
||||
/**
|
||||
* Dispose this comment controller.
|
||||
*
|
||||
* Once disposed, all [comment threads](#CommentThread) created by this comment controller will also be removed from the editor
|
||||
* and Comments Panel.
|
||||
*/
|
||||
dispose(): void;
|
||||
}
|
||||
|
||||
namespace comments {
|
||||
/**
|
||||
* Creates a new [comment controller](#CommentController) instance.
|
||||
*
|
||||
* @param id An `id` for the comment controller.
|
||||
* @param label A human-readable string for the comment controller.
|
||||
* @return An instance of [comment controller](#CommentController).
|
||||
*/
|
||||
export function createCommentController(id: string, label: string): CommentController;
|
||||
}
|
||||
|
||||
//#endregion
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
Reference in New Issue
Block a user