[VS Code] Fix various formatting issues #8318

allisonchou · 2023-02-24T00:33:00Z

Summary of the changes

This PR fixes several formatting bugs:
VSCode C# Extension throws an error when Enter is hit within a .cshtml file #8175: If the user had onTypeFormatting enabled, VS Code would try to send us a request that we didn't support. This change adds an empty handler for the time being so we stop throwing the exception.
Formatting Razor File errors with "Request textDocument/formatting failed" vscode-csharp#5561: This is due a bug presumably on VS Code's side where
they'll sometimes send us an end position that exceeds the length of the document. I've filed a bug on them (Executing vscode.executeFormatDocumentProvider with HTML files can return end range exceeding file length microsoft/vscode#175298) and have implemented a workaround for the time being.
(Possibly) Blazor page formatting continually adding tabs on format/save #7038: Wasn't able to directly repro this one, but improved error handling that could potentially resolve the issue.

allisonchou · 2023-02-24T00:33:35Z

src/Razor/src/Microsoft.AspNetCore.Razor.VSCode/src/Folding/FoldingRangeHandler.ts

            const htmlFoldingRanges = await vscode.commands.executeCommand<vscode.FoldingRange[]>('vscode.executeFoldingRangeProvider', virtualHtmlUri);
+            const csharpFoldingRanges = await vscode.commands.executeCommand<vscode.FoldingRange[]>('vscode.executeFoldingRangeProvider', virtualCSharpUri);
+
+            const convertedHtmlFoldingRanges = htmlFoldingRanges === undefined ? new Array<FoldingRange>() : this.convertFoldingRanges(htmlFoldingRanges);


Added improved error handling in our folding range provider just in case.

allisonchou · 2023-02-24T00:33:56Z

src/Razor/src/Microsoft.AspNetCore.Razor.VSCode/src/Formatting/FormattingHandler.ts

            const serializableTextEdits = Array<SerializableTextEdit>();
-            for (const textEdit of textEdits) {
+            for (let textEdit of textEdits) {
+                // The below workaround is needed due to a bug on the HTML side where


Should resolve dotnet/vscode-csharp#5561

allisonchou · 2023-02-24T00:35:47Z

src/Razor/src/Microsoft.AspNetCore.Razor.VSCode/src/extension.ts

+                // Our OnTypeFormatter doesn't do anything at the moment, but it's needed so
+                // VS Code doesn't throw an exception when it tries to send us an
+                // OnTypeFormatting request.
+                vscodeType.languages.registerOnTypeFormattingEditProvider(


Should resolve #8175

Why dont we support on type formatting?

I just don't think we ever did in VS Code? We should support it eventually and I don't think (crossing fingers) it should be too difficult. However, it would definitely require a decent amount of validation so I left it out of this PR for now. I filed a tracking issue here: #8329

allisonchou · 2023-02-24T00:37:44Z

src/Razor/src/Microsoft.AspNetCore.Razor.VSCode/src/Formatting/FormattingHandler.ts

@@ -46,8 +46,24 @@ export class FormattingHandler {
                virtualHtmlUri,
                formattingParams.options);

+            if (textEdits === undefined) {


This check should (hopefully) resolve #7038

davidwengier · 2023-02-24T00:49:54Z

src/Razor/src/Microsoft.AspNetCore.Razor.VSCode/src/Formatting/FormattingHandler.ts

+                // The below workaround is needed due to a bug on the HTML side where
+                // they'll sometimes send us an end position that exceeds the length
+                // of the document. Tracked by https://github.com/microsoft/vscode/issues/175298.
+                if (textEdit.range.end.line > lineCount) {


I'm guessing range.end.line is 1-based, but thought I'd ask to confirm that this shouldn't be >=

range.end.line is actually 0-based, but I made lineCount also be 0-based. Maybe I should rename it because I see how it could be unclear 😅

rhuanbarros · 2023-02-27T19:23:34Z

Hi, how can I set this update in my windows? There is a release?

khasmir04 · 2023-02-28T11:45:49Z

I have the same question, I just started with blazor template and this shows up everytime, how do we use this update?

danielscatigno-ncpc · 2023-02-28T14:42:27Z

@rhuanbarros @khasmir04 I Think there wasn't a release yet!
You can follow releases here Releases
But at the moment the last one is 1.25.4 and there is no beta

KlomDark · 2023-03-02T17:30:40Z

So the VSCode 1.76 release came out yesterday, but this fix does not appear to be in it. Any idea how it got missed?

rhuanbarros · 2023-03-02T17:36:27Z

I think that the update will be in the C# Extension.
https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp

KlomDark · 2023-03-02T20:50:24Z

I think that the update will be in the C# Extension. https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp

Thanks! Still wrapping my head around what does what with this. I will keep watching for an update to the C# extension.

rhuanbarros · 2023-03-11T14:27:05Z

@rhuanbarros @khasmir04 I Think there wasn't a release yet! You can follow releases here Releases But at the moment the last one is 1.25.4 and there is no beta

Do you know when we will get a realease? This bug is killing me

KlomDark · 2023-03-11T19:14:43Z

@rhuanbarros @khasmir04 I Think there wasn't a release yet! You can follow releases here Releases But at the moment the last one is 1.25.4 and there is no beta

Do you know when we will get a realease? This bug is killing me

Looking at the lack of check-ins lately, I'm really worried that the team is discouraged by Microsoft's announcement that they are making their own C# plug-in. I hope that fear is misplaced and they are just taking some time to reorient their strategy on how to utilize the new Language Server Protocol. I kow Miguel De Icaza is pretty upset about the whole mess. (https://visualstudiomagazine.com/articles/2022/06/16/csharp-vs-code-tool.aspx)

rhuanbarros · 2023-03-14T11:02:19Z

Ok, thak you. I didn't know that. Sorry.

allisonchou · 2023-03-15T00:04:16Z

Hi all! We have a release in progress that is currently going through validation. I'll circle back here when the new version is released. Thanks for your patience!

tkoenig89 · 2023-04-12T08:00:32Z

Hi, I'm not realy sure if i should adress this here. If not please let me know if I should create a new issue. But as this adresses a prerelease i was not quite sure if this was the right thing either.

As a result of this formatting issue i was back at version 1.25.2 for a while and just tried the prerelease version of 1.25.5 which should include these fixes if I'm not wrong. But sadly i still get formatting error messages using the current prerelease.

To ensure it is not related to my project i created a new one (dotnet v7.0.103, C# ext v1.25.5):

dotnet new webapp -n razor-format-test

Trying to format the Index.cshtml document gives the error message 'Request textDocument/formatting failed'. Razor Log shows:

Entering method razor/mapToDocumentRanges. # a few lines of this
Entering method textDocument/formatting.
[Error - 9:55:49 AM] [null]
[Error - 9:55:49 AM] Request textDocument/formatting failed.
  Message: Specified argument was out of the range of valid values. (Parameter 'Range end line 11 matches or exceeds SourceText boundary 11.')
  Code: -32000 
[object Object]

... where line 11 is the last line of the file.

I can provide more info if required, but didnt want to spam here if it is the wrong place.

lonix1 · 2023-04-12T08:30:23Z

Are these fixes meant to be released soon, or only in November - the prerelease page say ".NET 8" 😮

tkoenig89 · 2023-04-12T09:57:32Z

@lonix1 I was refering to the release of the vscode extension here which should not be bound to .Net 8 i guess. And this release 1.25.5 lists the formatting issues as solved, which i found not to be solved.

lonix1 · 2023-04-12T10:12:48Z

Can someone shed light on when it will be released? Is it still "going through validation" as mentioned above?

rhuanbarros · 2023-04-13T14:51:52Z

I tested the last realese on windows, but it still throw errors on VScode.
But I could get to minimize the errors by using Code Behind for all Razor files and setting the inherit both in the Razor file and in the razor.cs. (It should be the same to .cshtml file).

TestComponent.razor file

...
@inherits BaseCustomComponent
...

TestComponent.razor.cs file

...
public partial class TestComponent: ComponentBase
...

This way the parser gets the base class.
Hope this help someone.

By the way, You could manual install the realease this way:

DustinCampbell · 2023-04-13T23:02:10Z

Hello friends! Could you create a new issue instead of commenting on an old, closed PR? Thanks!

KlomDark · 2023-04-13T23:03:44Z

How bout you answer the question please?

…

On Thu, Apr 13, 2023, 6:02 PM Dustin Campbell ***@***.***> wrote: Hello friends! Could you create a new issue instead of commenting on an old, closed PR? Thanks! — Reply to this email directly, view it on GitHub <#8318 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AGJMDPTG5IBRNCLWCQIOGKLXBCAX3ANCNFSM6AAAAAAVGJFUE4> . You are receiving this because you commented.Message ID: ***@***.***>

DustinCampbell · 2023-04-17T18:15:28Z

How bout you answer the question please?

I see multiple questions above, all of which are on a PR that was closed nearly two months ago. Please files issues for the questions that are still relevant. Thanks!

allisonchou added 2 commits February 23, 2023 16:27

Fix formatting issues

4c745d4

Clean up

a23db88

allisonchou requested a review from a team as a code owner February 24, 2023 00:33

Cleanup

682c592

allisonchou commented Feb 24, 2023

View reviewed changes

davidwengier approved these changes Feb 24, 2023

View reviewed changes

Rename variable

b561099

allisonchou enabled auto-merge (squash) February 24, 2023 20:15

allisonchou merged commit 6eec692 into main Feb 24, 2023

allisonchou deleted the allichou/FixVSCodeFormatting branch February 24, 2023 21:04

This was referenced Feb 26, 2023

VSCode C# Extension throws an error when Enter is hit within a .cshtml file #8175

Closed

Formatting Razor File errors with "Request textDocument/formatting failed" dotnet/vscode-csharp#5561

Closed

allisonchou mentioned this pull request Mar 3, 2023

[Automated] PRs inserted in VS build main-33503.189 #8390

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[VS Code] Fix various formatting issues #8318

[VS Code] Fix various formatting issues #8318

allisonchou commented Feb 24, 2023

allisonchou Feb 24, 2023

allisonchou Feb 24, 2023

allisonchou Feb 24, 2023

davidwengier Feb 24, 2023

allisonchou Feb 24, 2023

allisonchou Feb 24, 2023

davidwengier Feb 24, 2023

allisonchou Feb 24, 2023

rhuanbarros commented Feb 27, 2023

khasmir04 commented Feb 28, 2023

danielscatigno-ncpc commented Feb 28, 2023 •

edited

Loading

KlomDark commented Mar 2, 2023

rhuanbarros commented Mar 2, 2023

KlomDark commented Mar 2, 2023

rhuanbarros commented Mar 11, 2023

KlomDark commented Mar 11, 2023

rhuanbarros commented Mar 14, 2023

allisonchou commented Mar 15, 2023

tkoenig89 commented Apr 12, 2023

lonix1 commented Apr 12, 2023

tkoenig89 commented Apr 12, 2023 •

edited

Loading

lonix1 commented Apr 12, 2023

rhuanbarros commented Apr 13, 2023 •

edited

Loading

DustinCampbell commented Apr 13, 2023

KlomDark commented Apr 13, 2023 via email

DustinCampbell commented Apr 17, 2023

[VS Code] Fix various formatting issues #8318

[VS Code] Fix various formatting issues #8318

Conversation

allisonchou commented Feb 24, 2023

Summary of the changes

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rhuanbarros commented Feb 27, 2023

khasmir04 commented Feb 28, 2023

danielscatigno-ncpc commented Feb 28, 2023 • edited Loading

KlomDark commented Mar 2, 2023

rhuanbarros commented Mar 2, 2023

KlomDark commented Mar 2, 2023

rhuanbarros commented Mar 11, 2023

KlomDark commented Mar 11, 2023

rhuanbarros commented Mar 14, 2023

allisonchou commented Mar 15, 2023

tkoenig89 commented Apr 12, 2023

lonix1 commented Apr 12, 2023

tkoenig89 commented Apr 12, 2023 • edited Loading

lonix1 commented Apr 12, 2023

rhuanbarros commented Apr 13, 2023 • edited Loading

DustinCampbell commented Apr 13, 2023

KlomDark commented Apr 13, 2023 via email

DustinCampbell commented Apr 17, 2023

danielscatigno-ncpc commented Feb 28, 2023 •

edited

Loading

tkoenig89 commented Apr 12, 2023 •

edited

Loading

rhuanbarros commented Apr 13, 2023 •

edited

Loading