Live example If you want to see a live example of the capabilities of the C# Ecosystem, you can have a look at the analysis of the MyBatis.Net project on Nemo. You can also check the C# and VB.NET solution on Nemo to see how Sonar can analyse multi-language .NET solutions.

Description / Features

The C# Ecosystem is a set of Sonar plugins used to monitor the quality of .NET software written in C#.

Note that, since version 2.0, multi-language .NET Solutions (C# + VB.NET) can be analyzed by Sonar. See documentation and project samples.

It is compatible with the Issues Report plugin to run pre-commit local analysis.

Installation

See the C# Ecosystem Installation Guide.

Usage

Running a Sonar analysis

To run a Sonar analysis on a C# solution, it is recommended to use the Sonar Runner. But Maven can also be used to trigger the analysis.

To help you get started, a project sample is available on github. It provides both flavors (Sonar Runner and Maven).

For more details on how to run a Sonar analysis on a C# solution, see the detailed documentation page.

Advanced Settings

Each plugin defines its own properties that are documented on the below pages:

1. .Net Core
2. C# Core
3. .Net FxCop
4. C# StyleCop
5. .Net Gendarme
6. .Net Gallio
7. .Net NDeps

FAQ and Troubleshooting

To Go Further...

• Metric definitions
• Extending C# coding rules

Roadmap

• Support of preprocessing instructions by the parser
• Branch coverage support
• Rules engine built on the squid parser
• Mutation testing using OpenMutate

Change Log

Release 2.1 (40 issues)
Type	Key	Summary	Priority
	SONARDOTNT-301	sonar-dotnet-gallio-plugin can not parse the new OpenCover reports
	SONARDOTNT-304	Handle dotCover Exit Codes in the Case of Test Failures
	SONARDOTNT-280	NPE exceptions are raised when bad file patterns are used
	SONARDOTNT-56	Improve Ndeps support for sonar.dotnet.assemblies
	SONARDOTNT-18	FxCop crash when assemblies are located on another drive
	SONARDOTNT-295	Wildcard file patterns do not support drive prefixs
	SONARDOTNT-296	Update embedded NDeps version
	SONARDOTNT-27	Support for design metrics
	SONARDOTNT-297	Display the dependency tab
	SONARDOTNT-312	Update all the plugins to make them available in the Update Center
	SONARDOTNT-328	Improve code coverage metrics
	SONARDOTNT-321	Upgrade to SSLR 1.18
	SONARDOTNT-322	Toolkit: Add the ability to choose the file's charset
	SONARDOTNT-271	Support nullable types in ternary condition
	SONARDOTNT-308	Add support for C# 5
	SONARDOTNT-319	New rule: Magic number
	SONARDOTNT-314	New rule: coupling between objects
	SONARDOTNT-320	New rule: 'break' should not be used outside of 'switch'
	SONARDOTNT-330	New rule: 'async' and 'await' should not be used as identifiers
	SONARDOTNT-268	Do not consider code snippets as commented-out code in method documentation comments
	SONARDOTNT-326	Rule S00104: Avoid file with too many lines of code
	SONARDOTNT-306	New rule: Avoid too complex function
	SONARDOTNT-327	Rule S00105: Avoid use of tabulation character
	SONARDOTNT-325	Rule S00103: Avoid too long lines
	SONARDOTNT-267	Rule: Avoid a given keyword in comments
	SONARDOTNT-315	New rule: Avoid inner assignment
	SONARDOTNT-318	New rule: Missing switch default
	SONARDOTNT-316	New rule: Avoid reassigning parameters
	SONARDOTNT-323	Rule S00100 : Method name must comply with a naming convention
	SONARDOTNT-324	Rule S00101 : Class name must comply with a naming convention
	SONARDOTNT-299	VisualStudioProject.java - Can pick wrong build configuration
	SONARDOTNT-289	c# dotnet.api.microsoft.ModelFactory does not fail if assemblyname is not defined in project file
	SONARDOTNT-298	Use plugin properties instead of XML files to store new rule definitions
	SONARDOTNT-285	Update Sqale model
	SONARDOTNT-329	Improve parser (C# 5.0) Support asynchronous methods
	SONARDOTNT-292	Add support for Silverlight 5
	SONARDOTNT-307	Add support for .NET 4.5
	SONARDOTNT-335	Dependencies on skipped modules raise exceptions
	SONARDOTNT-251	When assemblies are compiled in Release, confusing error message 'GallioException: No test assembly was found'
	SONARDOTNT-313	Update project sample configuration file

Release 2.0 (12 issues)
Type	Key	Summary	Priority
	SONARDOTNT-49	On C# projects, replace the "distribution of complexity by class" by the "distribution of complexity by file"
	SONARDOTNT-282	Merge C# Squid plugin into C# Core plugin
	SONARDOTNT-276	NPE if "sonar.gallio.coverage.tool" is set to "none"
	SONARDOTNT-274	Allow multi-language solution analysis
	SONARDOTNT-269	Rename the devkit to sslr-csharp-toolkit
	SONARDOTNT-273	Upgrade to SSLR 1.14 and Squid Bridge 2.2
	SONARDOTNT-270	Add XPath Check
	SONARDOTNT-3	Gendarme sensor crashes with skipped modules
	SONARDOTNT-39	Offer a GUI that helps visualizing the AST of a C# file
	SONARDOTNT-278	Disable coverage analysis when "sonar.gallio.coverage.tool" is set to "none"
	SONARDOTNT-277	Update plugins properties to use specific PropertyType
	SONARDOTNT-67	c# StyleCop rules not handled: LayoutRules#ElementMustNotBeOnSingleLine, LayoutRules#AllAccessorsMustBeMultiLineOrSingleLine

Release 1.4 (13 issues)
Type	Key	Summary	Priority
	SONARDOTNT-117	ndeps fatal error when assemblies not found
	SONARDOTNT-231	Make the .Net plugin compatible with the Developer Cockpit plugin
	SONARDOTNT-113	Absolute paths and the reuse reports mode
	SONARDOTNT-185	Implement support for dotcover teamcity coverage xml reports
	SONARDOTNT-202	Add new placeholders for file patterns
	SONARDOTNT-211	Add Sqale model inside the C# Core plugin
	SONARDOTNT-199	Open-source C# Squid plugin
	SONARDOTNT-175	Add new Common Rules repository
	SONARDOTNT-209	Reuse the artifactId of the solution to build the keys of project in this solution
	SONARDOTNT-240	Complete platform parameter support
	SONARDOTNT-219	Adds suport for StyleCop 4.7 and above
	SONARDOTNT-230	Allow to set parameters for StyleCop rules
	SONARDOTNT-148	Fix URL for Update Center

Release 1.3 (8 issues)
Type	Key	Summary	Priority
	SONARDOTNT-186	Display "assert count" metric for tests
	SONARDOTNT-229	Use the latest verison of C# Squid Plugin (improvements on the C# parser)
	SONARDOTNT-191	Support for Integration Tests
	SONARDOTNT-136	Error while parsing result file from Gallio
	SONARDOTNT-79	Duplication detection should ignore the "using" statements in C#
	SONARDOTNT-178	Libraries/Dependencies/Design pages
	SONARDOTNT-226	Change name of rules repository to Sonar
	SONARDOTNT-151	Parsing errors because of '?' characters

Release 1.2 (6 issues)
Type	Key	Summary	Priority
	SONARDOTNT-144	Coverage with NCover brings measures for only one project in a solution
	SONARDOTNT-115	Only the first assembly specified via 'sonar.gallio.coverage.excludes' is actually excluded
	SONARDOTNT-174	OpenCover support
	SONARDOTNT-83	CSharp Plugin does not support Linked Resources
	SONARDOTNT-149	Wrong test coverage when using links
	SONARDOTNT-154	No backward/maven-dotnet compatibility on SDK directories config keys

Release 1.1 (14 issues)
Type	Key	Summary	Priority
	SONARDOTNT-93	Coverage does not work on all projects
	SONARDOTNT-165	O% test coverage on codeless interfaces
	SONARDOTNT-100	'sonar.gallio.coverage.excludes' does not work for NCover
	SONARDOTNT-132	Too many uncovered lines found
	SONARDOTNT-221	Configuration mechanism to locate test assemblies
	SONARDOTNT-206	Add support for platform parameter in MSBuild
	SONARDOTNT-86	No merge of exclusion filters
	SONARDOTNT-238	Add "**/*.g.cs" as part of the default exclusions
	SONARDOTNT-139	Configuration mechanisms of gendarme and fxcop plugins for assemblies locations
	SONARDOTNT-106	sonar.fxcop: the assemblyDependencyDirectories parameter does not take an absolute path
	SONARDOTNT-75	Reuse mode does not work for Gallio coverage reports
	SONARDOTNT-207	Gallio runner parameter
	SONARDOTNT-164	FxCop does not permit to specify an assembly dependencies directory relative to the solution
	SONARDOTNT-141	Coverage report is looked relative to the working directory instead of relative to the pom.xml

Release 1.0 (24 issues)
Type	Key	Summary	Priority
	SONARDOTNT-72	C# plugins make analysis on java projects impossible
	SONARDOTNT-210	Projects and folders should not be mixed
	SONARDOTNT-223	New rule API for Stylecop, fxcop and gendarme
	SONARDOTNT-176	Cleanup properties
	SONARDOTNT-146	Incoherence between .Net and Java comments report
	SONARDOTNT-200	Remove dependency to maven api in module dotnet-commons
	SONARDOTNT-145	Incomplete build configurations support
	SONARDOTNT-118	NPE on the Gallio CoverageDecorator
	SONARDOTNT-73	Parsing error on a Gallio result file
	SONARDOTNT-181	Make it possible to implement rules based on SonarSource C# Parser
	SONARDOTNT-190	Make it possible to run a Sonar analysis with the Simple Java Runner
	SONARDOTNT-195	Add native support of Sonar way to handle multi-module in a .NET solution
	SONARDOTNT-208	Better support for copy-paste detection
	SONARDOTNT-216	Remove requirement on Java 6 for Sonar plugin execution
	SONARDOTNT-235	Embed SonarSource C# Parser to remove dependency on SourceMonitor
	SONARDOTNT-97	FxCop/Gendarme failures on projects without assemblies
	SONARDOTNT-157	Property sonar.branch cannot be used
	SONARDOTNT-134	Bad behavior on weird FxCop exit codes
	SONARDOTNT-68	It is not currently possible to pass the build configurations to use for the analysis
	SONARDOTNT-198	Wiki : parser limitations
	SONARDOTNT-163	A solution cannot have the same name as one of its project
	SONARDOTNT-89	Error while trying to get the next element name
	SONARDOTNT-262	.net plugin should not force using Java 1.6 on other projects
	SONARDOTNT-193	Support of user extensions for fxcop/gendarme/stylecop