This is an archived version of the documentation for SonarQube-7.3.
See the Latest Documentation for current functionality.

Rules

In SonarQube, analyzers contribute rules which are executed on source code to generate issues. There are four types of rules:

  • Code Smell (Maintainability domain)

  • Bug (Reliability domain)

  • Vulnerability (Security domain)

  • Security Hotspot (Security domain)

For Code Smells and Bugs, zero false-positives are expected. At least this is the target so that developers don't have to wonder if a fix is required.
For Vulnerabilities, the target is to have more than 80% of the issues to be true-positives.
Security Hotspot rules are purposefully designed to draw attention to code is security-sensitive. It is expected that more than 80% of the issues will be quickly resolved as "Won't Fix" after review by a Security Auditor.

The Rules page is the entry point where you can discover all the existing rules or create new ones based on provided templates.

Rules

By default, when entering the top menu item "Rules", you will see all the available rules brought by the analyzers installed on your SonarQube instance. You have the ability to narrow the selection based on search criteria in the left pane:

  • Language: the language to which a rule applies.

  • Type: Bug, Vulnerability, Code Smell or Security Hotspot rules.

  • Tag: it is possible to add tags to rules in order to classify them and to help discover them more easily.

  • Repository: the engine/analyzer that contributes rules to SonarQube.

  • Default Severity: the original severity of the rule - as defined by the analyzer that contributes this rule.

  • Status: rules can have 3 different statuses:

    • Beta: The rule has been recently implemented and we haven't gotten enough feedback from users yet, so there may be false positives or false negatives.

    • Deprecated: The rule should no longer be used because a similar, but more powerful and accurate rule exists.

    • Ready: The rule is ready to be used in production.

  • Available Since: date when a rule was first added on the SonarQube instance. This is useful to list all the new rules since the last upgrade of a plugin for instance.

  • Template: display rule templates that allow to create custom rules (see later on this page).

  • Quality Profile: inclusion in or exclusion from a specific profile

If a quality profile is selected, it is also possible to check for its active severity and whether it is inherited or not. See the Quality Profile documentation for more.

Rule Details

To see the details of a rule, either click on it, or use the right arrow key. Along with basic rule data, you'll also be able to see which, if any, profiles it's active in and how many open issues have been raised with it.

The 2 following actions are available only if you have the right permissions ("Administer Quality Profiles and Gates"):

  • Add/Remove Tags:

    • It is possible to add existing tags on a rule, or to create new ones (just enter a new name while typing in the text field).

    • Note that some rules have built-in tags that you cannot remove - they are provided by the plugins which contribute the rules.

  • Extend Description:

    • Extending rule descriptions is useful to let users know how your organization is using a particular rule for instance or to give more insight on a rule.

    • Note that the extension will be available to non-admin users as a normal part of the rule details.

Rule Templates and Custom Rules

Rule Templates are provided by plugins to allow users to define their own rules in SonarQube. For instance, the template "Architectural Constraint" can be used to create any kind of rule that checks forbidden access from a set of file to another set of files.

Rule templates are like cookie cutters from which you can stamp out new, "custom rules". To find templates, use the template facet:

images/download/attachments/11641192/Selection_633.png

To create a custom rule from a template, you will have to fill the following information:

  • Name

  • Key (auto-suggested)

  • Description (Markdown format is supported)

  • Default Severity

  • Status

  • The parameters specified by the template

It's easy to navigate from a template to the custom rules defined from it: just click on the link in the "Custom Rules" section and you will end up on the details of the given rule.

images/download/attachments/11641192/Selection_634.png

Custom Rules

Custom Rules are considered like any other rule, except that they can be fully edited or even deleted:

images/download/attachments/11641192/Selection_635.png

Note that when deleting a custom rule, it is not physically removed from the SonarQube instance but rather its status is set to "REMOVED". This allows current or old issues related to this rule to be displayed properly in SonarQube until they are fully removed.

Extending Coding Rules

Custom coding rules can be added. See Adding Coding Rules for detailed information and tutorials.