bingyi/vscode-extension-samples
1
0
Fork 0
mirror of https://github.com/microsoft/vscode-extension-samples.git synced 2026-06-13 07:10:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

address feedback on new comment callback

Browse Source
This commit is contained in:
Peng Lyu
2019-03-11 10:54:25 -07:00
parent 2dd494062b
commit 483beced22
2 changed files with 38 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
comment-sample/src/extension.ts
View File

@ -11,13 +11,13 @@ export function activate(context: vscode.ExtensionContext) {
context.subscriptions.push(commentController);
// commenting range provider
const provideCommentingRange = (document: vscode.TextDocument, token: vscode.CancellationToken) => {
commentController.commentingRangeProvider = (document: vscode.TextDocument, token: vscode.CancellationToken) => {
let lineCount = document.lineCount;
return [new vscode.Range(0, 0, lineCount - 1, 0)];
};
// callback when users click `+` button on Gutter or run Create Comment command from Command Palette
const newCommentWidgetCallback = (document: vscode.TextDocument, range: vscode.Range) => {
commentController.newCommentThreadFactory = (document: vscode.TextDocument, range: vscode.Range) => {
// create a empty thread
let thread = commentController.createCommentThread(`${++threadId}`, document.uri, range);
// by default, a comment thread is collapsed, for newly created empty comment thread, we want to expand it and users can start commenting immediately
@ -38,9 +38,6 @@ export function activate(context: vscode.ExtensionContext) {
};
};
// Register commenting range provider and callback.
commentController.registerCommentingRangeProvider(provideCommentingRange, newCommentWidgetCallback);
// register `mywiki.createNote` command
context.subscriptions.push(vscode.commands.registerCommand('mywiki.createNote', (commentController: vscode.CommentController, thread: vscode.CommentThread) => {
if (commentController.inputBox) {

50
comment-sample/src/typings/vscode.proposed.d.ts vendored
View File

@ -47,7 +47,7 @@ declare module 'vscode' {
range: Range;
/**
* Label describing the [Comment Thread](#CommentThread)
* The human-readable label describing the [Comment Thread](#CommentThread)
*/
label: string;
@ -55,20 +55,26 @@ declare module 'vscode' {
* The ordered comments of the thread.
*/
comments: Comment[];
/**
* Optional accept input command
*
* `acceptInputCommand` is the default action rendered on Comment Widget, which is always placed rightmost.
* It will be executed when users submit the comment from keyboard shortcut.
* This action is disabled when the comment editor is empty.
* This command will be invoked when users the user accepts the value in the comment editor.
* This command will disabled when the comment editor is empty.
*/
acceptInputCommand?: Command;
/**
* Optional additonal commands.
*
* `additionalCommands` are the secondary actions rendered on Comment Widget.
*/
additionalCommands?: Command[];
/**
* Whether the thread should be collapsed or expanded when opening the document. Defaults to Collapsed.
* Whether the thread should be collapsed or expanded when opening the document.
* Defaults to Collapsed.
*/
collapsibleState?: CommentThreadCollapsibleState;
dispose(): void;
@ -125,23 +131,39 @@ declare module 'vscode' {
}
export interface CommentController {
readonly id: string;
readonly label: string;
/**
* The active (focused) comment input box.
* The id of this comment controller.
*/
readonly id: string;
/**
* The human-readable label of this comment controller.
*/
readonly label: string;
/**
* The active (focused) [comment input box](#CommentInputBox).
*/
readonly inputBox?: CommentInputBox;
createCommentThread(id: string, resource: Uri, range: Range): CommentThread;
/**
* Optional commenting range provider.
* Provide a list [ranges](#Range) which support commenting to any given resource uri.
*
* @param uri The uri of the resource open in a text editor.
* @param callback, a handler called when users attempt to create a new comment thread, either from the gutter or command palette
* @param token A cancellation token.
* @return A thenable that resolves to a list of commenting ranges or null and undefined if the provider
* does not want to participate or was cancelled.
*/
registerCommentingRangeProvider(provider: (document: TextDocument, token: CancellationToken) => ProviderResult<Range[]>, callback: (document: TextDocument, range: Range) => void): void;
commentingRangeProvider?(document: TextDocument, token: CancellationToken): ProviderResult<Range[]>;
/**
* The method `newCommentThreadFactory` is called when users attempt to create new comment thread from the gutter or command palette.
* Extensions still need to call `createCommentThread` inside this call when appropriate.
* @param document
* @param range
*/
newCommentThreadFactory(document: TextDocument, range: Range): void;
/**
* Dispose this comment controller.
*/
dispose(): void;
}