|
1 | 1 | <?xml version="1.0"?>
|
2 | 2 | <!DOCTYPE module PUBLIC
|
3 |
| - "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN" |
4 |
| - "http://checkstyle.sourceforge.net/dtds/configuration_1_3.dtd"> |
| 3 | + "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN" |
| 4 | + "https://checkstyle.org/dtds/configuration_1_3.dtd"> |
5 | 5 |
|
6 | 6 | <!--
|
7 | 7 | Checkstyle configuration that checks the Google coding conventions from Google Java Style
|
8 |
| - that can be found at https://google.github.io/styleguide/javaguide.html. |
| 8 | + that can be found at https://google.github.io/styleguide/javaguide.html |
9 | 9 |
|
10 | 10 | Checkstyle is very configurable. Be sure to read the documentation at
|
11 |
| - http://checkstyle.sf.net (or in your downloaded distribution). |
| 11 | + http://checkstyle.org (or in your downloaded distribution). |
12 | 12 |
|
13 | 13 | To completely disable a check, just comment it out or delete it from the file.
|
| 14 | + To suppress certain violations please review suppression filters. |
14 | 15 |
|
15 |
| - Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov. |
16 |
| ---> |
| 16 | + Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov. |
| 17 | + --> |
17 | 18 |
|
18 |
| -<module name = "Checker"> |
| 19 | +<module name="Checker"> |
19 | 20 | <property name="charset" value="UTF-8"/>
|
20 | 21 |
|
21 | 22 | <property name="severity" value="warning"/>
|
22 | 23 |
|
23 | 24 | <property name="fileExtensions" value="java, properties, xml"/>
|
| 25 | + <!-- Excludes all 'module-info.java' files --> |
| 26 | + <!-- See https://checkstyle.org/config_filefilters.html --> |
| 27 | + <module name="BeforeExecutionExclusionFileFilter"> |
| 28 | + <property name="fileNamePattern" value="module\-info\.java$"/> |
| 29 | + </module> |
| 30 | + <!-- https://checkstyle.org/config_filters.html#SuppressionFilter --> |
| 31 | + <module name="SuppressionFilter"> |
| 32 | + <property name="file" value="${org.checkstyle.google.suppressionfilter.config}" |
| 33 | + default="checkstyle-suppressions.xml"/> |
| 34 | + <property name="optional" value="true"/> |
| 35 | + </module> |
| 36 | + |
24 | 37 | <!-- Checks for whitespace -->
|
25 |
| - <!-- See http://checkstyle.sf.net/config_whitespace.html --> |
| 38 | + <!-- See http://checkstyle.org/config_whitespace.html --> |
26 | 39 | <module name="FileTabCharacter">
|
27 | 40 | <property name="eachLine" value="true"/>
|
28 | 41 | </module>
|
29 | 42 |
|
30 |
| - <module name="SuppressWarningsFilter" /> |
| 43 | + <module name="LineLength"> |
| 44 | + <property name="fileExtensions" value="java"/> |
| 45 | + <property name="max" value="100"/> |
| 46 | + <property name="ignorePattern" |
| 47 | + value="^package.*|^import.*|a href|href|http://|https://|ftp://"/> |
| 48 | + </module> |
31 | 49 |
|
32 | 50 | <module name="TreeWalker">
|
33 |
| - <module name="SuppressWarningsHolder" /> |
34 | 51 | <module name="OuterTypeFilename"/>
|
35 | 52 | <module name="IllegalTokenText">
|
36 | 53 | <property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
|
|
44 | 61 | <property name="allowByTailComment" value="true"/>
|
45 | 62 | <property name="allowNonPrintableEscapes" value="true"/>
|
46 | 63 | </module>
|
47 |
| - <module name="LineLength"> |
48 |
| - <property name="max" value="100"/> |
49 |
| - <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/> |
50 |
| - </module> |
51 | 64 | <module name="AvoidStarImport"/>
|
52 | 65 | <module name="OneTopLevelClass"/>
|
53 |
| - <module name="NoLineWrap"/> |
| 66 | + <module name="NoLineWrap"> |
| 67 | + <property name="tokens" value="PACKAGE_DEF, IMPORT, STATIC_IMPORT"/> |
| 68 | + </module> |
54 | 69 | <module name="EmptyBlock">
|
55 | 70 | <property name="option" value="TEXT"/>
|
56 | 71 | <property name="tokens"
|
57 | 72 | value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
|
58 | 73 | </module>
|
59 |
| - <module name="NeedBraces"/> |
60 |
| - <module name="LeftCurly"/> |
| 74 | + <module name="NeedBraces"> |
| 75 | + <property name="tokens" |
| 76 | + value="LITERAL_DO, LITERAL_ELSE, LITERAL_FOR, LITERAL_IF, LITERAL_WHILE"/> |
| 77 | + </module> |
| 78 | + <module name="LeftCurly"> |
| 79 | + <property name="tokens" |
| 80 | + value="ANNOTATION_DEF, CLASS_DEF, CTOR_DEF, ENUM_CONSTANT_DEF, ENUM_DEF, |
| 81 | + INTERFACE_DEF, LAMBDA, LITERAL_CASE, LITERAL_CATCH, LITERAL_DEFAULT, |
| 82 | + LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, |
| 83 | + LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, METHOD_DEF, |
| 84 | + OBJBLOCK, STATIC_INIT"/> |
| 85 | + </module> |
61 | 86 | <module name="RightCurly">
|
62 | 87 | <property name="id" value="RightCurlySame"/>
|
63 | 88 | <property name="tokens"
|
|
69 | 94 | <property name="option" value="alone"/>
|
70 | 95 | <property name="tokens"
|
71 | 96 | value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT,
|
72 |
| - INSTANCE_INIT"/> |
| 97 | + INSTANCE_INIT, ANNOTATION_DEF, ENUM_DEF"/> |
| 98 | + </module> |
| 99 | + <module name="SuppressionXpathSingleFilter"> |
| 100 | + <!-- suppresion is required till https://github.com/checkstyle/checkstyle/issues/7541 --> |
| 101 | + <property name="id" value="RightCurlyAlone"/> |
| 102 | + <property name="query" value="//RCURLY[parent::SLIST[count(./*)=1] |
| 103 | + or preceding-sibling::*[last()][self::LCURLY]]"/> |
| 104 | + </module> |
| 105 | + <module name="WhitespaceAfter"> |
| 106 | + <property name="tokens" |
| 107 | + value="COMMA, SEMI, TYPECAST, LITERAL_IF, LITERAL_ELSE, |
| 108 | + LITERAL_WHILE, LITERAL_DO, LITERAL_FOR, DO_WHILE"/> |
73 | 109 | </module>
|
74 | 110 | <module name="WhitespaceAround">
|
75 | 111 | <property name="allowEmptyConstructors" value="true"/>
|
| 112 | + <property name="allowEmptyLambdas" value="true"/> |
76 | 113 | <property name="allowEmptyMethods" value="true"/>
|
77 | 114 | <property name="allowEmptyTypes" value="true"/>
|
78 | 115 | <property name="allowEmptyLoops" value="true"/>
|
| 116 | + <property name="tokens" |
| 117 | + value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, |
| 118 | + BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, DO_WHILE, EQUAL, GE, GT, LAMBDA, LAND, |
| 119 | + LCURLY, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, |
| 120 | + LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SWITCH, LITERAL_SYNCHRONIZED, |
| 121 | + LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN, |
| 122 | + NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR, |
| 123 | + SR_ASSIGN, STAR, STAR_ASSIGN, LITERAL_ASSERT, TYPE_EXTENSION_AND"/> |
79 | 124 | <message key="ws.notFollowed"
|
80 | 125 | value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)"/>
|
81 | 126 | <message key="ws.notPreceded"
|
|
89 | 134 | <module name="UpperEll"/>
|
90 | 135 | <module name="ModifierOrder"/>
|
91 | 136 | <module name="EmptyLineSeparator">
|
| 137 | + <property name="tokens" |
| 138 | + value="PACKAGE_DEF, IMPORT, STATIC_IMPORT, CLASS_DEF, INTERFACE_DEF, ENUM_DEF, |
| 139 | + STATIC_INIT, INSTANCE_INIT, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/> |
92 | 140 | <property name="allowNoEmptyLineBetweenFields" value="true"/>
|
93 | 141 | </module>
|
94 | 142 | <module name="SeparatorWrap">
|
|
124 | 172 | value="Package name ''{0}'' must match pattern ''{1}''."/>
|
125 | 173 | </module>
|
126 | 174 | <module name="TypeName">
|
| 175 | + <property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF"/> |
127 | 176 | <message key="name.invalidPattern"
|
128 | 177 | value="Type name ''{0}'' must match pattern ''{1}''."/>
|
129 | 178 | </module>
|
|
137 | 186 | <message key="name.invalidPattern"
|
138 | 187 | value="Parameter name ''{0}'' must match pattern ''{1}''."/>
|
139 | 188 | </module>
|
| 189 | + <module name="LambdaParameterName"> |
| 190 | + <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/> |
| 191 | + <message key="name.invalidPattern" |
| 192 | + value="Lambda parameter name ''{0}'' must match pattern ''{1}''."/> |
| 193 | + </module> |
140 | 194 | <module name="CatchParameterName">
|
141 | 195 | <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
|
142 | 196 | <message key="name.invalidPattern"
|
143 | 197 | value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
|
144 | 198 | </module>
|
145 | 199 | <module name="LocalVariableName">
|
146 |
| - <property name="tokens" value="VARIABLE_DEF"/> |
147 | 200 | <property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
|
148 | 201 | <message key="name.invalidPattern"
|
149 | 202 | value="Local variable name ''{0}'' must match pattern ''{1}''."/>
|
|
187 | 240 | <module name="AbbreviationAsWordInName">
|
188 | 241 | <property name="ignoreFinal" value="false"/>
|
189 | 242 | <property name="allowedAbbreviationLength" value="1"/>
|
| 243 | + <property name="tokens" |
| 244 | + value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, ANNOTATION_FIELD_DEF, |
| 245 | + PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF"/> |
190 | 246 | </module>
|
191 | 247 | <module name="OverloadMethodsDeclarationOrder"/>
|
192 | 248 | <module name="VariableDeclarationUsageDistance"/>
|
193 | 249 | <module name="CustomImportOrder">
|
194 | 250 | <property name="sortImportsInGroupAlphabetically" value="true"/>
|
195 | 251 | <property name="separateLineBetweenGroups" value="true"/>
|
196 | 252 | <property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/>
|
| 253 | + <property name="tokens" value="IMPORT, STATIC_IMPORT, PACKAGE_DEF"/> |
| 254 | + </module> |
| 255 | + <module name="MethodParamPad"> |
| 256 | + <property name="tokens" |
| 257 | + value="CTOR_DEF, LITERAL_NEW, METHOD_CALL, METHOD_DEF, |
| 258 | + SUPER_CTOR_CALL, ENUM_CONSTANT_DEF"/> |
197 | 259 | </module>
|
198 |
| - <module name="MethodParamPad"/> |
199 | 260 | <module name="NoWhitespaceBefore">
|
200 | 261 | <property name="tokens"
|
201 |
| - value="COMMA, SEMI, POST_INC, POST_DEC, DOT, ELLIPSIS, METHOD_REF"/> |
| 262 | + value="COMMA, SEMI, POST_INC, POST_DEC, DOT, |
| 263 | + LABELED_STAT, METHOD_REF"/> |
202 | 264 | <property name="allowLineBreaks" value="true"/>
|
203 | 265 | </module>
|
204 |
| - <module name="ParenPad"/> |
| 266 | + <module name="ParenPad"> |
| 267 | + <property name="tokens" |
| 268 | + value="ANNOTATION, ANNOTATION_FIELD_DEF, CTOR_CALL, CTOR_DEF, DOT, ENUM_CONSTANT_DEF, |
| 269 | + EXPR, LITERAL_CATCH, LITERAL_DO, LITERAL_FOR, LITERAL_IF, LITERAL_NEW, |
| 270 | + LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_WHILE, METHOD_CALL, |
| 271 | + METHOD_DEF, QUESTION, RESOURCE_SPECIFICATION, SUPER_CTOR_CALL, LAMBDA"/> |
| 272 | + </module> |
205 | 273 | <module name="OperatorWrap">
|
206 | 274 | <property name="option" value="NL"/>
|
207 | 275 | <property name="tokens"
|
|
219 | 287 | <property name="allowSamelineMultipleAnnotations" value="true"/>
|
220 | 288 | </module>
|
221 | 289 | <module name="NonEmptyAtclauseDescription"/>
|
| 290 | + <module name="InvalidJavadocPosition"/> |
222 | 291 | <module name="JavadocTagContinuationIndentation"/>
|
223 | 292 | <module name="SummaryJavadoc">
|
224 | 293 | <property name="forbiddenSummaryFragments"
|
|
233 | 302 | <module name="JavadocMethod">
|
234 | 303 | <property name="scope" value="public"/>
|
235 | 304 | <property name="allowMissingParamTags" value="true"/>
|
236 |
| - <property name="allowMissingThrowsTags" value="true"/> |
237 | 305 | <property name="allowMissingReturnTag" value="true"/>
|
| 306 | + <property name="allowedAnnotations" value="Override, Test"/> |
| 307 | + <property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF"/> |
| 308 | + </module> |
| 309 | + <module name="MissingJavadocMethod"> |
| 310 | + <property name="scope" value="public"/> |
238 | 311 | <property name="minLineCount" value="2"/>
|
239 | 312 | <property name="allowedAnnotations" value="Override, Test"/>
|
240 |
| - <property name="allowThrowsTagsForSubclasses" value="true"/> |
| 313 | + <property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF"/> |
241 | 314 | </module>
|
242 | 315 | <module name="MethodName">
|
243 | 316 | <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
|
|
250 | 323 | <module name="EmptyCatchBlock">
|
251 | 324 | <property name="exceptionVariableName" value="expected"/>
|
252 | 325 | </module>
|
253 |
| - <module name="CommentsIndentation"/> |
| 326 | + <module name="CommentsIndentation"> |
| 327 | + <property name="tokens" value="SINGLE_LINE_COMMENT, BLOCK_COMMENT_BEGIN"/> |
| 328 | + </module> |
| 329 | + <!-- https://checkstyle.org/config_filters.html#SuppressionXpathFilter --> |
| 330 | + <module name="SuppressionXpathFilter"> |
| 331 | + <property name="file" value="${org.checkstyle.google.suppressionxpathfilter.config}" |
| 332 | + default="checkstyle-xpath-suppressions.xml"/> |
| 333 | + <property name="optional" value="true"/> |
| 334 | + </module> |
254 | 335 | </module>
|
255 | 336 | </module>
|
0 commit comments