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.

<h1>Extend Coding Rules - Via extensions/rules</h1><p>From version 0.2, its possible <span style="font-size: 10.0pt;line-height: 13.0pt;">to extend the rules available in quality profiles for any tool. To do this a directory matching the tool name and a XML with the description of the rules within this directory should be provided. For example:</span></p><ul><li>[Sonar Server Install Dir]\extensions\rules\cppcheck\rules.xml for the cppcheck sensor</li></ul><h2>Rules XML Format<span style="color: rgb(51,51,51);font-size: 10.0pt;font-weight: normal;line-height: 13.0pt;"> </span></h2><table class="confluenceTable"><tbody><tr><th class="confluenceTh">Xml Description</th><th class="confluenceTh"><p>Example</p></th></tr><tr><td colspan="1" class="confluenceTd"><p>&lt;rules&gt; <br />&lt;rule key=&quot;RULE_ID&quot;&gt;<br />&lt;name&gt;&lt;![CDATA[ ... put here the human readable name of this rule ... ]]&gt;&lt;/name&gt;<br />&lt;configKey&gt;&lt;![CDATA[RULE_ID@$(EXTERNALSENSORCLASS)]]&gt;&lt;/configKey&gt;<br />&lt;category name=&quot; ... category type ... &quot; /&gt;<br />&lt;description&gt;&lt;![CDATA[ ... put here the human readable description of this rule ... ]]&gt;&lt;/description&gt;<br />&lt;/rule&gt;<br />&lt;/rules&gt;</p></td><td colspan="1" class="confluenceTd"><p>&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; standalone=&quot;yes&quot;?&gt;<br />&lt;rules&gt;<br /> &lt;rule key=&quot;Te0001DataContextCannotBeSet&quot;&gt;<br /> &lt;name&gt;&lt;![CDATA[Te0001DataContextCannotBeSet]]&gt;&lt;/name&gt;<br /> &lt;configKey&gt;<br /> &lt;![CDATA[Te0001DataContextCannotBeSet@PC_LINT]]&gt;<br /> &lt;/configKey&gt;<br /> &lt;category name=&quot;Maintainability&quot; /&gt;<br /> &lt;description&gt;<br /> &lt;![CDATA[ Data Context Should no be set, please use another approach ]]&gt;<br /> &lt;/description&gt;<br /> &lt;/rule&gt;<br />&lt;/rules&gt;</p></td></tr><tr><td class="highlight confluenceTd" colspan="1">Attributes</td><td class="highlight confluenceTd" colspan="1">Description</td></tr><tr><td colspan="1" class="confluenceTd">key [RULE_ID]</td><td colspan="1" class="confluenceTd">Id of the rule, <strong>should match the id in the external reports</strong></td></tr><tr><td colspan="1" class="confluenceTd">name</td><td colspan="1" class="confluenceTd">Can be really anything, in the quality profile in sonar its the first name that is displayed per rule</td></tr><tr><td colspan="1" class="confluenceTd">configKey</td><td colspan="1" class="confluenceTd"><span style="color: rgb(0,51,102);">This key is used later by the sensor to configure the code analyzer <span style="color: rgb(0,0,0);">(</span><a href="http://docs.codehaus.org/display/SONAR/Extending+Coding+Rules">Extending+Coding+Rules</a><span style="color: rgb(0,0,0);"> </span><span style="color: rgb(0,0,0);">)</span></span></td></tr><tr><td colspan="1" class="confluenceTd">category name</td><td colspan="1" class="confluenceTd">Can be anything, examples include Maintainability Style Usability etc</td></tr><tr><td colspan="1" class="confluenceTd">description</td><td colspan="1" class="confluenceTd">In the quality profile in sonar ui, the description will be show after expanding each rule</td></tr></tbody></table><table class="wysiwyg-macro" data-macro-name="info" data-macro-parameters="title=Important" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2luZm86dGl0bGU9SW1wb3J0YW50fQ&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body"><p>Once rules have been added to extensions/rules, they should be enabled in the relevant quality profile in Sonar. Only after this has been done, the analysis can be performed</p></td></tr></table>