C-Sharp Plugins Ecosystem

The C# plugins ecosystem is a set of Sonar plugins used to monitor the quality of .NET software written in the C# language.
The goal is to make C# a first-class citizen in Sonar - like Java can be.

The C# plugins ecosystem is not just the next version of the former .NET plugins (0.6). It is a complete rewrite and therefore will introduce many changes - even if we tried to keep plugin option backward-compatibility as much as possible. Please read more on the differences between the 2 sets of plugins.

Below are the main steps to quickly get started.
You will find the links to the rest of the documentation at the end of this page.

1. Install

1. Install Sonar
   • To make it simpler, do not bother with Maven but rather install the Simple Java Runner
     
     
2. Install the C# plugins
   • Copy all the desired plugins of the C# plugins ecosystem in Sonar plugins extension folder.
   • Copy the SonarSource C# Squid plugin there too.
     
     
3. Install the tools required by the selected C# plugins
   • For instance, Gallio or FxCop
   • Gendarme and StyleCop do not necessarily need to be installed
     
     
4. Check the prerequisites, mainly:
   • Your .NET solution must be compiled

2. Configure

1. Create a Sonar file for your solution
   • A very simple one can be:
   • Place it in the same folder as the Solution file (".sln")
     
     
2. If you don't want to use the default settings of a plugin, you can override them
   • See the C# plugins options to know more about this.

3. Run!

1. Launch the analysis...
   • Assuming you installed the Simple Java Runner, this is as simple as:
     
     
2. ...and check the results!
   • Once the analysis is completed, just open your favorite web browser (http://localhost:9000 if you installed the standalone version)
   • Enjoy!