docCommentTemplate does not return newlines in empty template anymore

[mjbvz]

TypeScript Version: 2.7.0-dev.20171116

Code

function foo() { }

Trigger docCommentTemplate for foo.

Expected behavior:
Returns:

/**
 *
 */

Actual behavior:
Returns:

/** */

[ghost]

This was done intentionally in #19544.
You can always hit enter to get the old behavior, right?

[mjbvz]

Not with our current flow. We show document templates in our suggestion list currently. When you hit enter, we accept the suggestion and eat the enter key press

[mhegazy]

@mjbvz part of the change is allowing this to happen in multiple places as well; where in the past we only allowed it for certain declarations only.
Is this an issue you can deal with on your side, or you need us to revert back to the old behavior?

[mjbvz]

We can add a workaround for this if needed. Instead of generating an empty comment though, could docCommentTemplate now return undefined in these cases though? That would let us fallback to the standard empty multiline doc template that we already use when calls to docCommentTemplate fail

[mhegazy]

Instead of generating an empty comment though, could docCommentTemplate now return undefined in these cases though?

that is what it used to do, now it always returns an empty comment, unless the locaiton is an invalid comment location (e.g. string, JSX text, or another comment).
so not sure i understand what you mean here.

[uniqueiniquity]

@mjbvz Just to clarify (regarding the new PR I just put up), the issue is not that we changed our default template from multiline to single line, but that we were too lax about where we considered a valid code location to insert a template?

[ghost]

If it matters, I've created an issue for allowing users to set options in services at #20619 -- that could include settings for comment templates such as whether to make them multiline.