This guide will show you how to share code style settings between your team mates, using a variety of popular tools.
I bet you are working as part of a team. Also you are probably not an exact replica of your co-workers, am I right? Some like talking a lot about code style and some don’t, but let’s face it: if you are working on shared code base, you need some way of managing the style of the code shared across the team. The level of control depends on the discipline of the team members and sometimes external requirements from stakeholders or even customers.Visual Studio
Visual Studio support settings sharing out of the box. Unfortunately you can’t define different settings per solution or project. There’s a feature request to make it happen, but Microsoft turned it down for unknown reasons.
To share you settings, select Tools | Import and Export Settings…
Select the Export selected environment settings option and hit Next.
Select the settings you want to share across your team. In the screenshot I’ve selected* All Settings | Options | Text Editor | All Languages*. This way all of the language formatting stuff is shared, while general settings about window placement and dimension are left to each developer to decide. Click next.
Name the settings file a pick a directory. When done click Finish.
Your Visual Studio settings are now stored in a file named Exported-2014-04-07.vssettings in c:\temp\settings. Now it would be really sweet if you could add this file to your solution and Visual Studio automatically, add the file to source control and Visual Studio automatically picked up the settings for all of your co-workers. Keep dreaming! Everyone needs to import your settings file using the same dialog as used for exporting.
I really hope that Microsoft reconsiders supporting per solution team settings in the root directory.
Everyone uses ReSharper nowadays. Unlike Visual Studio itself, ReSharper has great support for sharing settings across a team. Select ReSharper | Manage Options…. You probably already spend some time tuning your current installation of ReSharper settings. To make everyone use your current settings, select This computer in the list and copy settings to Solution “your project” team-shared.
Select the settings you want shared and hit OK.
When the dialog is closed and the solution is saved, a new file called your_solution_name.sln.DotSettings is saved in the root directory of your solution. Add the DotSettings file to your version control system and ReSharper automatically discover and use the settings file on all checkouts of your repository.
Disclamer: Some like StyleCop, others don’t. This is not an attempt to convince you to use StyleCop. It works on the project I’m working on, but I don’t know if it works at your project. Try it and use it if you like it.
Sharing StyleCop settings work a bit like ReSharper setting. In fact, the StyleCop plugin for Visual Studio is ReSharper aware and installs itself as a ReSharper plugin. When first installed, the plugin will tell you if ReSharper and StyleCop settings conflicts in any way. You mostly want to let the plugin solve these conflicts. If not you will enter a world of pain where StyleCop complains about formatting which ReSharper automatically enforce and vice versa. You get the picture.
When installed, the StyleCop plugin creates a new file in each project directoy named Settings.StyleCop. You may have to open the settings dialog to make the file appear, but right clicking each project and choose StyleCop Settings. As default all rules are enabled, but once you start deselecting some of the rules (trust me you’ll end up there), you will see the Settings file starts updating. As with the ReSharper settings file, you should add this file to source control. StyleCop will automatically pick of this file when opening your solution.
Web Essentials is a great Visual Studio plugin for web developers. Like ReSharper and StyleCop, Web Essentials also supports team settings. In fact I proposed that feature back in 2012 🙂
To share your Web Essentials settings, select Web Essentials | Create solution settings. This creates a file in the solution root directory named WE2013-settings.xml. This file should be added to source control and after that, Web Essentials pick up the settings automatically.