Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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 exclusion patterns 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
  • 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):
      Image Added
  • 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]
         Image Modified
  • 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):
      Image Removed
Info
titleVersions prior to 1.3

Set the sonar.switchoffviolations.patterns property:

Code Block
titleExamples
languagenone
# Switch off all violations (Java projects: structure = packages)
*;*;*

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

# Exclude on several ranges of lines
com.foo.Bar;*;[10-90,92,98,120-150]
 
# Exclude code blocks delimited by GEN-FIRST and GEN-LAST (like NetBeans auto-generated code)
GEN-FIRST;GEN-LAST
 
# Exclude files containing "@javax.annotation.Generated"
@javax\.annotation\.Generated

Usage

...