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