2

I need to setup a common code styling pattern which team needs to follow and will give warning or error to the developer while writing/compiling the code or pushing the code on the repository.

I have gone through couple of sites explaining about the EditorConfig file for setting up the styling in Visual Studio.

Also Gone through the link Code Style Option to give the style to the code.

The problem is Code Style Option have predefined styling.

I need to setup some custom styling in code like

  1. A space before and after = operator
  2. A space after comma in function parameter.
  3. A proper indentation will be applied automatically to that file after the build. etc

If the answer lies in the Editorconfig for this Please let me know a guide to data setup in that file

Srikrishna Sharma
  • 159
  • 1
  • 12
  • [Links](https://stackoverflow.com/questions/58626222/how-to-import-an-editorconfig-file-into-visual-studio-for-all-solutions/58634994#58634994) are helpful. The link introduces the use of ".editorconfig" – Housheng-MSFT Sep 09 '22 at 09:41

1 Answers1

2

Most of what you asked for is, for the most part, already enabled by default, but you can configure it using an .editorconfig as you mentioned. You won't be able to make it as specific as you requested, however by the sounds of it, I would think you'd want this formatting applied for all cases, and not these specific cases you mention. If that isn't the case, then I don't think there any native way to specify the specific formatting you asked for.

Add an .editorconfig file to your project, and open it. Note that you should be able to create .editorconfigs for each project to specify formatting in each, or you can make a global one.

For adding a space before and after an equal sign, the control for this is "Set spacing for operators". This will apply however to all operators. I don't think you can narrow it down to only equal signs:

spacing for binary operators

For spaces after parameters, the control for this is "Insert space after comma". Again, this will be for all commas used throughout your code, not just for parameters:

comma spacing

Lastly, you can control the indentation settings you wish by looking under the Whitespace → Indentation and spacing section:

Indentation

For formatting on build you have some options. You can download a format on save extension, but that wouldn't format on "a build" technically. However I think because when a build is performed, a save of all files automatically occurs, and this should also format them.

One other way I've found is using the dotnet format command as a Post-Build event.

dotnet format post build event

Timothy G.
  • 6,335
  • 7
  • 30
  • 46
  • "*or you can make a global one*" - can you explain how to make a global .editorconfig (which is what I want). – Poul Bak Sep 08 '22 at 13:00
  • 1
    @PoulBak see https://stackoverflow.com/a/58634994/6530134 _"To share settings across solutions and projects, you need to create a .editorconfig file in a top-level directory/solutions folder"_ It should be a matter of placing the .editorconfig file in the correct location (probably the root of all your project folders). – Timothy G. Sep 08 '22 at 13:04
  • 1
    @PoulBak here is [Microsoft Documentation](https://learn.microsoft.com/en-us/visualstudio/ide/create-portable-custom-editor-options?view=vs-2022#add-an-editorconfig-file-to-a-project) as well for it. – Timothy G. Sep 08 '22 at 13:15
  • So simple. Thanks, I didn't know. – Poul Bak Sep 08 '22 at 13:20