-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
CheckstyleExtension.java
191 lines (171 loc) · 5.77 KB
/
CheckstyleExtension.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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
/*
* 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 org.gradle.api.Incubating;
import org.gradle.api.Project;
import org.gradle.api.file.DirectoryProperty;
import org.gradle.api.provider.Property;
import org.gradle.api.resources.TextResource;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.Optional;
import java.io.File;
import java.util.LinkedHashMap;
import java.util.Map;
/**
* Configuration options for the Checkstyle plugin.
*
* @see CheckstylePlugin
*/
public class CheckstyleExtension extends CodeQualityExtension {
private final Project project;
private TextResource config;
private Map<String, Object> configProperties = new LinkedHashMap<>();
private int maxErrors;
private int maxWarnings = Integer.MAX_VALUE;
private boolean showViolations = true;
private final DirectoryProperty configDirectory;
private final Property<Boolean> enableExternalDtdLoad;
public CheckstyleExtension(Project project) {
this.project = project;
this.configDirectory = project.getObjects().directoryProperty();
this.enableExternalDtdLoad = project.getObjects().property(Boolean.class).convention(false);
}
/**
* The Checkstyle configuration file to use.
*/
public File getConfigFile() {
return getConfig().asFile();
}
/**
* The Checkstyle configuration file to use.
*/
public void setConfigFile(File configFile) {
setConfig(project.getResources().getText().fromFile(configFile));
}
/**
* The Checkstyle configuration to use. Replaces the {@code configFile} property.
*
* @since 2.2
*/
public TextResource getConfig() {
return config;
}
/**
* The Checkstyle configuration to use. Replaces the {@code configFile} property.
*
* @since 2.2
*/
public void setConfig(TextResource config) {
this.config = config;
}
/**
* The properties available for use in the configuration file. These are substituted into the configuration file.
*/
public Map<String, Object> getConfigProperties() {
return configProperties;
}
/**
* The properties available for use in the configuration file. These are substituted into the configuration file.
*/
public void setConfigProperties(Map<String, Object> configProperties) {
this.configProperties = configProperties;
}
/**
* Path to other Checkstyle configuration files. By default, this path is {@code $rootProject.projectDir/config/checkstyle}
* <p>
* This path will be exposed as the variable {@code config_loc} in Checkstyle's configuration files.
* </p>
*
* @return path to other Checkstyle configuration files
* @since 4.7
*/
public DirectoryProperty getConfigDirectory() {
return configDirectory;
}
/**
* The maximum number of errors that are tolerated before breaking the build
* or setting the failure property. Defaults to <code>0</code>.
* <p>
* Example: maxErrors = 42
*
* @return the maximum number of errors allowed
* @since 3.4
*/
public int getMaxErrors() {
return maxErrors;
}
/**
* Set the maximum number of errors that are tolerated before breaking the build.
*
* @param maxErrors number of errors allowed
* @since 3.4
*/
public void setMaxErrors(int maxErrors) {
this.maxErrors = maxErrors;
}
/**
* The maximum number of warnings that are tolerated before breaking the build
* or setting the failure property. Defaults to <code>Integer.MAX_VALUE</code>.
* <p>
* Example: maxWarnings = 1000
*
* @return the maximum number of warnings allowed
* @since 3.4
*/
public int getMaxWarnings() {
return maxWarnings;
}
/**
* Set the maximum number of warnings that are tolerated before breaking the build.
*
* @param maxWarnings number of warnings allowed
* @since 3.4
*/
public void setMaxWarnings(int maxWarnings) {
this.maxWarnings = maxWarnings;
}
/**
* Whether rule violations are to be displayed on the console. Defaults to <code>true</code>.
*
* Example: showViolations = false
*/
public boolean isShowViolations() {
return showViolations;
}
/**
* Whether rule violations are to be displayed on the console. Defaults to <code>true</code>.
*
* Example: showViolations = false
*/
public void setShowViolations(boolean showViolations) {
this.showViolations = showViolations;
}
/**
* Enable the ability to use custom DTD files in config and load them from some location on all checkstyle tasks in this project.
* <strong>Disabled by default due to security concerns.</strong>
* See <a href="https://checkstyle.org/config_system_properties.html#Enable_External_DTD_load">Checkstyle documentation</a> for more details.
*
* @return The property controlling whether to enable the ability to use custom DTD files
*
* @since 7.6
*/
@Incubating
@Optional
@Input
public Property<Boolean> getEnableExternalDtdLoad() {
return enableExternalDtdLoad;
}
}