StyleCop for ReSharper: The power of ReSharper 4.5 and StyleCop combined

hvdkamp — Sat, 28 Mar 2009 13:48:48 GMT

Since yesterday it’s possible to use ReSharper 4.5 beta in combination with StyleCop by using StyleCop for ReSharper. This post gives you some information on all the three tools that I use to write source code in Visual Studio 2008 for business solutions faster and deliver better maintainable source code.

ReSharper 4.5

ReSharper is a productivity tool for Visual Studio. It provides solution-wide error highlighting on the fly, advanced code completion, superior unit testing tools, over 30 advanced code refactorings, multiple handy navigation and search utilities, single-click code formatting and cleanup, automatic code generation and templates, and a lot more productivity features for C#, VB.NET, ASP.NET, XML, and XAML. ReSharper fully integrates with Visual Studio to intelligently and powerfully extend the functionality that is native to Visual Studio. See also the complete ReSharper feature list.

ReShareper 4.5 is currently under development and available as a beta version. The biggest improvement is the performance improvement. The following picture illustrated the performance improvements, according to the ReSharper website:

Download ReSharper 4.5 beta from jetbrains.com.

Microsoft StyleCop

Microsoft StyleCop analyzes C# source code to enforce a set of style and consistency rules. It can be run from inside of Visual Studio or integrated into an MSBuild project
For more information about Microsoft StyleCop see the StyleCop blog at http://blogs.msdn.com/sourceanalysis.

Download StyleCop from the MSDN Code Gallery StyleCop website.

StyleCop for ReSharper

StyleCop combines the power of ReSharper and StyleCop. It is a ReSharper plug-in that allows Microsoft StyleCop to be run as you type, generating real-time syntax highlighting of violations and automatic fixing of StyleCop issues during ReSharper Code CleanUp (silent mode):

StyleCop for ReSharper also contains a collection of Quick-Fixes:

and Code Clean-Up Modules to help you easily fix StyleCop code styling violations:

Download StyleCop 1.5 for ReSharper 4.5 beta from the CodePlex website.

Code analysis rules over projects

Mark Henneman — Tue, 31 Jul 2007 07:18:00 GMT

To perform code analysis it is pretty sure that you want to disable some rules. But how to share those over multiple projects in a solution.

Or you want to make it a standard over solutions. Well this post helps. And I copy/past the post. :-)

If your team has a minbar of Managed Code Analysis rules that must be explicitly fixed or suppressed, it is possible to share the Managed Code Analysis rule settings over multiple MSBuild projects (.csproj, .vbproj).

To share the minbar between multiple projects, do the following:

Using Visual Studio, create a new empty project
In Solution Explorer, right-click the project and choose Properties
In the Project Properties window, choose the Code Analysis tab
In the Code Analysis tab, choose the rules you want for your minbar
In Solution Explorer, right-click the project and choose Unload Project, answering Yes to any prompt to save changes
In Solution Explorer, right-click the project and choose Edit
Search for the <CodeAnalysisRules> element and copy the text within it
Create an empty text file called [team].CodeAnalysis.Rules.targets, replacing [team] with the name of your team

In the text file enter the following, replacing [rulesettings] with the text copied above in Step 6:

<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <PropertyGroup>
      <CodeAnalysisRules>$(CodeAnalysisRules);[rulesettings]</CodeAnalysisRules>
   </PropertyGroup>
</Project>

If you do not want developers to be able to turn on extra rules over and above the minbar, do not add the '$(CodeAnalysisRules);' text.

Using Visual Studio, open your projects
In Solution Explorer, right-click a project and choose Unload Project
In Solution Explorer, right-click the unloaded project and choose Edit
Add the following <Import> element to the project, replacing [path] with the path of the targets file created above. This needs to be the last line (just above the closing </Project> element) to ensure that settings within the project do not override the team settings:

<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">

[...]

<Import Project="[path]" />
</Project>
Repeat from Step 11 for each project you want to share the rule settings with

Any projects that imported the common rule settings via Step 9, should now reflect these settings in the Code Analysis properties pane. You can also share any MSBuild properties using similar steps.

Please Note: In order to avoid Visual Studio prompting about unsafe imported MSBuild projects, you need to explicitly trust the [team].CodeAnalysis.Rules.targets file. To do this, use the following:

Run regedit
Navigate to HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\VisualStudio\8.0\MSBuild\SafeImports
Add a new string value called [team].CodeAnalysis.Rules.targets and set its value to the full path of the targets file.

Search results matching tag 'Code Analysis'

StyleCop for ReSharper: The power of ReSharper 4.5 and StyleCop combined

ReSharper 4.5

Microsoft StyleCop

StyleCop for ReSharper

Code analysis rules over projects