| 1 |
<?xml version="1.0"?> |
| 2 |
<!DOCTYPE module PUBLIC |
| 3 |
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN" |
| 4 |
"https://checkstyle.org/dtds/configuration_1_3.dtd"> |
| 5 |
|
| 6 |
<!-- |
| 7 |
Checkstyle configuration that checks the Jetty coding conventions. |
| 8 |
--> |
| 9 |
|
| 10 |
<module name = "Checker"> |
| 11 |
<property name="charset" value="UTF-8"/> |
| 12 |
|
| 13 |
<property name="severity" value="warning"/> |
| 14 |
|
| 15 |
<property name="fileExtensions" value="java"/> |
| 16 |
|
| 17 |
<!-- Excludes all 'module-info.java' files --> |
| 18 |
<!-- See https://checkstyle.org/config_filefilters.html --> |
| 19 |
<module name="BeforeExecutionExclusionFileFilter"> |
| 20 |
<property name="fileNamePattern" value="module\-info\.java$"/> |
| 21 |
</module> |
| 22 |
|
| 23 |
<!-- Excludes all quiche files --> |
| 24 |
<!-- See https://checkstyle.org/config_filefilters.html --> |
| 25 |
<module name="BeforeExecutionExclusionFileFilter"> |
| 26 |
<property name="fileNamePattern" value="[/\\]org[/\\]eclipse[/\\]jetty[/\\]quic[/\\]quiche[/\\]"/> |
| 27 |
</module> |
| 28 |
|
| 29 |
<!-- Checks for whitespace --> |
| 30 |
<!-- See http://checkstyle.sf.net/config_whitespace.html --> |
| 31 |
<module name="FileTabCharacter"> |
| 32 |
<property name="eachLine" value="true"/> |
| 33 |
</module> |
| 34 |
|
| 35 |
<module name="TreeWalker"> |
| 36 |
<module name="SuppressionCommentFilter"> |
| 37 |
<property name="offCommentFormat" value="@checkstyle-disable-check : ([\w\|]+)"/> |
| 38 |
<property name="onCommentFormat" value="@checkstyle-enable-check : ([\w\|]+)"/> |
| 39 |
<property name="checkFormat" value="$1"/> |
| 40 |
</module> |
| 41 |
|
| 42 |
<!-- |
| 43 |
Eclipse Jetty Specific. |
| 44 |
=========================================================================================== |
| 45 |
--> |
| 46 |
|
| 47 |
<!-- Location of Annotations --> |
| 48 |
<module name="AnnotationLocation"> |
| 49 |
<property name="allowSamelineSingleParameterlessAnnotation" value="false"/> |
| 50 |
</module> |
| 51 |
|
| 52 |
<!-- Catch Parameter Name Format --> |
| 53 |
<module name="CatchParameterName"> |
| 54 |
<property name="format" value="^(e|t|x|ex|th|e2|[a-z][a-z][a-zA-Z0-9]+)$"/> |
| 55 |
</module> |
| 56 |
|
| 57 |
<!-- Class Type Parameter Name Format --> |
| 58 |
<module name="ClassTypeParameterName"> |
| 59 |
<property name="format" value="^[A-Z][A-Z0-9]*$"/> |
| 60 |
</module> |
| 61 |
|
| 62 |
<!-- Import Line Ordering --> |
| 63 |
<module name="CustomImportOrder"> |
| 64 |
<property name="sortImportsInGroupAlphabetically" value="true"/> |
| 65 |
<property name="separateLineBetweenGroups" value="true"/> |
| 66 |
<property name="customImportOrderRules" value="STANDARD_JAVA_PACKAGE###THIRD_PARTY_PACKAGE###STATIC"/> |
| 67 |
</module> |
| 68 |
|
| 69 |
<!-- do not allow empty blocks in: try, finally, if, else, or switch --> |
| 70 |
<module name="EmptyBlock"> |
| 71 |
<property name="option" value="TEXT"/> |
| 72 |
<property name="tokens" |
| 73 |
value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/> |
| 74 |
</module> |
| 75 |
|
| 76 |
<!-- enforce empty line after specified tokens --> |
| 77 |
<module name="EmptyLineSeparator"> |
| 78 |
<property name="allowNoEmptyLineBetweenFields" value="true"/> |
| 79 |
<property name="allowMultipleEmptyLines" value="false"/> |
| 80 |
<property name="tokens" |
| 81 |
value="PACKAGE_DEF, IMPORT, STATIC_IMPORT, CLASS_DEF, INTERFACE_DEF, ENUM_DEF, |
| 82 |
STATIC_INIT, INSTANCE_INIT, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/> |
| 83 |
</module> |
| 84 |
|
| 85 |
<!-- Indentation Rules --> |
| 86 |
<!-- Disabled: does not support Java 17 new switch/case |
| 87 |
<module name="Indentation"> |
| 88 |
<property name="arrayInitIndent" value="8"/> |
| 89 |
</module> |
| 90 |
--> |
| 91 |
|
| 92 |
<!-- Interface Type Parameter Name --> |
| 93 |
<module name="InterfaceTypeParameterName"> |
| 94 |
<property name="format" value="^[A-Z][A-Z0-9]*$"/> |
| 95 |
</module> |
| 96 |
|
| 97 |
<!-- left curly brace must be on new line --> |
| 98 |
<module name="LeftCurly"> |
| 99 |
<property name="option" value="nl"/> |
| 100 |
</module> |
| 101 |
|
| 102 |
<!-- Method Type Parameter Name --> |
| 103 |
<module name="MethodTypeParameterName"> |
| 104 |
<property name="format" value="^[A-Z][A-Z0-9]*$"/> |
| 105 |
</module> |
| 106 |
|
| 107 |
<!-- Member Name Format --> |
| 108 |
<module name="MemberName"> |
| 109 |
<property name="format" value="^[_a-z][a-zA-Z0-9]*$" /> |
| 110 |
</module> |
| 111 |
|
| 112 |
<!-- require braces is disabled - we don't enforce that in Jetty |
| 113 |
<module name="NeedBraces"> |
| 114 |
<property name="allowSingleLineStatement" value="true"/> |
| 115 |
</module> |
| 116 |
--> |
| 117 |
|
| 118 |
<!-- Enforced Whitespace After specific tokens --> |
| 119 |
<module name="WhitespaceAfter"> |
| 120 |
<property name="tokens" value="COMMA, SEMI, LITERAL_IF, LITERAL_ELSE, LITERAL_WHILE, LITERAL_DO, LITERAL_FOR, DO_WHILE" /> |
| 121 |
</module> |
| 122 |
|
| 123 |
<!-- No Whitespace After specific tokens --> |
| 124 |
<module name="NoWhitespaceAfter"> |
| 125 |
<property name="tokens" value="ARRAY_INIT, AT, INC, DEC, UNARY_MINUS, UNARY_PLUS, BNOT, LNOT, DOT, ARRAY_DECLARATOR, INDEX_OP, TYPECAST" /> |
| 126 |
<property name="allowLineBreaks" value="true" /> |
| 127 |
</module> |
| 128 |
|
| 129 |
<!-- No Whitespace Before specific tokens --> |
| 130 |
<module name="NoWhitespaceBefore"> |
| 131 |
<property name="tokens" |
| 132 |
value="COMMA, SEMI, POST_INC, POST_DEC, DOT, ELLIPSIS, METHOD_REF"/> |
| 133 |
<property name="allowLineBreaks" value="true"/> |
| 134 |
</module> |
| 135 |
|
| 136 |
<!-- allowed wrapping for operators --> |
| 137 |
<module name="OperatorWrap"> |
| 138 |
<property name="id" value="OperatorWrapNextLine"/> |
| 139 |
<property name="tokens" value="QUESTION, COLON"/> |
| 140 |
<property name="option" value="nl"/> |
| 141 |
</module> |
| 142 |
<module name="OperatorWrap"> |
| 143 |
<property name="id" value="OperatorWrapSameLine"/> |
| 144 |
<property name="tokens" value="EQUAL, NOT_EQUAL, DIV, PLUS, MINUS, STAR, MOD, SR, BSR, GE, GT, SL, LE, LT, BXOR, BOR, LOR, BAND, LAND, TYPE_EXTENSION_AND, LITERAL_INSTANCEOF"/> |
| 145 |
<property name="option" value="eol"/> |
| 146 |
</module> |
| 147 |
|
| 148 |
<!-- ensure we don't have legacy comments that confuse javadoc tooling --> |
| 149 |
<module name="Regexp"> |
| 150 |
<property name="id" value="LegacyMethodSeparators"/> |
| 151 |
<property name="format" value="/\*\s*[=*-]+\s*\*/" /> |
| 152 |
<property name="illegalPattern" value="true"/> |
| 153 |
<property name="ignoreComments" value="false"/> |
| 154 |
<property name="message" value="Legacy Method Separators"/> |
| 155 |
</module> |
| 156 |
|
| 157 |
<!-- right curly brace must be on new line --> |
| 158 |
<module name="RightCurly"> |
| 159 |
<property name="option" value="alone_or_singleline"/> |
| 160 |
</module> |
| 161 |
|
| 162 |
<!-- Various Wrapping of ".", ",", "...", "[]", and method ref New Lines --> |
| 163 |
<module name="SeparatorWrap"> |
| 164 |
<property name="id" value="SeparatorWrapNextLine"/> |
| 165 |
<property name="tokens" value="DOT"/> |
| 166 |
<property name="option" value="nl"/> |
| 167 |
</module> |
| 168 |
<module name="SeparatorWrap"> |
| 169 |
<property name="id" value="SeparatorWrapSameLine"/> |
| 170 |
<property name="tokens" value="COMMA, ELLIPSIS, ARRAY_DECLARATOR, METHOD_REF"/> |
| 171 |
<property name="option" value="eol"/> |
| 172 |
</module> |
| 173 |
|
| 174 |
<!-- checks that a token is followed by whitespace --> |
| 175 |
<module name="WhitespaceAround"> |
| 176 |
<property name="allowEmptyConstructors" value="true"/> |
| 177 |
<property name="allowEmptyLambdas" value="true"/> |
| 178 |
<property name="allowEmptyMethods" value="true"/> |
| 179 |
<property name="allowEmptyTypes" value="true"/> |
| 180 |
<property name="allowEmptyLoops" value="true"/> |
| 181 |
</module> |
| 182 |
|
| 183 |
<!-- |
| 184 |
Checks based on common Open Source specific recommendations. |
| 185 |
=========================================================================================== |
| 186 |
--> |
| 187 |
|
| 188 |
<!-- limit use of unicode escape sequences (eg "\u20ac") in mainline code. --> |
| 189 |
<module name="AvoidEscapedUnicodeCharacters"> |
| 190 |
<!-- allow control characters to use unicode escape sequences --> |
| 191 |
<property name="allowEscapesForControlCharacters" value="true"/> |
| 192 |
<!-- allow unicode escape sequences if also followed by tail comments --> |
| 193 |
<property name="allowByTailComment" value="true"/> |
| 194 |
<!-- allow use of non-printable escape sequences --> |
| 195 |
<property name="allowNonPrintableEscapes" value="true"/> |
| 196 |
</module> |
| 197 |
|
| 198 |
<!-- not allowing star import lines --> |
| 199 |
<module name="AvoidStarImport"/> |
| 200 |
|
| 201 |
<!-- if you have an empty catch block, name the caught exception "ignored" --> |
| 202 |
<module name="EmptyCatchBlock"> |
| 203 |
<property name="exceptionVariableName" value="ignored"/> |
| 204 |
</module> |
| 205 |
|
| 206 |
<!-- if a switch statement contains java code, but lacks fall through comment its an error --> |
| 207 |
<module name="FallThrough"/> |
| 208 |
|
| 209 |
<!-- reject unicode or octal values in mainline code --> |
| 210 |
<module name="IllegalTokenText"> |
| 211 |
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/> |
| 212 |
<property name="format" |
| 213 |
value="\\u00(09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/> |
| 214 |
<property name="message" |
| 215 |
value="Consider using special escape sequence instead of octal value or Unicode escaped value."/> |
| 216 |
</module> |
| 217 |
|
| 218 |
<!-- all switch statements should have "default" label declared --> |
| 219 |
<!-- Disabled: Is super noisy |
| 220 |
<module name="MissingSwitchDefault"/> |
| 221 |
--> |
| 222 |
|
| 223 |
<!-- prevent line wrapping of import / package statements --> |
| 224 |
<module name="NoLineWrap"/> |
| 225 |
|
| 226 |
<!-- only 1 top level class defined per java file --> |
| 227 |
<module name="OneTopLevelClass"/> |
| 228 |
|
| 229 |
<!-- Filename and Classname match --> |
| 230 |
<module name="OuterTypeFilename"/> |
| 231 |
|
| 232 |
<!-- |
| 233 |
Checks based on the Java Language Specification recommendations. |
| 234 |
https://docs.oracle.com/javase/specs/jls/se8/html/index.html |
| 235 |
=========================================================================================== |
| 236 |
--> |
| 237 |
|
| 238 |
<!-- array type style --> |
| 239 |
<!-- int[] foo; // OK |
| 240 |
int foo[]; // BAD --> |
| 241 |
<module name="ArrayTypeStyle" /> |
| 242 |
|
| 243 |
<!-- Whitespace around Generics (angle brackets) follow convention --> |
| 244 |
<module name="GenericWhitespace" /> |
| 245 |
|
| 246 |
<!-- Lambda Parameter Name Format --> |
| 247 |
<module name="LambdaParameterName" /> |
| 248 |
|
| 249 |
<!-- Local Parameter Name Format --> |
| 250 |
<module name="LocalVariableName" /> |
| 251 |
|
| 252 |
<!-- Method Name Format --> |
| 253 |
<module name="MethodName" /> |
| 254 |
|
| 255 |
<!-- Checks the padding between the identifier of a method definition, constructor definition, |
| 256 |
method call, or constructor invocation: nospace --> |
| 257 |
<module name="MethodParamPad"/> |
| 258 |
|
| 259 |
<!-- ensure that modifiers follow suggested order --> |
| 260 |
<module name="ModifierOrder"/> |
| 261 |
|
| 262 |
<!-- only 1 variable declaration per line --> |
| 263 |
<module name="MultipleVariableDeclarations"/> |
| 264 |
|
| 265 |
<!-- No Object.finalize() use --> |
| 266 |
<module name="NoFinalizer"/> |
| 267 |
|
| 268 |
<!-- checks that there is only one statement per line --> |
| 269 |
<module name="OneStatementPerLine"/> |
| 270 |
|
| 271 |
<!-- package name JLS rules --> |
| 272 |
<module name="PackageName" /> |
| 273 |
|
| 274 |
<!-- Parameter Name Format --> |
| 275 |
<module name="ParameterName" /> |
| 276 |
|
| 277 |
<!-- the policy on the padding of parentheses: nospace --> |
| 278 |
<module name="ParenPad"/> |
| 279 |
|
| 280 |
<!-- Type Name format --> |
| 281 |
<module name="TypeName" /> |
| 282 |
|
| 283 |
<!-- checks that long constants are defined with an upper ell. That is 'L' and not 'l' --> |
| 284 |
<module name="UpperEll"/> |
| 285 |
<!-- TODO: look for float / double version of above --> |
| 286 |
|
| 287 |
</module> |
| 288 |
</module> |