Description / Features

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 name/path
• By line or range of lines
• By file content (since version 1.2)

Installation

1. Install the Switch Off Violations plugin through the Update Center or download it into the SONAR_HOME/extensions/plugins directory
2. Restart the Sonar server

Configuration

Exclusion patterns can be specified at both global and project levels. Go to Configuration > General Settings > Switch Off Violations (or at project level: Configuration > Settings > Switch Off Violations) and add values to the following properties:

• File exclusion patterns (sonar.switchoffviolations.allfile) to switch off all the violations on files that contains a block of code that matches a given regular expression.
  
  • Example: switch off all the violations on files containing @javax\.annotation\.Generated
    
• Multi-criteria exclusion patterns (sonar.switchoffviolations.multicriteria) to switch off violations on specific resources, rules and ranges of lines.
  
  • Examples: 
    
    • Switch off all the violations (Java projects: structure = packages) => *;*;*
    • Switch off all the violations (non-Java projects: structure = folders) => **/*;*;*
    • Exclude all the violations on the Java file com.foo.Bar => com.foo.Bar;*;*
    • Exclude all the violations on the Java package com.foo => com.foo.*;*;*
    • Exclude all the violations of a specific rule => *;checkstyle:com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck;*
    • Exclude all the violations of a specific rule on a specific file => com.foo.Bar;checkstyle:com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck;*
    • Exclude all the violations on specific lines 10, 25 and 90 => com.foo.Bar;*;[10,25,90]
    • Exclude all the violations on a range of lines => com.foo.Bar;*;[10-90]
    • Exclude all the violations on several ranges of lines => com.foo.Bar;*;[10-90,92,98,120-150]
 

• Bloc exclusion patterns (sonar.switchoffviolations.block) to switch off violations on specific blocks of code. Note: if the first regular expression is found but not the second one, then the plugin considers that the end of the code block is the end of the file.
  
  • Example: exclude code blocks delimited by GEN-FIRST and GEN-LAST (like NetBeans auto-generated code):
    

 

Versions prior to 1.3 Set the sonar.switchoffviolations.patterns property: Examples

Usage

Run a Sonar analysis on your project to take into account your configuration.

Change Log

Release 1.3 (2 issues)
Type	Key	Summary	Priority
	SONARPLUGINS-1370	Add an administration console to the Switch Off Violation Plugin
	SONARPLUGINS-2299	Simplify the description of the 'sonar.switchoffviolations.patterns' property

Release 1.2 (3 issues)
Type	Key	Summary	Priority
	SONARPLUGINS-1990	Fix URL for update center
	SONARPLUGINS-1104	Add a way to exclude files from analysis based on file content
	SONARPLUGINS-2077	Typo in the Configuration file for exclusion patterns description

Release 1.1 (1 issues)
Type	Key	Summary	Priority
	SONARPLUGINS-1202	The plugins settings should be moved from the file based configuration to Project Setting page