Overview

EditorConfig helps maintain consistent coding styles for multiple developers working on the same project across various editors and IDEs. The EditorConfig project consists of a file format for defining coding styles and a collection of text editor plugins that enable editors to read the file format and adhere to defined styles. EditorConfig files are easily readable and they work nicely with version control systems. Code Cleanup allows developers to apply code style preferences from an EditorConfig. Currently only a handful of code styles are supported by code cleanup and should make every EditorConfig option (Code Styles, Naming Styles, and Third-Party Analyzers) available in code cleanup.

Design Proposal

1. Selecting configure code cleanup:
   

2. Will open a document tab for Code Cleanup similar to the current document tab for EditorConfig.

   • There will be a dropdown for each profile: Profile 1, Profile 2, EditorConfig Settings, and an option to Add New Profile.
   • Each profile you select should switch the view.
   • There will be a checkbox to set profile as default which will add (default) text next to the profile in the drop down.
     

3. Solution Explorer Right click menu and broom icon in the editor should only display Run Code Cleanup and delete the second profile option:
   

4. Solution Explorer right click menu should decouple Analyze and Run Code Cleanup and have a separate menu option for Run Code Cleanup.
   

5. The new menu name for Analyze should be Code Analysis.

6. Code Cleanup on save:

   • Should live in Tools Options and be called Code Cleanup on Save.
   • There will be a checkbox to Run Code Cleanup on Save with an option to select existing profiles that a user may have set in the past (profile 1 or 2) or editorconfig settings to run it on:
     

7. The Add > New EditorConfig in the Solution Explorer right-click menu will replace the current IntelliCode EditorConfig with the .NET default EditorConfig.
   

Tracking Issues

• ECUI supports naming styles #58084
• Ensure Default editorconfig in Visual Studio is the same as the one that ships in the .NET SDK #58085
• Code cleanup supports all code style rules #58086
• Code cleanup supports editorconfig #58087
• https://github.com/dotnet/roslyn/issues/5808
• Code cleanup supports third party analyzers #58089
• Code cleanup should support naming style rules #58090
• Need 'fix-all' for naming style violations. #14983