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 43 Next »

Deprecated since SonarQube 4.0

Icon

The features provided by the Switch Off Violations plugin were added to SonarQube 4.0 and extended. Therefore, this plugin must not be used anymore with SonarQube 4.0+.

 

 

Description / Features

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

  • By rule
  • By file name/path
  • By line or range of lines
  • By file content

Installation

  1. Install the plugin through the Update Center or download it into the SONARQUBE_HOME/extensions/plugins directory
  2. Restart the SonarQube server

Configuration

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

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

Versions prior to 1.3

Icon

Set the sonar.switchoffviolations.patterns property:

Examples

Usage

Run an analysis on your project to take into account your configuration.

Change Log

Loading

Release 1.3 (2 issues)

 

Loading

Release 1.2 (3 issues)

 

Loading

Release 1.1 (1 issues)

  • No labels