1 <?xml version="1.0" encoding="UTF-8"?> |
1 <?xml version="1.0"?> |
2 <!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN" "http://www.puppycrawl.com/dtds/configuration_1_3.dtd"> |
2 <!DOCTYPE module PUBLIC |
|
3 "-//Puppy Crawl//DTD Check Configuration 1.2//EN" |
|
4 "http://www.puppycrawl.com/dtds/configuration_1_2.dtd"> |
3 |
5 |
4 <!-- |
6 <!-- |
5 This configuration file was written by the eclipse-cs plugin configuration editor |
7 |
|
8 Checkstyle configuration that checks the sun coding conventions from: |
|
9 |
|
10 - the Java Language Specification at |
|
11 http://java.sun.com/docs/books/jls/second_edition/html/index.html |
|
12 |
|
13 - the Sun Code Conventions at http://java.sun.com/docs/codeconv/ |
|
14 |
|
15 - the Javadoc guidelines at |
|
16 http://java.sun.com/j2se/javadoc/writingdoccomments/index.html |
|
17 |
|
18 - the JDK Api documentation http://java.sun.com/j2se/docs/api/index.html |
|
19 |
|
20 - some best practices |
|
21 |
|
22 Checkstyle is very configurable. Be sure to read the documentation at |
|
23 http://checkstyle.sf.net (or in your downloaded distribution). |
|
24 |
|
25 Most Checks are configurable, be sure to consult the documentation. |
|
26 |
|
27 To completely disable a check, just comment it out or delete it from the file. |
|
28 |
|
29 Finally, it is worth reading the documentation. |
|
30 |
6 --> |
31 --> |
7 <!-- |
32 |
8 Checkstyle-Configuration: Beem Checks |
33 <module name="Checker"> |
9 Description: none |
34 <!-- |
|
35 If you set the basedir property below, then all reported file |
|
36 names will be relative to the specified directory. See |
|
37 http://checkstyle.sourceforge.net/5.x/config.html#Checker |
10 --> |
38 --> |
11 <module name="Checker"> |
39 <property name="basedir" value="/home/beem/" default="."/> |
12 <property name="severity" value="warning"/> |
40 |
13 <property name="basedir" value="/home/beem/"/> |
41 <property name="severity" value="warning"/> |
14 <module name="TreeWalker"> |
42 |
15 <module name="JavadocMethod"> |
43 <!-- Checks that a package-info.java file exists for each package. --> |
16 <property name="severity" value="error"/> |
44 <!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage --> |
17 <property name="allowUndeclaredRTE" value="true"/> |
45 <module name="JavadocPackage"> |
18 </module> |
46 <property name="allowLegacy" value="true"/> |
19 <module name="JavadocType"> |
47 </module> |
20 <property name="severity" value="error"/> |
48 |
21 </module> |
49 <!-- Checks whether files end with a new line. --> |
22 <module name="JavadocVariable"> |
50 <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile --> |
23 <property name="severity" value="error"/> |
51 <module name="NewlineAtEndOfFile"> |
24 <property name="scope" value="package"/> |
52 <property name="severity" value="error"/> |
25 </module> |
53 </module> |
26 <module name="JavadocStyle"> |
54 |
27 <property name="severity" value="error"/> |
55 <!-- Checks that property files contain the same keys. --> |
28 <property name="checkEmptyJavadoc" value="true"/> |
56 <!-- See http://checkstyle.sf.net/config_misc.html#Translation --> |
29 </module> |
57 <module name="Translation"> |
30 <module name="ConstantName"/> |
58 <property name="severity" value="error"/> |
31 <module name="LocalFinalVariableName"/> |
59 </module> |
32 <module name="LocalVariableName"/> |
60 |
33 <module name="MemberName"> |
61 <!-- Checks for Size Violations. --> |
34 <property name="severity" value="error"/> |
62 <!-- See http://checkstyle.sf.net/config_sizes.html --> |
35 <property name="format" value="^m[A-Z][a-zA-Z0-9]*$"/> |
63 <module name="FileLength"/> |
36 </module> |
64 |
37 <module name="MethodName"/> |
65 <!-- Checks for whitespace --> |
38 <module name="PackageName"/> |
66 <!-- See http://checkstyle.sf.net/config_whitespace.html --> |
39 <module name="ParameterName"/> |
67 <!-- we want tab |
40 <module name="StaticVariableName"/> |
68 <module name="FileTabCharacter"/> |
41 <module name="TypeName"/> |
69 --> |
42 <module name="AvoidStarImport"/> |
70 |
43 <module name="IllegalImport"/> |
71 <!-- Miscellaneous other checks. --> |
44 <module name="RedundantImport"/> |
72 <!-- See http://checkstyle.sf.net/config_misc.html --> |
45 <module name="UnusedImports"> |
73 <module name="RegexpSingleline"> |
46 <property name="severity" value="error"/> |
74 <property name="severity" value="error"/> |
47 </module> |
75 <property name="format" value="\s+$"/> |
48 <module name="AvoidStaticImport"> |
76 <property name="minimum" value="0"/> |
49 <property name="excludes" value="*"/> |
77 <property name="maximum" value="0"/> |
50 </module> |
78 <property name="message" value="Line has trailing spaces."/> |
51 <module name="LineLength"> |
79 </module> |
52 <property name="max" value="120"/> |
80 |
53 </module> |
81 <!-- This rules is desactivated because it is too stupid. |
54 <module name="MethodLength"/> |
82 It also compare the Header of the file. |
55 <module name="ParameterNumber"/> |
83 <module name="StrictDuplicateCode"> |
56 <module name="AnonInnerLength"> |
84 <property name="min" value="25" /> |
57 <property name="max" value="60"/> |
85 </module> |
58 </module> |
86 --> |
59 <module name="EmptyForIteratorPad"/> |
87 |
60 <module name="GenericWhitespace"> |
88 <!-- Header file --> |
61 <property name="severity" value="error"/> |
89 <module name="RegexpHeader"> |
62 </module> |
90 <property name="headerFile" value="${basedir}/tools/JavaHeaderCheck.regex"/> |
63 <module name="MethodParamPad"> |
91 <property name="multiLines" value="5, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38"/> |
64 <property name="severity" value="error"/> |
92 <property name="severity" value="error" /> |
65 </module> |
93 </module> |
66 <module name="NoWhitespaceAfter"> |
94 |
67 <property name="severity" value="error"/> |
95 <module name="TreeWalker"> |
68 </module> |
96 |
69 <module name="NoWhitespaceBefore"> |
97 <!-- Checks for Javadoc comments. --> |
70 <property name="severity" value="error"/> |
98 <!-- See http://checkstyle.sf.net/config_javadoc.html --> |
71 </module> |
99 <module name="JavadocMethod"> |
72 <module name="OperatorWrap"/> |
100 <property name="allowUndeclaredRTE" value="true"/> |
73 <module name="ParenPad"> |
101 <property name="severity" value="error"/> |
74 <property name="severity" value="error"/> |
102 </module> |
75 </module> |
103 <module name="JavadocType"> |
76 <module name="TypecastParenPad"> |
104 <property name="severity" value="error"/> |
77 <property name="severity" value="error"/> |
105 </module> |
78 </module> |
106 <module name="JavadocVariable"> |
79 <module name="WhitespaceAfter"> |
107 <property name="scope" value="package" /> |
80 <property name="severity" value="error"/> |
108 <property name="severity" value="error"/> |
81 </module> |
109 </module> |
82 <module name="WhitespaceAround"> |
110 <module name="JavadocStyle"> |
83 <property name="severity" value="error"/> |
111 <property name="checkEmptyJavadoc" value="true"/> |
84 </module> |
112 <property name="severity" value="error"/> |
85 <module name="ModifierOrder"> |
113 </module> |
86 <property name="severity" value="error"/> |
114 |
87 </module> |
115 |
88 <module name="RedundantModifier"> |
116 <!-- Checks for Naming Conventions. --> |
89 <property name="severity" value="error"/> |
117 <!-- See http://checkstyle.sf.net/config_naming.html --> |
90 </module> |
118 <module name="ConstantName"/> |
91 <module name="AvoidNestedBlocks"/> |
119 <module name="LocalFinalVariableName"/> |
92 <module name="EmptyBlock"/> |
120 <module name="LocalVariableName"/> |
93 <module name="LeftCurly"> |
121 <module name="MemberName"> |
94 <property name="severity" value="error"/> |
122 <property name="format" value="^m[A-Z][a-zA-Z0-9]*$"/> |
95 </module> |
123 <property name="severity" value="error"/> |
96 <module name="RightCurly"> |
124 </module> |
97 <property name="severity" value="error"/> |
125 <module name="MethodName"/> |
98 </module> |
126 <module name="PackageName"/> |
99 <module name="AnnotationUseStyle"> |
127 <module name="ParameterName"/> |
100 <property name="severity" value="error"/> |
128 <module name="StaticVariableName"/> |
101 </module> |
129 <module name="TypeName"/> |
102 <module name="MissingDeprecated"> |
130 |
103 <property name="severity" value="error"/> |
131 |
104 </module> |
132 <!-- Checks for Headers --> |
105 <module name="MissingOverride"> |
133 <!-- See http://checkstyle.sf.net/config_header.html --> |
106 <property name="severity" value="error"/> |
134 <!-- <module name="Header"> --> |
107 </module> |
135 <!-- The follow property value demonstrates the ability --> |
108 <module name="CovariantEquals"/> |
136 <!-- to have access to ANT properties. In this case it uses --> |
109 <module name="AvoidInlineConditionals"/> |
137 <!-- the ${basedir} property to allow Checkstyle to be run --> |
110 <module name="InnerAssignment"/> |
138 <!-- from any directory within a project. See property --> |
111 <module name="DoubleCheckedLocking"/> |
139 <!-- expansion, --> |
112 <module name="EmptyStatement"/> |
140 <!-- http://checkstyle.sf.net/config.html#properties --> |
113 <module name="EqualsHashCode"> |
141 <!-- <property --> |
114 <property name="severity" value="error"/> |
142 <!-- name="headerFile" --> |
115 </module> |
143 <!-- value="${basedir}/java.header"/> --> |
116 <module name="HiddenField"> |
144 <!-- </module> --> |
117 <property name="ignoreConstructorParameter" value="true"/> |
145 |
118 <property name="ignoreSetter" value="true"/> |
146 <!-- Checks for imports --> |
119 <property name="ignoreAbstractMethods" value="true"/> |
147 <!-- See http://checkstyle.sf.net/config_import.html --> |
120 </module> |
148 <module name="AvoidStarImport"/> |
121 <module name="IllegalInstantiation"/> |
149 <module name="IllegalImport"/> <!-- defaults to sun.* packages --> |
122 <module name="InnerAssignment"> |
150 <module name="RedundantImport"/> |
123 <property name="severity" value="error"/> |
151 <module name="UnusedImports"> |
124 </module> |
152 <property name="severity" value="error"/> |
125 <module name="MagicNumber"/> |
153 </module> |
126 <module name="MissingSwitchDefault"> |
154 <module name="AvoidStaticImport"> |
127 <property name="severity" value="error"/> |
155 <property name="excludes" value="*"/> |
128 </module> |
156 </module> |
129 <module name="RedundantThrows"/> |
157 |
130 <module name="SimplifyBooleanExpression"> |
158 |
131 <property name="severity" value="error"/> |
159 <!-- Checks for Size Violations. --> |
132 </module> |
160 <!-- See http://checkstyle.sf.net/config_sizes.html --> |
133 <module name="SimplifyBooleanReturn"> |
161 <module name="LineLength"> |
134 <property name="severity" value="error"/> |
162 <property name="max" value="120" /> |
135 </module> |
163 </module> |
136 <module name="StringLiteralEquality"> |
164 <module name="MethodLength"/> |
137 <property name="severity" value="error"/> |
165 <module name="ParameterNumber"/> |
138 </module> |
166 <module name="AnonInnerLength"> |
139 <module name="IllegalCatch"/> |
167 <property name="max" value="60" /> |
140 <module name="IllegalThrows"/> |
168 </module> |
141 <module name="IllegalType"/> |
169 |
142 <module name="PackageDeclaration"/> |
170 |
143 <module name="JUnitTestCase"/> |
171 <!-- Checks for whitespace --> |
144 <module name="DeclarationOrder"> |
172 <!-- See http://checkstyle.sf.net/config_whitespace.html --> |
145 <property name="severity" value="error"/> |
173 <module name="EmptyForIteratorPad"/> |
146 </module> |
174 <module name="GenericWhitespace"> |
147 <module name="ExplicitInitialization"/> |
175 <property name="severity" value="error"/> |
148 <module name="DefaultComesLast"/> |
176 </module> |
149 <module name="MissingCtor"/> |
177 <module name="MethodParamPad"> |
150 <module name="FallThrough"/> |
178 <property name="severity" value="error"/> |
151 <module name="MultipleStringLiterals"> |
179 </module> |
152 <property name="allowedDuplicates" value="2"/> |
180 <module name="NoWhitespaceAfter"> |
153 </module> |
181 <property name="severity" value="error"/> |
154 <module name="MultipleVariableDeclarations"/> |
182 </module> |
155 <module name="UnnecessaryParentheses"/> |
183 <module name="NoWhitespaceBefore"> |
156 <module name="ParameterAssignment"/> |
184 <property name="severity" value="error"/> |
157 <module name="EqualsAvoidNull"> |
185 </module> |
158 <property name="severity" value="error"/> |
186 <module name="OperatorWrap"/> |
159 </module> |
187 <module name="ParenPad"> |
160 <module name="NoClone"/> |
188 <property name="severity" value="error"/> |
161 <module name="NoFinalizer"/> |
189 </module> |
162 <module name="SuperClone"/> |
190 <module name="TypecastParenPad"> |
163 <module name="SuperFinalize"/> |
191 <property name="severity" value="error"/> |
164 <module name="ModifiedControlVariable"> |
192 </module> |
165 <property name="severity" value="error"/> |
193 <!-- We want mixed tabulation |
166 </module> |
194 <module name="TabCharacter"/> |
167 <module name="ReturnCount"> |
195 --> |
168 <property name="max" value="3"/> |
196 <module name="WhitespaceAfter"> |
169 </module> |
197 <property name="severity" value="error"/> |
170 <module name="FinalClass"/> |
198 </module> |
171 <module name="HideUtilityClassConstructor"/> |
199 <module name="WhitespaceAround"> |
172 <module name="VisibilityModifier"/> |
200 <property name="severity" value="error"/> |
173 <module name="MutableException"/> |
201 </module> |
174 <module name="ThrowsCount"> |
202 |
175 <property name="max" value="2"/> |
203 |
176 </module> |
204 <!-- Modifier Checks --> |
177 <module name="ArrayTypeStyle"/> |
205 <!-- See http://checkstyle.sf.net/config_modifiers.html --> |
178 <module name="FinalParameters"> |
206 <module name="ModifierOrder"> |
179 <property name="tokens" value="CTOR_DEF"/> |
207 <property name="severity" value="error"/> |
180 </module> |
208 </module> |
181 <module name="Indentation"/> |
209 <module name="RedundantModifier"> |
182 <module name="TodoComment"/> |
210 <property name="severity" value="error"/> |
183 <module name="UpperEll"/> |
211 </module> |
184 <module name="BooleanExpressionComplexity"/> |
212 |
185 <module name="UpperEll"/> |
213 |
186 <module name="ArrayTypeStyle"/> |
214 <!-- Checks for blocks. You know, those {}'s --> |
187 </module> |
215 <!-- See http://checkstyle.sf.net/config_blocks.html --> |
188 <module name="JavadocPackage"> |
216 <module name="AvoidNestedBlocks"/> |
189 <property name="allowLegacy" value="true"/> |
217 <module name="EmptyBlock"/> |
190 </module> |
218 <module name="LeftCurly"> |
191 <module name="NewlineAtEndOfFile"> |
219 <property name="severity" value="error"/> |
192 <property name="severity" value="error"/> |
220 </module> |
193 </module> |
221 <module name="RightCurly"> |
194 <module name="Translation"> |
222 <property name="severity" value="error"/> |
195 <property name="severity" value="error"/> |
223 </module> |
196 </module> |
224 <!-- |
197 <module name="FileLength"/> |
225 <module name="NeedBraces"/> |
198 <module name="RegexpSingleline"> |
226 --> |
199 <property name="severity" value="error"/> |
227 |
200 <property name="format" value="\s+$"/> |
228 <!-- Check for annotations |
201 <property name="message" value="Line has trailing spaces."/> |
229 http://checkstyle.sourceforge.net/config_annotation.html#MissingDeprecated |
202 </module> |
230 --> |
203 <module name="RegexpHeader"> |
231 <module name="AnnotationUseStyle"> |
204 <property name="severity" value="error"/> |
232 <property name="severity" value="error"/> |
205 <property name="headerFile" value="${basedir}/tools/JavaHeaderCheck.regex"/> |
233 </module> |
206 <property name="multiLines" value="5, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38"/> |
234 <module name="MissingDeprecated"> |
207 </module> |
235 <property name="severity" value="error"/> |
|
236 </module> |
|
237 <module name="MissingOverride"> |
|
238 <property name="severity" value="error"/> |
|
239 </module> |
|
240 |
|
241 <!-- Checks for common coding problems --> |
|
242 <!-- See http://checkstyle.sf.net/config_coding.html --> |
|
243 <module name="CovariantEquals"/> |
|
244 <module name="AvoidInlineConditionals"/> |
|
245 <module name="InnerAssignment" /> |
|
246 <module name="DoubleCheckedLocking"/> <!-- MY FAVOURITE --> |
|
247 <module name="EmptyStatement"/> |
|
248 <module name="EqualsHashCode"> |
|
249 <property name="severity" value="error"/> |
|
250 </module> |
|
251 <module name="HiddenField"> |
|
252 <property name="ignoreConstructorParameter" value="true"/> |
|
253 <property name="ignoreAbstractMethods" value="true"/> |
|
254 <property name="ignoreSetter" value="true"/> |
|
255 </module> |
|
256 <module name="IllegalInstantiation"/> |
|
257 <module name="InnerAssignment"> |
|
258 <property name="severity" value="error"/> |
|
259 </module> |
|
260 <module name="MagicNumber"/> |
|
261 <module name="MissingSwitchDefault"> |
|
262 <property name="severity" value="error"/> |
|
263 </module> |
|
264 <module name="RedundantThrows"/> |
|
265 <module name="SimplifyBooleanExpression"> |
|
266 <property name="severity" value="error"/> |
|
267 </module> |
|
268 <module name="SimplifyBooleanReturn"> |
|
269 <property name="severity" value="error"/> |
|
270 </module> |
|
271 <module name="StringLiteralEquality"> |
|
272 <property name="severity" value="error"/> |
|
273 </module> |
|
274 <module name="IllegalCatch"/> |
|
275 <module name="IllegalThrows"/> |
|
276 <module name="IllegalType"/> |
|
277 <module name="PackageDeclaration"/> |
|
278 <module name="JUnitTestCase"/> |
|
279 <module name="DeclarationOrder"> |
|
280 <property name="severity" value="error"/> |
|
281 </module> |
|
282 <module name="ExplicitInitialization"/> |
|
283 <module name="DefaultComesLast"/> |
|
284 <module name="MissingCtor"/> |
|
285 <module name="FallThrough"/> |
|
286 <module name="MultipleStringLiterals"> |
|
287 <property name="allowedDuplicates" value="2"/> |
|
288 </module> |
|
289 <module name="MultipleVariableDeclarations"/> |
|
290 <module name="UnnecessaryParentheses"/> |
|
291 <module name="ParameterAssignment"/> |
|
292 <module name="EqualsAvoidNull"> |
|
293 <property name="severity" value="error"/> |
|
294 </module> |
|
295 <module name="NoClone"/> |
|
296 <module name="NoFinalizer"/> |
|
297 <module name="SuperClone"/> |
|
298 <module name="SuperFinalize"/> |
|
299 <module name="ModifiedControlVariable"> |
|
300 <property name="severity" value="error"/> |
|
301 </module> |
|
302 <module name="ReturnCount"> |
|
303 <property name="max" value="3"/> |
|
304 </module> |
|
305 |
|
306 <!-- Checks for class design --> |
|
307 <!-- See http://checkstyle.sf.net/config_design.html --> |
|
308 <!-- |
|
309 <module name="DesignForExtension"/> |
|
310 --> |
|
311 <module name="FinalClass"/> |
|
312 <module name="HideUtilityClassConstructor"/> |
|
313 <!-- |
|
314 <module name="InterfaceIsType"/> |
|
315 --> |
|
316 <module name="VisibilityModifier"/> |
|
317 <module name="MutableException"/> |
|
318 <module name="ThrowsCount"> |
|
319 <property name="max" value="2" /> |
|
320 </module> |
|
321 |
|
322 |
|
323 <!-- Miscellaneous other checks. --> |
|
324 <!-- See http://checkstyle.sf.net/config_misc.html --> |
|
325 <module name="ArrayTypeStyle"/> |
|
326 <module name="FinalParameters"> |
|
327 <property name="tokens" value="CTOR_DEF"/> |
|
328 </module> |
|
329 <module name="Indentation"/> |
|
330 |
|
331 <module name="TodoComment"/> |
|
332 <module name="UpperEll"/> |
|
333 |
|
334 <module name="BooleanExpressionComplexity"/> |
|
335 <module name="UpperEll"/> |
|
336 |
|
337 <module name="ArrayTypeStyle"/> |
|
338 |
|
339 </module> |
|
340 |
208 </module> |
341 </module> |