Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 14 Next »

Description

This plugin is used to exclude some violations in a fine-grained way. It allows to define some exclusion patterns to switch off violations :

  • By rule
  • By file
  • By line or range of lines

Installation

Download the plugin from Update Center and restart server.

If you don't have access to Internet, then manually download JAR file into $SONAR_HOME/extensions/plugins and restart server.

Configuration

The configuration of the plugin is done in the Web admin console, where you can specify the exclusion patterns in the textarea (one per line):

  • Comments start with #
  • Blank lines are allowed
  • A line defines 3 fields: resource key, rule key and range of lines.

Example:

# suppress all violations
*;*;*

# exclude the Java file com.foo.Bar
com.foo.Bar;*;*

# exclude a Java package
com.foo.*;*;*

# exclude a specific rule
*;checkstyle:com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck;*

# exclude a specific rule on a specific file
com.foo.Bar;checkstyle:com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck;*

# exclude on specific lines 10, 25 and 90
com.foo.Bar;*;[10,25,90]

# exclude on a range of lines
com.foo.Bar;*;[10-90]

# exclude on many ranges of lines
com.foo.Bar;*;[10-90,92,98,120-150]


Note 1: prior to version 1.1, the only way to specify exclusions was to write them in a file and fill the "sonar.switchoffviolations.configFile" property with the location of that file. This feature is still supported, even if it is best to use the Web admin console to configure the plugin.

Note 2: when specifying exclusions patterns in the Web admin console, you may be surprised to see that several lines are displayed on a single line after you have saved your modifications. This is a known bug which doesn't affect the property you have set but only the way it is displayed when your property do not exceed 50 characters. If you want to see the line returns, then just add a long comment at the beginning (e.g. "# This is a comment blablabla"), and after you saved, you will see your property correctly formatted.

Releases

Loading
Type Key Summary assignee

  • No labels