-
Notifications
You must be signed in to change notification settings - Fork 12
/
checkstyle.xml
211 lines (208 loc) · 10.6 KB
/
checkstyle.xml
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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<!-- Checkstyle-Configuration: ampvalidator checks Description: none -->
<module name="Checker">
<property name="severity" value="warning"/>
<module name="TreeWalker">
<property name="tabWidth" value="4"/>
<!-- Make the @SuppressWarnings annotations available to Checkstyle -->
<module name="SuppressWarningsHolder" />
<module name="JavadocMethod">
<property name="accessModifiers" value="public"/>
</module>
<module name="JavadocType">
<property name="scope" value="public"/>
</module>
<module name="JavadocVariable">
<property name="scope" value="public"/>
</module>
<module name="JavadocStyle">
<property name="checkFirstSentence" value="false"/>
</module>
<module name="ConstantName"/>
<module name="LocalFinalVariableName"/>
<module name="LocalVariableName"/>
<module name="MemberName"/>
<module name="MethodName"/>
<module name="PackageName"/>
<module name="ParameterName"/>
<module name="StaticVariableName"/>
<module name="TypeName"/>
<module name="AvoidStarImport"/>
<module name="IllegalImport">
<property name="severity" value="error"/>
<property name="illegalPkgs"
value="edu.emory.mathcs.backport.java.util, org.ocpsoft.prettytime.shade.edu.emory.mathcs.backport.java.util, org.apache.log4j, yjava.messaging.ynet, yjava.security.ysecure, yjava.security.yck, yjava.security.yhdrs, , yjava.messaging.ynet"/>
<message key="import.illegal" value="Import from illegal package - {0}."/>
</module>
<module name="ImportControl">
<property name="file" value="${config_loc}/checkstyle_import_control.xml"/>
</module>
<module name="RedundantImport"/>
<module name="UnusedImports"/>
<module name="ParameterNumber"/>
<module name="EmptyForIteratorPad"/>
<module name="MethodParamPad"/>
<module name="NoWhitespaceAfter">
<property name="tokens"
value="BNOT,DEC,DOT,INC,LNOT,UNARY_MINUS,UNARY_PLUS"/>
</module>
<module name="NoWhitespaceBefore"/>
<module name="OperatorWrap"/>
<module name="ParenPad"/>
<module name="TypecastParenPad"/>
<module name="WhitespaceAfter"/>
<module name="WhitespaceAround"/>
<module name="ModifierOrder"/>
<module name="RedundantModifier"/>
<module name="AvoidNestedBlocks">
<property name="severity" value="ignore"/>
</module>
<module name="EmptyBlock">
<property name="option" value="text"/>
</module>
<module name="LeftCurly"/>
<module name="NeedBraces"/>
<module name="RightCurly"/>
<module name="EmptyStatement"/>
<module name="EqualsHashCode"/>
<module name="IllegalInstantiation"/>
<module name="InnerAssignment">
<property name="severity" value="ignore"/>
</module>
<module name="MagicNumber"/>
<module name="MissingSwitchDefault"/>
<!-- <module name="RedundantThrows"> <property name="suppressLoadErrors"
value="true"/> </module> -->
<module name="SimplifyBooleanExpression"/>
<module name="SimplifyBooleanReturn"/>
<module name="FinalClass"/>
<module name="HideUtilityClassConstructor"/>
<module name="InterfaceIsType"/>
<module name="VisibilityModifier">
<property name="protectedAllowed" value="true"/>
</module>
<module name="ArrayTypeStyle"/>
<module name="FinalParameters"/>
<module name="IllegalCatch">
<property name="illegalClassNames"
value="java.lang.Exception, java.lang.Throwable, java.lang.RuntimeException, java.lang.IllegalArgumentException, java.lang.IllegalStateException, java.lang.UnsupportedOperationException, java.lang.NumberFormatException,
java.lang.NullPointerException, java.lang.StringIndexOutOfBoundsException, java.lang.ArrayIndexOutOfBoundsException, java.util.NoSuchElementException, java.util.MissingResourceException,
javax.ws.rs.NotSupportedException, javax.ws.rs.BadRequestException, javax.ws.rs.ProcessingException, javax.ws.rs.core.UriBuilderException"/>
</module>
<module name="IllegalThrows">
<property name="illegalClassNames"
value="java.lang.Exception, java.lang.Throwable, java.lang.RuntimeException, java.lang.IllegalArgumentException, java.lang.IllegalStateException, java.lang.UnsupportedOperationException, java.lang.NumberFormatException,
java.lang.NullPointerException, java.lang.StringIndexOutOfBoundsException, java.lang.ArrayIndexOutOfBoundsException, java.util.NoSuchElementException, java.util.MissingResourceException,
javax.ws.rs.NotSupportedException, javax.ws.rs.BadRequestException, javax.ws.rs.ProcessingException, javax.ws.rs.core.UriBuilderException"/>
</module>
<module name="IllegalInstantiation">
<property name="classes" value="java.net.URLEncoder"/>
<property name="classes" value="java.net.URLDecoder"/>
<property name="classes" value="javax.mail.internet.InternetAddress"/>
</module>
<module name="TodoComment">
<property name="severity" value="ignore"/>
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity"
value="inherit"/>
</module>
<module name="UpperEll"/>
<module name="RegexpSinglelineJava">
<property name="format" value="System\.(out|err|in|exit)"/>
<property name="message"
value="Prohibited System.out/err/in/exit reference(s)."/>
</module>
<module name="RegexpSinglelineJava">
<property name="format" value="\.getBytes\(\)"/>
<property name="message" value="Possible usage of String.getBytes() without Charset specification."/>
</module>
<module name="RegexpSinglelineJava">
<property name="format" value="Charset\.getDefaultCharset\(\)"/>
<property name="message" value="Usage of Charset.getDefaultCharset() is prohibited."/>
</module>
<module name="RegexpSinglelineJava">
<property name="format" value="\.getBytes\("(.*)"\)"/>
<property name="message" value="Possible usage of String.getBytes() with String to specific Charset."/>
</module>
<module name="RegexpSinglelineJava">
<property name="format" value="@Test.*dependsOn(Groups|Methods).*"/>
<property name="message"
value="Prohibited TestNG dependsOn due to issues with parallelization. Make all tests run independently."/>
</module>
<module name="RegexpSinglelineJava">
<property name="format" value="\.submit\([a-zA-Z]*[Ww]orker, null\)"/>
<property name="message"
value="Prohibited use of submit with null passed as handler. Please use WorkerExceptionStatsHandler."/>
</module>
</module>
<!--
A multiline regex matcher for the illegal ConfigGets (of type ValueType.StringList). It can detect the invalid default values like:
"[Personal]"
"[ Personal ]"
"[ Personal ]"
"[Personal, Unknown]"
"[ Personal, Unknown ]"
"[\"Unknown]"
It will not detect the valid default values like:
"[ ]"
"[]"
"[\"Personal\", \"Unknown\", \"ghjgjggjhgjgjghjgjhg \"]"
"[ \"Personal\", \"Unknown\" ]"
"[ \"Personal\", \"Unknown\"]"
"[ \"Personal\", \"Unknown\"]"
"[\"Personal\", \"Unknown\"]"
"[\"Personal\", \"Unknown\" ]"
"[\"Personal\", \"Unknown\" ]"
"[ \"Personal\", \"Unknown\" ]"
"[\"Unknown\"]"
""
"Personal"
"Personal, Unknown"
Refer https://regex101.com/r/iX3QQT/6/tests for the regex and the corresponding tests.
-->
<module name="RegexpMultiline">
<property name="format"
value="type = ValueType\.StringList,\s*defaultValue = \"\[ *[^\\ ][^"]\S+( |\S)+[^\\][^" ] *\]\"\)$"/>
<property name="message" value="Default value for StringList should be a string representation of an array of strings."/>
</module>
<module name="JavadocPackage">
<property name="allowLegacy" value="true"/>
</module>
<module name="NewlineAtEndOfFile">
<property name="severity" value="ignore"/>
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity"
value="inherit"/>
</module>
<module name="Translation"/>
<module name="FileLength"/>
<module name="FileTabCharacter">
<property name="severity" value="ignore"/>
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity"
value="inherit"/>
</module>
<module name="RegexpSingleline">
<property name="severity" value="ignore"/>
<property name="format" value="\s+$"/>
<property name="message" value="Line has trailing spaces."/>
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity"
value="inherit"/>
</module>
<module name="SuppressWarningsFilter"/>
<!-- Eclipse-Only Suppression Filter Configuration / Fails for Maven
Commandline Maven command-line build uses pom.xml suppressionLocation setting
in the checkstyle configuration. Eclipse checkstyle does not recognize the
pom.xml setting, only the checkstyle.xml SuppressionFilter module here. But
Maven command-line does not compile with the following because no variable
is defined to locate the supporessions.xml in a way that works consistently
regardless of where invoked (from root of project or cd into individual projects.
You can set pom.xml PropertiesLocation tag with a .properties file containing
key=value pairs for such variables, but they are not relative to the checkstyle.xml
location. DISABLED: Enable only if you want to see the same exclusions from
eclipse, but will not build from command-line. <module name="SuppressionFilter">
<property name="file" value="${samedir}/checkstyle_suppressions.xml"/>
</module> -->
<module name="SuppressionFilter">
<property name="file"
value="${config_loc}/checkstyle_suppressions.xml"/>
</module>
</module>