Skip to content

Format document after each provider #59091

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
Jan 27, 2022
Merged

Format document after each provider #59091

merged 4 commits into from
Jan 27, 2022

Conversation

davidwengier
Copy link
Member

Fixes #58974

@davidwengier davidwengier requested a review from a team as a code owner January 26, 2022 23:35
@ghost ghost added the Area-IDE label Jan 26, 2022
@davidwengier davidwengier enabled auto-merge (squash) January 27, 2022 00:35
sharwell
sharwell reviewed Jan 27, 2022
View reviewed changes
src/EditorFeatures/TestUtilities/Formatting/AbstractNewDocumentFormattingServiceTests.cs
@@ -40,6 +40,14 @@ internal Task TestAsync<T>(string testCode, string expected, (Option2<T>, T)[]?
parseOptions);
}

internal Task TestAsync(string testCode, string expected, (OptionKey, object)[]? options = null, ParseOptions? parseOptions = null)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(OptionKey, object)[]? options = null

In the future, I recommend OptionsCollection for this. Very easy to initialize a new instance and set strongly-typed values. I'll look into updating this case after this PR merges.

sharwell
sharwell suggested changes Jan 27, 2022
View reviewed changes
Copy link
Contributor

@sharwell sharwell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question before approving

@davidwengier davidwengier disabled auto-merge January 27, 2022 02:23
@davidwengier davidwengier requested a review from sharwell January 27, 2022 03:27
CyrusNajmabadi
CyrusNajmabadi reviewed Jan 27, 2022
View reviewed changes
src/Features/Core/Portable/Formatting/AbstractNewDocumentFormattingService.cs
// before we call the next provider, otherwise they might not see things as they are meant to be.
// Because formatting providers often re-use code fix logic, they are often written assuming this will
// happen.
document = await CodeAction.CleanupDocumentAsync(document, cancellationToken).ConfigureAwait(false);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

much nicer. thanks!

@davidwengier davidwengier merged commit 6d5668e into dotnet:main Jan 27, 2022
@davidwengier davidwengier deleted the FixNewDocumentFormatting branch January 27, 2022 21:10
@ghost ghost added this to the Next milestone Jan 27, 2022
333fred added a commit to YairHalberstadt/roslyn that referenced this pull request Jan 28, 2022
@333fred
Merge remote-tracking branch 'upstream/main' into allow-nameof-to-acc…
9f8216f 
…ess-instance-members

* upstream/main: (669 commits)
  Fix 'hasStaticConstructor' check in MethodCompiler (dotnet#59116)
  Update dependencies from https://github.com/dotnet/arcade build 20220127.8 (dotnet#59134)
  Update StreamJsonRpc (dotnet#59073)
  Resources
  Filter cancellation exceptions in generator driver (dotnet#58843)
  Revert "Remove dependency on EditorFeatures from Remote.ServiceHub project (dotnet#59059)"
  Strings
  Inline
  Convert to switch expression
  Explicitly test empty string case.
  Fix comment
  Simplify test code
  Run all
  Add tests
  Delete test generator
  Add support for specifying server in tests
  Remove options
  review feedback
  Format document after each provider (dotnet#59091)
  [main] Update dependencies from dotnet/arcade (dotnet#59015)
  ...
@RikkiGibson RikkiGibson modified the milestones: Next, 17.2.P1 Feb 4, 2022
@Youssef1313 Youssef1313 mentioned this pull request Mar 23, 2022
Closed
@mwasson74
Copy link

@davidwengier I see this was closed on 17.2.P1 but is there a workaround or alternative until that's released?

@davidwengier
Copy link
Member Author

17.2 is released in the preview channel, so if you install Visual Studio Preview this will work. The preview channel will be promoted to the non preview channel soon, and there is no real way for an individual fix to jump ahead I'm afraid.

jasonmalinowski added a commit to jasonmalinowski/roslyn that referenced this pull request Jul 22, 2025
@jasonmalinowski
Do not do full cleanup when we are formatting a new document
afa9592 
The CodeAction.CleanupDocumentAsync was added in
dotnet#59091 to ensure the document
had elastic trivia formatted before we applied the result to the
file. It appears the intent was to do just the trivia formatting, but
the CleanupDocumentAsync does a lot of expensive operations around
simplification and adding imports, which aren't needed in this case.

Fixes https://devdiv.visualstudio.com/DevDiv/_workitems/edit/1540532
@jasonmalinowski jasonmalinowski mentioned this pull request Jul 22, 2025
Merged
jasonmalinowski added a commit that referenced this pull request Jul 22, 2025
@jasonmalinowski
Do not do full cleanup when we are formatting a new document (#79508)
c765c39 
The CodeAction.CleanupDocumentAsync was added in
#59091 to ensure the document had
elastic trivia formatted before we applied the result to the file. It
appears the intent was to do just the trivia formatting, but the
CleanupDocumentAsync does a lot of expensive operations around
simplification and adding imports, which aren't needed in this case.

Fixes https://devdiv.visualstudio.com/DevDiv/_workitems/edit/1540532
333fred added a commit that referenced this pull request Jul 24, 2025
@333fred @CyrusNajmabadi
@AlekseyTs @jcouv @JoeRobich @jjonescz @dotnet-maestro @akhera99 @tmat @ToddGrun @dibarbet @jasonmalinowski @davidwengier @DoctorKrolic @mmitche @dkurepa @Copilot
Merge main to runtime async branch (#79582)
caeac86 
* Support interpolated string handlers in extension blocks (#78425)

* Support interpolated string handlers in extension blocks

Closes #78137.

* A few tests fail PEVerify

* Update handling of receivers in static scenarios and add tests for indexers/static methods

* Update after merge

* Ensure nullable index adjustment happens always, not just when the receiver parameter is used.

* Additional il verification progress

* PR feedback. The only remaining item is additional testing for ref safety to record the current state.

* Additional PR feedback

* More testing, suggested simplification

* Simplify and more testing.

* Feedback

* Suggested optimization

* Add skipped test for #78433.

* Fix loss of nullability attributes when getting the 'constructed reduced from' method. (#79400)

* Add tracking issue for disabled assert (#79427)

Reference tracking issue #79426 for the disabled assert.

* Fix code gen for some compound assignment scenarios involving extension properties. (#79339)

* Extensions: extension marker type name (#79308)

* Move to xunit.runner.visualstudio 3.1.3

* Avoid eliding pointer-to-ref conversions (#79311)

* Avoid eliding pointer to ref conversions

* Consider only user-defined locals

* Update pre-existing tests

* Test evaluation order

* Explain user-defined local check

* Avoid reusing temps whose refs might be captured (#76009)

* Avoid reusing temps whose refs might be captured

* Revert some changes

* Simplify the heuristic

* Avoid reusing any local whose address has been taken

* Update tests

* Inline a function

* Revert unrelated change

* Remove non-reusable locals after checking for them

* Keep ref count for addressed locals list

* Extend an assert

* Add high-level comment to MightEscapeTemporaryRefs

* Filter non-reusable locals

* Simplify `int`s to `bool`s

* Replace coalesce with an assert

* Mark nested calls as always used

* Fix this parameter of nint methods

* Test chained call

* Simplify by using this parameter symbol

* Fix readonly targets

* Fixup a test

* Remove an unused parameter

* Fix nullability after merge

* [main] Update dependencies from dotnet/arcade (#79385)

[main] Update dependencies from dotnet/arcade


 - Revert .NET SDK bump

 - Set NUGET_PACKAGES for bootstrap builds in CI

 - Set NUGET_PACKAGES for Correctness_Build_Artifacts

 - Add tracking issue for workarounds

 - Call nuget restore with the -publish flag

 - We need to restore where we publish

 - Add comment for strange restore behavior

 - Update comment

* Fixes rename attribute bug (#79418)

* fix bug

* update test

* simplify

* comment

* clarity

* gracefully handle the document or languageservice being null

* Adds EqualityComparer<T>.Create polyfill

* Revert compiler changes

* Update dependencies from https://github.com/dotnet/arcade build 20250717.3

Microsoft.DotNet.Arcade.Sdk , Microsoft.DotNet.Helix.Sdk , Microsoft.DotNet.XliffTasks
 From Version 10.0.0-beta.25358.3 -> To Version 10.0.0-beta.25367.3

* Move to .NET 10p6 (#79438)

* Move to .NET 10p6

Let's try to get ahead of the next one.

* Update contributing docs as well.

* Allow razor to use SolutionChecksumUpdater (#79373)

* Allow razor to use SolutionChecksumUpdater

SolutionChecksumUpdater allows incremental updates of sourcetexts in the server process, but was previously limited to just documents in the solution. Instead, by loosening this to allow TextDocuments, razor editing can have incremental updates of the primary razor document when cohosting is turned on.

* use is/or instead of ==/||

* Remove dependency on ClassificationOptions and DefinitionItem from Semantic Search service (#79439)

* Update insertions for VS release changes

* Fix static extension method not showing up on enum type

* Add workitem

* cleanup

* Use ConfigureAwait(true) when in a blocking JTF run call

* GetTextSynchronously

* Update src/VisualStudio/Core/Def/LanguageService/AbstractLanguageService`2.VsLanguageDebugInfo.cs

Co-authored-by: Jason Malinowski <[email protected]>

* Make synchronous

* Docs

* Allow Razor to create a formatting options, and send it to OOP

* Update dependencies from https://github.com/dotnet/arcade build 20250717.4

Microsoft.DotNet.Arcade.Sdk , Microsoft.DotNet.Helix.Sdk , Microsoft.DotNet.XliffTasks
 From Version 10.0.0-beta.25358.3 -> To Version 10.0.0-beta.25367.4

* Remove assumption about a tree shape that compound assignment produces (#79432)

* Skip GetProjectXml_FileBasedProgram_SdkTooOld_01 test

* Bump Microsoft.VisualStudio.Extensibility.Testing.Xunit to 0.1.796-beta

This brings along some fixes needed for it to work under newer versions
of xunit.runner.visualstudio.

* Reduce path length of Roslyn ServiceHub Services folder (#79460)

I've been hitting lots of gold bars in VS indicating various Roslyn features are unavailable when running when F5'ing the roslyn project. I finally spent some time digging into why this happens on my machine, and it turns out that out service hub service paths are just a bit too long. This PR just reduces that path length by 14 characters, which is enough for all the services to be under the 260 character long path limit.

* downgrade SDK

* Fix Typo

* Simplify stale project handling (#79386)

* Update System.Memory to prevent bootstrap failure

* Include dependencies of System.Memory in VSIX deployment project

* remove unnecessary additional reference

* Update dependencies from https://github.com/dotnet/arcade build 20250717.5

Microsoft.DotNet.Arcade.Sdk , Microsoft.DotNet.Helix.Sdk , Microsoft.DotNet.XliffTasks
 From Version 10.0.0-beta.25358.3 -> To Version 10.0.0-beta.25367.5

* Use new compiler API

* Correctly change return type of partial definition part

* Feedback

* Move RoslynParallel and ProducerConsumer to threading source package (#79474)

* Downgrade SDK

* Do not remove usings/imports in code-cleanup when file has syntax errors

* Add testws

* Find add-using results in SG docs

* Docs

* Do not place SuppressMessage attributes on an extension block

* remove asynchrony from service registration

* Ignore all targets of MS.CA.Threading.Package in rebuild (#79495)

* Don't mark special compiler synthesized members as obsolete

* Add test

* Use globs in .projitems for source packages (#79480)

* Fix name declaration completion in primary constructor parameters

* nrt

* nrt

* Generate complogs on build failure (#79446)

* Generate complogs on build failure

This should make it easier to reproduce CI compiler failures locally.

* Test bad change for complog creation

* Use --yes

* Include full exception

* Revert "Test bad change for complog creation"

This reverts commit a465981.

* remove from pkgdefs

* Extensions: fix issue with GetParameterOrExtensionParameter (#79402)

* Fix exception when requesting additional file diagnostics

* Do not do full cleanup when we are formatting a new document

The CodeAction.CleanupDocumentAsync was added in
#59091 to ensure the document
had elastic trivia formatted before we applied the result to the
file. It appears the intent was to do just the trivia formatting, but
the CleanupDocumentAsync does a lot of expensive operations around
simplification and adding imports, which aren't needed in this case.

Fixes https://devdiv.visualstudio.com/DevDiv/_workitems/edit/1540532

* Extensions: add test for function type scenario (#79323)

* Reenable analyzer that was disabled when we moved to .Net 10 Preview 5

* Allow captured primary constructor parameters to be still used in base-list

* Simplify ancestor checks

* Fix 'this' keyword not being recomended where allowed

* in progress

* Fix 'switch' keyword recomendations after an expression

* Fix escaping of enum members in completion

* Suggest proper 'Async'-suffixed name for Task-returning symbols

* Fix location of 'partial' modifier when generating new partial members

* Update VMR orchestrator property (#79517)

* Make attachdebugger flag work on non-Windows (#79499)

These compiler flags used Debugger.Launch, which only works on windows. I borrowed the equivalent code from the LSP launcher, which already has this functionality (https://github.com/dotnet/roslyn/blob/cf34acbc5d0f64ff87013cdd02ae61cff562daaf/src/LanguageServer/Microsoft.CodeAnalysis.LanguageServer/Program.cs#L75-L89).

* Downgrade System.Memory to make VS happy

* Fix auth issue in PR val builds

* Fix

* Update Basic.Reference.Assemblies (#79525)

* Update Basic.Reference.Assemblies

Update to version 1.8.3 of Basic.Reference.Assemblies and make references to .NET 10p6 available in our tests.

* Feedback

* Feedback

* Allow add using to work on Razor generated documents

* Improve compiler server/client logging (#79335)

* Remove unused constant

* Include timestamp in logs

* Log messages to msbuild as well

* Log server's process ID

* Log process creation on Unix

* Exclude some messages from the binlog

* Fix test loggers

* Revert "Exclude some messages from the binlog"

This reverts commit 12c1050.

* Cleanup

* Simplify

* Simplify

* Simplify

* Add tests

* Add tests

* Simplify

* Simplify

* initial change

* Renames

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Extensions: address or split remaining open issues directly associated with test plan (#79452)

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* Update tests

* In progress

* in progress

* in progress

* in progress

* in progress

* in progress

* in progress

* in progress

* Cleanup split between lexer and sliding-text-window (#79205)

Co-authored-by: Jan Jones <[email protected]>

* Add docs

* Fix name qualification when moving a using alias outside of a file scoped namespace

* Fix strucutre out of bounds

* Tests

* Add Version.Details.props (#79539)

* Fix issue with 'use explicit type' and nullable tuples

* Add back

* Convert ValueTaskFactory methods to static extensions (#79541)

* Update logic

* Also downgrade System.Numerics.Vectors for VS

* Add Enum static extensions (#79546)

* Fix main build break

* Fix main build break AGAIN

* Projects to deploy (#79430)

* [main] Source code updates from dotnet/dotnet (#79483)

[main] Source code updates from dotnet/dotnet


 - Workaround cref resolve issue due to new RuntimeHelpers in SCI

* [main] Source code updates from dotnet/dotnet (#79563)

[main] Source code updates from dotnet/dotnet

* Revert "Fix main build break AGAIN (#79559)"

This reverts commit e67e2a4, reversing
changes made to 1a74e66.

* Tweak build break fix

* Tweak build break fix

* inline test strings

* Cleanup test methods

* Fix issue where we weren't properly adding elastic trivia to newly generated members

* Fix behavior

* Add test

* Mark SyntaxTokenParser as non-experimental (#79521)

Co-authored-by: copilot-swe-agent[bot] <[email protected]>

---------

Co-authored-by: Cyrus Najmabadi <[email protected]>
Co-authored-by: AlekseyTs <[email protected]>
Co-authored-by: Julien Couvreur <[email protected]>
Co-authored-by: Joey Robichaud <[email protected]>
Co-authored-by: Jan Jones <[email protected]>
Co-authored-by: dotnet-maestro[bot] <42748379+dotnet-maestro[bot]@users.noreply.github.com>
Co-authored-by: Joey Robichaud <[email protected]>
Co-authored-by: Ankita Khera <[email protected]>
Co-authored-by: tmat <[email protected]>
Co-authored-by: Tomáš Matoušek <[email protected]>
Co-authored-by: dotnet-maestro[bot] <dotnet-maestro[bot]@users.noreply.github.com>
Co-authored-by: Todd Grunke <[email protected]>
Co-authored-by: David Barbet <[email protected]>
Co-authored-by: Cyrus Najmabadi <[email protected]>
Co-authored-by: Jason Malinowski <[email protected]>
Co-authored-by: David Wengier <[email protected]>
Co-authored-by: Jason Malinowski <[email protected]>
Co-authored-by: DoctorKrolic <[email protected]>
Co-authored-by: Matt Mitchell <[email protected]>
Co-authored-by: Jan Jones <[email protected]>
Co-authored-by: Djuradj Kurepa <[email protected]>
Co-authored-by: Copilot <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@CyrusNajmabadi CyrusNajmabadi CyrusNajmabadi approved these changes

+1 more reviewer

@sharwell sharwell sharwell approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
Area-IDE
Projects
None yet
Milestone
17.2.P1
Development

Successfully merging this pull request may close these issues.

Creating a new C# class from item template is missing a space between the access modifier and 'class' keyword
5 participants
@davidwengier @mwasson74 @sharwell @CyrusNajmabadi @RikkiGibson