C#: Fix AutoFormat corrupting whitespace outside target subtree#7179
Merged
knutwannheden merged 1 commit intomainfrom Mar 27, 2026
Conversation
RoslynFormatter.Format() applied MinimumViableSpacingVisitor (MVS) and overwrote `cu`, so MVS artifacts on nodes outside the target subtree leaked into the final result during whitespace reconciliation. Save the original CU before MVS and reconcile against it, matching the pattern already used in FormatSpans().
AutoFormat corrupting whitespace outside target subtree
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
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.
Motivation
When
CSharpTemplate.Rewrite()orAutoFormatVisitorformats a specific subtree (e.g., replacing[Fact]with[Test]), theRoslynFormatter.Format()method corrupts whitespace in unrelated parts of the file. For example:IComparable<TestObj?>, IEquatable<TestObj?>→IComparable<TestObj?> , IEquatable<TestObj?>async Task<RunSummary>→async Task<RunSummary>This happens because
MinimumViableSpacingVisitor(MVS) adds spacing artifacts to ensure parseable output, and when reconciling whitespace back, those artifacts leak into nodes outside the formatting target.Summary
Format()overwrotecuwith the MVS result, so whitespace reconciliation used the MVS-modified tree as the "original" — leaking MVS artifacts into non-target nodesoriginalCubefore MVS, usemvsCuonly for printing/Roslyn formatting, reconcile againstoriginalCu. This matches the pattern already used inFormatSpans()RoslynFormatter.cs— theFormat(cu, targetSubtree, stopAfter)overloadTest plan
FormatSubtreeDoesNotCorruptUnrelatedWhitespacetest with base type lists (nullable generics) and async methodsFormatSubtreeandFormatcode paths