Comments: allow customize placeholder for input box

[rebornix]

Issue Type: Feature Request

Currently the inputbox always shows Reply ... as the place holder while extensions might want to customize that. This can be done either through static contribution or through API.

VS Code version: Code - Insiders 1.44.0-insider (798481c, 2020-03-16T07:10:59.884Z)
OS version: Darwin x64 19.2.0

[vscodebot]

This feature request is now a candidate for our backlog. The community has 60 days to upvote the issue. If it receives 20 upvotes we will move it to our backlog. If not, we will close it. To learn more about how we handle feature requests, please see our documentation.

Happy Coding!

[rebornix]

The commenting api now has interesting usage like CodeTour which is no longer just about code commenting thus the default placeholder we use for the input box might confuse CodeTour (and other similar extensions) customers, thus we are going to make this customizable. The proposal is introducing an option property for CommentController

export interface CommentOptions {
    /**
     * An optional string to show on the comment input box when it's collapsed.
     */
     prompt?: string;

    /**
     * An optional string to show as placeholder in the comment input box when it's focused.
     */
     placeHolder?: string;
}

export interface CommentController {
    /**
     * Comment controller options
     */
     options?: CommentOptions;
}

[lostintangent]

@rebornix Does this new API allow hiding the reply functionality entirely? Or simply changing the prompt text that is displayed?

[rebornix]

@lostintangent no, this will only control the display text but not if the comment thread is readonly or not. I would imagine that's another metadata.