Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Test new comment api #70601

Closed
2 tasks done
rebornix opened this issue Mar 16, 2019 · 1 comment
Closed
2 tasks done

Test new comment api #70601

rebornix opened this issue Mar 16, 2019 · 1 comment

Comments

@rebornix
Copy link
Member

rebornix commented Mar 16, 2019

Refs: #68020

Authors: @rebornix, @RMacfarlane

Complexity: 4

GH PR extension has been using the proposed commenting api for more than half a year. Based on the lessons we learnt from dog fooding in GH PR, we refactored the api to be more SCM like and it's pretty close to what we imagine a generic but powerful enough commenting api should look like. If you are interested in the problems we ran into and our design decisions, please read #68020.

Right now the new commenting api and the legacy one are both in vscode.propsed.d.ts as we don't want to break any other extension using the legacy api immediately. So to get familiar with the API

  1. Read Microsoft/vscode-extension-samples/blob/rebornix/.../vscode.proposed.d.ts. The api names should be self explanatory and jsdocs can help also.
  2. Play with sample https://github.com/Microsoft/vscode-extension-samples/tree/rebornix/commentcontroller/comment-sample

You don't need to create a comment controller as complex as GH PR but please at least test

  • Comment thread creation/disposal
  • Comments update
  • Customize actions on Comment Widget by Comment.acceptInputCommand and Comment.additionalCommands

Please provide feedback on the api, sample and docs/comments.

@sbatten
Copy link
Member

sbatten commented Mar 26, 2019

I wanted to add a Delete Thread button, but the only way I could do that was by adding it to additional commands which requires the user to hit Reply... first. I think that's a little weird.

@sbatten sbatten removed their assignment Mar 26, 2019
@sbatten sbatten closed this as completed Mar 26, 2019
@vscodebot vscodebot bot locked and limited conversation to collaborators May 11, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

4 participants