Narrowing the Focus
If SonarQube's results aren't relevant, no one will want to use it. That's why precisely configuring what to analyze for each project is a very important step. Doing so allows you to remove noise, like the issues and duplications marked on generated code, or the issues from rules that aren't relevant for certain types of objects.
SonarQube gives you several options for configuring exactly what will be analyzed. You can
- completely ignore some files or directories
- exclude files/directories from Issues detection (specific rules or all of them) but analyze all other aspects
- exclude files/directories from Duplications detection but analyze all other aspects
- exclude files/directories from Coverage calculations but analyze all other aspects
You can make these changes globally or at a project level. At both levels, the navigation path is the same: Administration > General Settings > Analysis Scope.
We recommend that you exclude generated code, source code from libraries, etc. There are four different ways to narrow your analysis to the source code that will be relevant to the development team. You can combine them all together to tune your analysis scope.
Set the sonar.sources property to limit the scope of the analysis to certain directories.
Most language plugins offer a way to restrict the scope of analysis to files matching a set of extensions. Go to Administration > General Settings > [Language] to set the File suffixes property.
Your first line of defence having a well-defined set of files in your analysis is your
sonar.sources value. For projects built and analysed with Maven, Gradle, or MSBuild, this value is defined automatically with a generally thorough, yet sane value. For other projects, you want to make sure
sonar.sources is set to your project sub-directory that actually contains your source files. Setting it to
. will cast a wider net than most people intend.
sonar.sources directory will be included in analysis except the files with paths that match your exclusion regular expression.
To use exclusions to analyze everything but the specified files, go to Administration > General Settings > Analysis Scope > Files.
- Source File Exclusions (
sonar.exclusions) - to exclude source code files
- Test File Exclusions (
sonar.test.exclusions) - to exclude test files
The vast majority of needs are met simply by setting
sonar.sources carefully. Most other needs are met with the addition of a few simple exclusions. In a few corner cases, it is necessary to be explicit about what's included in analysis and leave out everything else, but that is not the normal case, and setting inclusions should not be the first thing you try when configuring a new project.
To use exclusions to analyze only the specified subset(s) of files in
sonar.sources, go to Administration > General Settings > Analysis Scope > Files.
- Source File Inclusions (
- Test File Inclusions (
You can set these properties at both the project and global levels.
See the Patterns section below for more details on the syntax to use in these inputs.
You can have SonarQube ignore issues on certain components and against certain coding rules. Go to Administration > General Settings > Analysis Scope > Issues.
Note that the properties below can only be set through the web interface because they are multi-valued.
Ignore Issues on Files
You can ignore all issues on files that contain a block of code matching a given regular expression.
- Ignore all issues in files containing "@javax.annotation.Generated"
Ignore Issues in Blocks
You can ignore all issues on specific blocks of code, while continuing to scan and mark issues on the remainder of the file. Blocks to be ignored are delimited by start and end strings which can be specified by regular expressions (or plain strings).
- If the first regular expression is found but not the second one, the end of the file is considered to be the end of the block.
- Regular expressions are not matched on a multi-line basis.
Ignore Issues on Multiple Criteria
You can ignore issues on certain components and for certain coding rules. To list a specific rule, use the fully qualified rule ID.
You can find the fully qualified rule ID on the Rule definition.
- Ignore all issues on all files
- Ignore all issues on COBOL program "bank/ZTR00021.cbl"
- Ignore all issues on classes located directly in the Java package "com.foo", but not in its sub-packages
- Ignore all issues against coding rule "cpp:Union" on files in the directory "object" and its sub-directories
Restrict Scope of Coding Rules
You can restrict the application of a rule to only certain components, ignoring all others.
- Only check the rule "Magic Number" on "Bean" objects and not on anything else
- Only check the rule "Prevent GO TO statement from transferring control outside current module on COBOL programs" located in the directories "bank/creditcard" and "bank/bankcard". This requires two criteria to define it:
KEY #1 =
PATH #1 =
KEY #2 =
PATH #2 =
You can prevent some files from being checked for duplications.
To do so, go to Administration > General Settings > Analysis Scope > Duplications and set the Duplication Exclusions property. See the Patterns section for more details on the syntax.
Ignore Code Coverage
You can prevent some files from being taken into account for code coverage by unit tests.
To do so, go to Administration > General Settings > Analysis Scope > Code Coverage and set the Coverage Exclusions property. See the Patterns section for more details on the syntax.
Paths are relative to the project base directory.
The following wildcards can be used:
*- zero or more characters
**- zero or more directories
?- a single character
Relative paths are based on the fully qualified name of the component.
# Exclude all classes ending by "Bean"
# Matches org/sonar.api/MyBean.java, org/sonar/util/MyOtherBean.java, org/sonar/util/MyDTO.java, etc.
# Exclude all classes in the "src/main/java/org/sonar" directory
# Matches src/main/java/org/sonar/MyClass.java, src/main/java/org/sonar/MyOtherClass.java
# But does not match src/main/java/org/sonar/util/MyClassUtil.java
# Exclude all COBOL programs in the "bank" directory and its sub-directories
# Matches bank/ZTR00021.cbl, bank/data/CBR00354.cbl, bank/data/REM012345.cob
# Exclude all COBOL programs in the "bank" directory and its sub-directories whose extension is .cbl
# Matches bank/ZTR00021.cbl, bank/data/CBR00354.cbl