Test DocumentCommentProvider edit and delete

[RMacfarlane]

#58078

Complexity: 4

• Mac @chrmarti
• linux @sandy081
• Windows @aeschli

DocumentCommentProviders now expose a way to edit and delete comments. When the provider has editComment or deleteComment methods and a comment within a document has the canEdit or canDelete flag set, an action bar should appear on hover or focus of the comment. Things to test:

• Is documentation clear?
• The action bar for comments shows up at appropriate times
• UI for edit and delete behave as expected
• throwing within editComment and deleteComment is safely handled by VSCode

[sandy081]

@RMacfarlane Is there a sample that can be followed? Otherwise It's unclear where and how to start.

[chrmarti]

@sandy081 I implemented a DocumentCommentProvider from the proposed API.

[RMacfarlane]

@sandy081 I haven't made a sample yet since this is still proposed API, but here's a comment provider that provides a comment on the first line of any document

export function activate(context: vscode.ExtensionContext) {
    const _onDidChangeDocumentCommentThreads = new vscode.EventEmitter<vscode.CommentThreadChangedEvent>();

    vscode.workspace.registerDocumentCommentProvider({
        onDidChangeCommentThreads: _onDidChangeDocumentCommentThreads.event,
        provideDocumentComments: async (document: vscode.TextDocument, token: vscode.CancellationToken): Promise<vscode.CommentInfo> => {
            return {
                threads: [{
                    threadId: '1',
                    resource: document.uri,
                    range: new vscode.Range(new vscode.Position(0, 0), new vscode.Position(0, 0)),
                    comments: [{
                        commentId: '1',
                        body: new vscode.MarkdownString('hello world'),
                        userName: 'me',
                        gravatar: ''
                    }]
                }],
                commentingRanges: []
            }
        },
        createNewCommentThread: async (document: vscode.TextDocument, range: vscode.Range, text: string) => {
            throw new Error('Not implemented');
        },
        replyToCommentThread: async (document: vscode.TextDocument, range: vscode.Range, thread: vscode.CommentThread, text: string) => {
            throw new Error('Not implemented');
        }
    });
}