Skip to content

Commit 9be0faf

Browse files
committed
Fix microsoft#92794. Promote comment options to stable
1 parent f25c779 commit 9be0faf

2 files changed

Lines changed: 20 additions & 22 deletions

File tree

src/vs/vscode.d.ts

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10898,6 +10898,21 @@ declare module 'vscode' {
1089810898
provideCommentingRanges(document: TextDocument, token: CancellationToken): ProviderResult<Range[]>;
1089910899
}
1090010900

10901+
/**
10902+
* Represents a [comment controller](#CommentController)'s [options](#CommentController.options).
10903+
*/
10904+
export interface CommentOptions {
10905+
/**
10906+
* An optional string to show on the comment input box when it's collapsed.
10907+
*/
10908+
prompt?: string;
10909+
10910+
/**
10911+
* An optional string to show as placeholder in the comment input box when it's focused.
10912+
*/
10913+
placeHolder?: string;
10914+
}
10915+
1090110916
/**
1090210917
* A comment controller is able to provide [comments](#CommentThread) support to the editor and
1090310918
* provide users various ways to interact with comments.
@@ -10913,6 +10928,11 @@ declare module 'vscode' {
1091310928
*/
1091410929
readonly label: string;
1091510930

10931+
/**
10932+
* Comment controller options
10933+
*/
10934+
options?: CommentOptions;
10935+
1091610936
/**
1091710937
* Optional commenting range provider. Provide a list [ranges](#Range) which support commenting to any given resource uri.
1091810938
*

src/vs/vscode.proposed.d.ts

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2080,26 +2080,4 @@ declare module 'vscode' {
20802080
}
20812081

20822082
//#endregion
2083-
2084-
//#region Comment
2085-
export interface CommentOptions {
2086-
/**
2087-
* An optional string to show on the comment input box when it's collapsed.
2088-
*/
2089-
prompt?: string;
2090-
2091-
/**
2092-
* An optional string to show as placeholder in the comment input box when it's focused.
2093-
*/
2094-
placeHolder?: string;
2095-
}
2096-
2097-
export interface CommentController {
2098-
/**
2099-
* Comment controller options
2100-
*/
2101-
options?: CommentOptions;
2102-
}
2103-
2104-
//#endregion
21052083
}

0 commit comments

Comments
 (0)