1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
/*
* SonarQube
* Copyright (C) 2009-2025 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.xoo.rule;
import org.sonar.api.batch.fs.FileSystem;
import org.sonar.api.batch.fs.InputFile;
import org.sonar.api.batch.rule.ActiveRules;
import org.sonar.api.batch.sensor.SensorContext;
import org.sonar.api.batch.sensor.SensorDescriptor;
import org.sonar.api.batch.sensor.issue.NewIssue;
import org.sonar.api.config.Configuration;
import org.sonar.api.rule.RuleKey;
public class OneIssuePerFileSensor extends AbstractXooRuleSensor {
public static final String RULE_KEY = "OneIssuePerFile";
private static final String EFFORT_TO_FIX_PROPERTY = "sonar.oneIssuePerFile.effortToFix";
private static final String ENABLE_HIDDEN_FILE_PROCESSING = "sonar.oneIssuePerFile.enableHiddenFileProcessing";
private final Configuration settings;
public OneIssuePerFileSensor(Configuration settings, FileSystem fs, ActiveRules activeRules) {
super(fs, activeRules);
this.settings = settings;
}
@Override
public void describe(SensorDescriptor descriptor) {
super.describe(descriptor);
if (settings.getBoolean(ENABLE_HIDDEN_FILE_PROCESSING).orElse(false)) {
descriptor.processesHiddenFiles();
}
}
@Override
protected String getRuleKey() {
return RULE_KEY;
}
@Override
protected void processFile(InputFile inputFile, SensorContext context, RuleKey ruleKey, String languageKey) {
NewIssue newIssue = context.newIssue()
.forRule(ruleKey)
.gap(settings.getDouble(EFFORT_TO_FIX_PROPERTY).orElse(0.0));
newIssue.at(newIssue.newLocation()
.on(inputFile)
.message("This issue is generated on each file"))
.save();
}
}
|
