Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<p>The C# Ecosystem can be extended with custom coding rules either by:</p><ul><li>defining them directly through the SonarQube web interface using XPath expressions</li><li>or reusing custom ones defined in external tools such as FxCop, Gendarme or StyleCop</li></ul><h1>Extending Coding Rules using XPath</h1><p>New coding rules can be added using XPath. See the related <a class="confluence-link" href="/display/SONAR/Extending+Coding+Rules#ExtendingCodingRules-extendingRulesXPath" data-anchor="extendingRulesXPath" data-linked-resource-id="183205932" data-linked-resource-type="page" data-linked-resource-default-alias="Extending Coding Rules#extendingRulesXPath" data-base-url="http://docs.codehaus.org">documentation</a>.</p><p>To navigate the AST, download the <a href="http://repository.codehaus.org/org/codehaus/sonar-plugins/dotnet/csharp/sslr-csharp-toolkit/2.1/sslr-csharp-toolkit-2.1.jar">SSLR CSharp Toolkit</a>.</p><table class="wysiwyg-macro" data-macro-name="note" data-macro-parameters="title=Migrating XPath rules from version 2.0 to 2.1+" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e25vdGU6dGl0bGU9TWlncmF0aW5nIFhQYXRoIHJ1bGVzIGZyb20gdmVyc2lvbiAyLjAgdG8gMi4xK30&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body"><p>Since version 2.1, grammar rule names are in uppercase, and each word in seperated by an underscore, such as: &quot;COMPILATION_UNIT&quot;<br />In version 2.0, camel cases was used, such as: &quot;compilationUnit&quot;<br />To convert XPath expressions written for version 2.0 to ones valid in 2.1, simply add underscores between words and uppercase.</p></td></tr></table><h1>Reusing Custom Rules from External Tools</h1><p>You can reference your custom rules from FxCop and/or Gendarme and/or StyleCop in SonarQube:</p><ol><li>Write a piece of XML to reference your custom coding rules. See formats below.</li><li>Go to Settings &gt; Configuration &gt; General Settings &gt; .Net FxCop or .Net Gendarme or C# StyleCop</li><li>Paste this piece of XML in .NET/C# XXX custom rules</li><li>Click on Save .NET/C# XXX settings</li><li>Restart your SonarQube server</li><li>Activate your custom coding rules in your C# <a href="http://docs.codehaus.org/display/SONAR/Quality+Profiles">quality profiles</a></li></ol><h2>FxCop Format</h2><table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>&lt;?xml version="1.0" encoding="UTF-8"?>&lt;rules>

&lt;rule key="RULE_CLASS">
    &lt;!-- name, configKey and description are mandatory -->
    &lt;name>&lt;![CDATA[ ... put here the human readable name of this rule ... ]]&gt;&lt;/name>
    &lt;configKey>&lt;![CDATA[RULE_CLASS@$(FxCopDir)\Rules\ASSEMBLY.DLL]]&gt;&lt;/configKey>
    &lt;description>&lt;![CDATA[ ... put here the human readable description of this rule ... ]]&gt;&lt;/description>
  &lt;/rule>

&lt;rule key="... >
    ...
  &lt;/rule>

&lt;/rules>
</pre></td></tr></table><p>RULE_CLASS: name of the .NET rule class<br /> ASSEMBLY.DLL: name of the dll assembly file containing the rule class<br /> The XML fragment above assumes that the dll is located in the same directory as the standard FxCop assembly rules files.</p><p><em>Note: to help writing this XML files, &quot;vladonemo&quot; has written a C# program that generates this file based on your custom rules DLL. You can check this out <a href="https://github.com/vladonemo/SonarFxCopRulesGenerator">on GitHub</a></em><em>, but be aware that this comes with no guarantee.</em></p><h4>Example</h4><p>Let's assume that you have implemented a rule that checks whether a variable name follows a specific naming convention or not. You have implemented it in a class called &quot;VariableConventionNameCheck&quot;, and you have compiled it into a &quot;MyNamingConvetions.dll&quot; assembly file. Then, you should write the following piece of XML:</p><table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>&lt;?xml version="1.0" encoding="UTF-8"?>
&lt;rules>
  &lt;rule key="VariableConventionNameCheck">
    &lt;!-- name, configKey and description are mandatory -->
    &lt;name>Variable name conventions&lt;/name>
    &lt;configKey>&lt;![CDATA[VariableConventionNameCheck@$(FxCopDir)\Rules\MyNamingConvetions.dll]]&gt;&lt;/configKey>
    &lt;description>&lt;![CDATA[ This rule checks that variables follow the company naming conventions ]]&gt;&lt;/description>
  &lt;/rule>
&lt;/rules>
</pre></td></tr></table><h2>Gendarme Format</h2><table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>&lt;?xml version="1.0" encoding="UTF-8"?>
&lt;rules>

&lt;rule key="RULE_CLASS">
    &lt;!-- name, configKey and description are mandatory -->
    &lt;name>&lt;![CDATA[ ... put here the human readable name of this rule ... ]]&gt;&lt;/name>
    &lt;configKey>&lt;![CDATA[RULE_CLASS@ASSEMBLY.DLL]]&gt;&lt;/configKey>
    &lt;description>&lt;![CDATA[ ... put here the human readable description of this rule ... ]]&gt;&lt;/description>
  &lt;/rule>

&lt;rule key="... >
    ...
  &lt;/rule>

&lt;/rules> </pre></td></tr></table><p>RULE_CLASS: name of the .NET rule class<br /> ASSEMBLY.DLL: name of the dll assembly file containing the rule class. This file should be located in the installation directory of Gendarme, among the dll files provided by Gendarme out of the box. See the example of FxCop XML format, it is the same principle.</p><h2>StyleCop Format</h2><table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>&lt;?xml version="1.0" encoding="UTF-8"?>
&lt;rules>

&lt;rule key="ElementMustBeginWithUpperCaseLetter">
    &lt;!-- name, configKey and description are mandatory -->
    &lt;name>&lt;![CDATA[Element must begin with upper case letter]]&gt;&lt;/name>
    &lt;configKey>&lt;![CDATA[Microsoft.StyleCop.CSharp.NamingRules#ElementMustBeginWithUpperCaseLetter]]&gt;&lt;/configKey>
    &lt;description>&lt;![CDATA[Element must begin with upper case letter because ....]]&gt;&lt;/description>
  &lt;/rule>

&lt;rule key="... >
    ...
  &lt;/rule>

&lt;/rules></pre></td></tr></table>