How to disable Sonar rules for specific files?

Question

I've got a project I'm working on and some of the files violate some of the rules, but in ways that are not real issues, and are thus distracting noise. However, I don't want to disable these rules globally, and I would prefer not to have to mark 'em as false positives one by one.

Is there a way to disable Sonar rules for specific files, and if so, how?

Possible duplicate of [Disable rule in sonar](https://stackoverflow.com/questions/16399311/disable-rule-in-sonar) — Stéphane Bruckert, Apr 16 '19 at 13:53

score 16 · Accepted Answer · edited Apr 05 '22 at 18:18

16

Since SonarQube 4.0, you can define issue exclusion patterns based on rule key and file path pattern.

On previous versions, you can rely upon the Switch Off Violations plugin.

edited Apr 05 '22 at 18:18

Sjeiti

2,468
1
31
33

answered Jan 14 '14 at 09:03

Mithfindel

4,553
1
23
32

3

Great, thanks. A note for future folks that land on this page: the rule key pattern is : – Jan 14 '14 at 16:30
4

@mith The link is broken. Please make your answer self contained. – 1010 Dec 01 '15 at 14:18

score 14 · Answer 2 · answered Aug 14 '17 at 08:40

14

You can annotate a class or a method with SuppressWarnings.

Here is an example:

@java.lang.SuppressWarnings("squid:S00111") squid:S00111 in this case is a Sonar issue ID. You can find this issue id from the Sonar web ui.

answered Aug 14 '17 at 08:40

Nikhil

194
1
8

score 11 · Answer 3 · answered Aug 28 '20 at 10:36

11

You can set specific files and rules under sonar-project.properties with following contents:

# Ignore Issues
sonar.issue.ignore.multicriteria=e1,e2
# Skip Bold Check
sonar.issue.ignore.multicriteria.e1.ruleKey=Web:BoldCheck
sonar.issue.ignore.multicriteria.e1.resourceKey=**/*.html
# Skip Tag Check
sonar.issue.ignore.multicriteria.e2.ruleKey=Web:S1234
sonar.issue.ignore.multicriteria.e2.resourceKey=**/*.html

Change the ruleKey and resourceKey based on your specific need.

answered Aug 28 '20 at 10:36

Jerry Chong

7,954
4
45
40

1

Love it - thanks! – pixelstuermer Jun 05 '23 at 13:16
Hello, where can I find "ruleKey" id? – exoslav Jul 13 '23 at 10:40

Matthias Braun · Answer 4 · 2015-11-20T14:44:24.903

9

Building on Mithfindel's answer and dpk's comment, this removes the warning

System.out and System.err should not be used as loggers

from all classes in packages named log (or any subpackage thereof) by adding an ignore pattern for the rule squid:S106:

enter image description here

For a list of the keys to all your rules go to your profile under Quality Profiles and select Download to get a .csv file containing all the rules' keys.

I'm using SonarQube version 4.1.1.

edited Nov 20 '15 at 14:44

answered Feb 19 '14 at 14:01

Matthias Braun

32,039
22
142
171

I have a Console project and want to disable the rule "Console logging should not be used" on it. I use the UI as you said but it seems MSBuild don't get theses exclusions (anything found in Agent logs, or .sonarqube logs). do I have to have a configuration file or MSbuild should retreive Sonar configuration for projects ? Rule Key Pattern:csharpsquid:S2228 File Path Pattern:**/ChangeLog/**/*.* – BonOeil Jan 27 '16 at 08:31
BonOeil, you should probably ask a separate question for that. – Matthias Braun Jan 27 '16 at 14:01

score 7 · Answer 5 · edited Dec 23 '19 at 14:20

7

Using below annotation we can ignore the rule from the specific files

For one rule

@java.lang.SuppressWarnings("squid:S2696")
@Slf4j
@Service
public class PaymentServiceImpl implements PaymentService {....

For more than one rule

@java.lang.SuppressWarnings({"squid:S2696", "squid:S1172", "squid:CommentedOutCodeLine"})
@Slf4j
@Service
public class PaymentServiceImpl implements PaymentService {...

edited Dec 23 '19 at 14:20

assembler

3,098
12
43
84

answered Dec 23 '19 at 12:43

Dhammadip

87
1
4

1

Just a tip: If you want to get the exact code to put in @SuppressWarning, you can go to the SonarQube Dashboard, and then click into the literal "Why is this an issue?" you're interested on, and a small window will open down the screen; look the right side and you'll see something like "java:S1234". That's code. – ATorras Nov 09 '20 at 16:43

Rajan · Answer 6 · 2017-08-11T16:00:43.010

Yes, it is possible.

1.Goto Administration tab->Analysis Scope->Issues
2.There , you will find "Ignore Issues on Multiple Criteria".
3.Provide Rule ID in "Rule Key pattern" textbox [Rule ID can be found by clicking on the particular rule and find it in top right corner]
4.Provide Filepath for which you need to ignore rule in "File Path Pattern" textbox
5.Click on Save Issues settings
Image to know where Rule ID will be present in the page
Image where Rule key pattern and File Key pattern text boxes are present

How to disable Sonar rules for specific files?

6 Answers6

Linked