Bringing Code Cleanup on Save To Visual Studio 2022 17.1 Preview 2

Denizhan

Starting in Visual Studio 2022 17.1 Preview 2, developers can now perform Code Cleanup automatically when a file is being saved! Code Cleanup automatically on Save is a new feature integrated into Visual Studio 2022 that can clean up your code file to make sure it is formatted correctly and that your coding style preferences are applied. Some customizable preferences include: format document, sort usings, remove unnecessary usings, and more. This feature can help minimize stylistic violations within PRs and more to allow developers to spend less time fixing code not meeting specific standards and more time doing what they do best. To give it code cleanup on save a try, download Visual Studio 2022 Preview:

Moving image demonstrating code cleanup on save

How to enable Code Cleanup on Save

First, navigate to Analyze > Code Cleanup > Configure Code Cleanup to personalize desirable customizations to your code cleanup profile(s).

Screenshot for configuring code cleanup profiles

Next, navigate to Tools > Options > Text Editor > Code Cleanup. Add a check in the “Run Code Cleanup profile on Save”. Be sure to select the appropriate profile you want to execute automatically whenever you save!

Screenshot of dialogue to enable code cleanup on save

 

Try it out and share your feedback!

We would love to get your feedback on Code Cleanup on Save so please give it a try and let us know what you think! You can share any feedback via Developer Community to help us make Visual Studio better for you!

 

12 comments

Leave a comment

  • Josiah Bills

    I am quite looking forward to using this feature, but I am having trouble getting this to work with clang-format and C++. Any idea how to get it working?

  • Black Elijah (BT-AI/ETW2-PAI)

    Is it possible to export the code cleanup configuration and save it to a file? We’d like to be able to share a common set of rules between all of our developers.

    Currently we accomplish this with the CodeMaid extension, but it might be nice for this to be backed into Visual Studio 🙂

  • Alex MovsessianMicrosoft employee

    Bug – Repro Steps

    Open the Configure Code Cleaup window (Doesn’t matter profile 1 or 2)

    Add from Available fixers to Included fixers using the up arrow button.

    Press OK and close the window.

    When you open it again, you’ll find nothing was added :/

    This is basically preventing us from using the feature.

    Remark

    Unless we can save the profile as part of the project, in a manner similar to how .editorconfig file works, we can’t use it across the team efficiently.

  • Martin Ba

    Automatic code formatting and cleanup is great — but only if the whole team uses exactly the same settings for the edited code base.

    How does Visual Studio Code Cleanup support this? Is it possible to check-in some settings into source control (á la .editorconfig) that will be picked up so that these settings are “correct” for all team members on a given code base state?

    Nothing is more annoying that playing ping pong with code formatting rules between different team members 🙂