Plumb formatting to getDocCommentTemplateAtPosition #52349
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
typescript-bot
added
Author: Team
For Uncommitted Bug
|
Turns out this one fourslash call did its own normalization. Honestly these should be baselines or something but for now, just fix it. |
jakebailey
commented
Jan 23, 2023
| @@ -604,7 +604,7 @@ export interface LanguageService { | |||
| getFormattingEditsForDocument(fileName: string, options: FormatCodeOptions | FormatCodeSettings): TextChange[]; | |||
| getFormattingEditsAfterKeystroke(fileName: string, position: number, key: string, options: FormatCodeOptions | FormatCodeSettings): TextChange[]; | |||
|
|
|||
| getDocCommentTemplateAtPosition(fileName: string, position: number, options?: DocCommentTemplateOptions): TextInsertion | undefined; | |||
| getDocCommentTemplateAtPosition(fileName: string, position: number, options?: DocCommentTemplateOptions, formatOptions?: FormatCodeSettings): TextInsertion | undefined; | |||
There was a problem hiding this comment.
It's unfortunate that this has to be another optional parameter and not a required one (like other functions here), but I can't see a way to write an overloaded function that can actually detect which one is which.
RyanCavanaugh
approved these changes
Jan 23, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #52348
This will fail at the moment because it (rightfully!) fails tests.The fourslash verify call expects the newlines to match the newlines in the source file's multi-line template, which in our repo is CRLF at checkout, but the format settings are: