-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
CodeNarcExtension.java
138 lines (119 loc) · 4.04 KB
/
CodeNarcExtension.java
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
/*
* Copyright 2011 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gradle.api.plugins.quality;
import com.google.common.collect.Sets;
import org.gradle.api.InvalidUserDataException;
import org.gradle.api.Project;
import org.gradle.api.resources.TextResource;
import java.io.File;
import java.util.Set;
/**
* Configuration options for the CodeNarc plugin.
*
* @see CodeNarcPlugin
*/
public abstract class CodeNarcExtension extends CodeQualityExtension {
private static final Set<String> REPORT_FORMATS = Sets.newHashSet("xml", "html", "console", "text");
private final Project project;
private TextResource config;
private int maxPriority1Violations;
private int maxPriority2Violations;
private int maxPriority3Violations;
private String reportFormat;
public CodeNarcExtension(Project project) {
this.project = project;
}
/**
* The CodeNarc configuration to use. Replaces the {@code configFile} property.
*
* @since 2.2
*/
public TextResource getConfig() {
return config;
}
/**
* The CodeNarc configuration to use. Replaces the {@code configFile} property.
*
* @since 2.2
*/
public void setConfig(TextResource config) {
this.config = config;
}
/**
* The CodeNarc configuration file to use.
*/
public File getConfigFile() {
return getConfig().asFile();
}
/**
* The CodeNarc configuration file to use.
*/
public void setConfigFile(File file) {
setConfig(project.getResources().getText().fromFile(file));
}
/**
* The maximum number of priority 1 violations allowed before failing the build.
*/
public int getMaxPriority1Violations() {
return maxPriority1Violations;
}
/**
* The maximum number of priority 1 violations allowed before failing the build.
*/
public void setMaxPriority1Violations(int maxPriority1Violations) {
this.maxPriority1Violations = maxPriority1Violations;
}
/**
* The maximum number of priority 2 violations allowed before failing the build.
*/
public int getMaxPriority2Violations() {
return maxPriority2Violations;
}
/**
* The maximum number of priority 2 violations allowed before failing the build.
*/
public void setMaxPriority2Violations(int maxPriority2Violations) {
this.maxPriority2Violations = maxPriority2Violations;
}
/**
* The maximum number of priority 3 violations allowed before failing the build.
*/
public int getMaxPriority3Violations() {
return maxPriority3Violations;
}
/**
* The maximum number of priority 3 violations allowed before failing the build.
*/
public void setMaxPriority3Violations(int maxPriority3Violations) {
this.maxPriority3Violations = maxPriority3Violations;
}
/**
* The format type of the CodeNarc report. One of <code>html</code>, <code>xml</code>, <code>text</code>, <code>console</code>.
*/
public String getReportFormat() {
return reportFormat;
}
/**
* The format type of the CodeNarc report. One of <code>html</code>, <code>xml</code>, <code>text</code>, <code>console</code>.
*/
public void setReportFormat(String reportFormat) {
if (REPORT_FORMATS.contains(reportFormat)) {
this.reportFormat = reportFormat;
} else {
throw new InvalidUserDataException("'" + reportFormat + "' is not a valid codenarc report format");
}
}
}