1<?xml version="1.0"?> 2<!DOCTYPE module PUBLIC 3 "-//Puppy Crawl//DTD Check Configuration 1.3//EN" 4 "http://www.puppycrawl.com/dtds/configuration_1_3.dtd"> 5 6<!-- 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. 9 10 Checkstyle is very configurable. Be sure to read the documentation at 11 http://checkstyle.sf.net (or in your downloaded distribution). 12 13 To completely disable a check, just comment it out or delete it from the file. 14 15 Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov. 16 --> 17 18<module name = "Checker"> 19 <property name="charset" value="UTF-8"/> 20 21 <property name="severity" value="error"/> 22 23 <module name="Header"> 24 <property name="headerFile" value="${config_loc}/checkstyle.license"/> 25 <property name="ignoreLines" value="2"/> 26 <property name="fileExtensions" value="java"/> 27 </module> 28 29 <property name="fileExtensions" value="java, properties, xml"/> 30 <!-- Checks for whitespace --> 31 <!-- See http://checkstyle.sf.net/config_whitespace.html --> 32 <module name="FileTabCharacter"> 33 <property name="eachLine" value="true"/> 34 </module> 35 36 <module name="TreeWalker"> 37 <module name="OuterTypeFilename"/> 38 <module name="IllegalTokenText"> 39 <property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/> 40 <property name="format" value="\\u00(08|09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/> 41 <property name="message" value="Avoid using corresponding octal or Unicode escape."/> 42 </module> 43 <module name="AvoidEscapedUnicodeCharacters"> 44 <property name="allowEscapesForControlCharacters" value="true"/> 45 <property name="allowByTailComment" value="true"/> 46 <property name="allowNonPrintableEscapes" value="true"/> 47 </module> 48 <module name="LineLength"> 49 <property name="max" value="100"/> 50 <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/> 51 </module> 52 <module name="AvoidStarImport"/> 53 <!-- TODO(ejona): Upstream? --> 54 <module name="UnusedImports"/> 55 <module name="OneTopLevelClass"/> 56 <module name="NoLineWrap"/> 57 <module name="EmptyBlock"> 58 <property name="option" value="TEXT"/> 59 <property name="tokens" value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/> 60 </module> 61 <module name="NeedBraces"/> 62 <module name="LeftCurly"> 63 <property name="maxLineLength" value="100"/> 64 </module> 65 <module name="RightCurly"/> 66 <module name="RightCurly"> 67 <property name="option" value="alone"/> 68 <property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, STATIC_INIT, INSTANCE_INIT"/> 69 </module> 70 <module name="WhitespaceAround"> 71 <property name="allowEmptyConstructors" value="true"/> 72 <property name="allowEmptyMethods" value="true"/> 73 <property name="allowEmptyTypes" value="true"/> 74 <property name="allowEmptyLoops" value="true"/> 75 <message key="ws.notFollowed" 76 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)"/> 77 <message key="ws.notPreceded" 78 value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/> 79 </module> 80 <module name="OneStatementPerLine"/> 81 <module name="MultipleVariableDeclarations"/> 82 <module name="ArrayTypeStyle"/> 83 <module name="MissingSwitchDefault"/> 84 <module name="FallThrough"/> 85 <module name="UpperEll"/> 86 <module name="ModifierOrder"/> 87 <module name="EmptyLineSeparator"> 88 <property name="allowNoEmptyLineBetweenFields" value="true"/> 89 </module> 90 <module name="SeparatorWrap"> 91 <property name="tokens" value="DOT"/> 92 <property name="option" value="nl"/> 93 </module> 94 <module name="SeparatorWrap"> 95 <property name="tokens" value="COMMA"/> 96 <property name="option" value="EOL"/> 97 </module> 98 <module name="PackageName"> 99 <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/> 100 <message key="name.invalidPattern" 101 value="Package name ''{0}'' must match pattern ''{1}''."/> 102 </module> 103 <module name="TypeName"> 104 <message key="name.invalidPattern" 105 value="Type name ''{0}'' must match pattern ''{1}''."/> 106 </module> 107 <module name="MemberName"> 108 <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/> 109 <message key="name.invalidPattern" 110 value="Member name ''{0}'' must match pattern ''{1}''."/> 111 </module> 112 <module name="ParameterName"> 113 <!-- TODO(ejona): too strict, as one-character parameter names are permitted 114 <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/--> 115 <property name="format" value="^[a-z][a-zA-Z0-9]*$"/> 116 <message key="name.invalidPattern" 117 value="Parameter name ''{0}'' must match pattern ''{1}''."/> 118 </module> 119 <module name="CatchParameterName"> 120 <!-- TODO(ejona): too strict, as one-character parameter names are permitted. 121 <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/--> 122 <property name="format" value="^[a-z][a-zA-Z0-9]*$"/> 123 <message key="name.invalidPattern" 124 value="Catch parameter name ''{0}'' must match pattern ''{1}''."/> 125 </module> 126 <module name="LocalVariableName"> 127 <property name="tokens" value="VARIABLE_DEF"/> 128 <!-- TODO(ejona): too strict, as one-character parameter names are permitted. 129 Add support for Unicode. 130 <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/--> 131 <property name="format" value="^[^A-Z]"/> 132 <property name="allowOneCharVarInForLoop" value="true"/> 133 <message key="name.invalidPattern" 134 value="Local variable name ''{0}'' must match pattern ''{1}''."/> 135 </module> 136 <module name="ClassTypeParameterName"> 137 <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/> 138 <message key="name.invalidPattern" 139 value="Class type name ''{0}'' must match pattern ''{1}''."/> 140 </module> 141 <module name="MethodTypeParameterName"> 142 <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/> 143 <message key="name.invalidPattern" 144 value="Method type name ''{0}'' must match pattern ''{1}''."/> 145 </module> 146 <module name="InterfaceTypeParameterName"> 147 <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/> 148 <message key="name.invalidPattern" 149 value="Interface type name ''{0}'' must match pattern ''{1}''."/> 150 </module> 151 <module name="NoFinalizer"/> 152 <module name="GenericWhitespace"> 153 <message key="ws.followed" 154 value="GenericWhitespace ''{0}'' is followed by whitespace."/> 155 <message key="ws.preceded" 156 value="GenericWhitespace ''{0}'' is preceded with whitespace."/> 157 <message key="ws.illegalFollow" 158 value="GenericWhitespace ''{0}'' should followed by whitespace."/> 159 <message key="ws.notPreceded" 160 value="GenericWhitespace ''{0}'' is not preceded with whitespace."/> 161 </module> 162 <module name="Indentation"> 163 <property name="basicOffset" value="2"/> 164 <property name="braceAdjustment" value="0"/> 165 <property name="caseIndent" value="2"/> 166 <property name="throwsIndent" value="4"/> 167 <property name="lineWrappingIndentation" value="4"/> 168 <property name="arrayInitIndent" value="2"/> 169 </module> 170 <module name="AbbreviationAsWordInName"> 171 <property name="ignoreFinal" value="false"/> 172 <property name="allowedAbbreviationLength" value="1"/> 173 </module> 174 <module name="OverloadMethodsDeclarationOrder"/> 175 <!-- TODO(ejona): Does not consider assignment during declaration as a usage. 176 <module name="VariableDeclarationUsageDistance"/--> 177 <module name="CustomImportOrder"> 178 <property name="sortImportsInGroupAlphabetically" value="true"/> 179 <property name="separateLineBetweenGroups" value="true"/> 180 <property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/> 181 </module> 182 <module name="MethodParamPad"/> 183 <module name="OperatorWrap"> 184 <property name="option" value="NL"/> 185 <property name="tokens" value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR "/> 186 </module> 187 <module name="AnnotationLocation"> 188 <property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/> 189 </module> 190 <module name="AnnotationLocation"> 191 <property name="tokens" value="VARIABLE_DEF"/> 192 <property name="allowSamelineMultipleAnnotations" value="true"/> 193 </module> 194 <module name="NonEmptyAtclauseDescription"/> 195 <module name="JavadocTagContinuationIndentation"/> 196 <module name="SummaryJavadoc"> 197 <property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/> 198 </module> 199 <module name="JavadocParagraph"/> 200 <module name="AtclauseOrder"> 201 <property name="tagOrder" value="@param, @return, @throws, @deprecated"/> 202 <property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/> 203 </module> 204 <module name="JavadocMethod"> 205 <property name="scope" value="public"/> 206 <property name="allowMissingParamTags" value="true"/> 207 <property name="allowMissingThrowsTags" value="true"/> 208 <property name="allowMissingReturnTag" value="true"/> 209 <property name="minLineCount" value="2"/> 210 <!-- TOOD(ejona): Too restrictive for tests 211 <property name="allowedAnnotations" value="Override, Test"/--> 212 <property name="allowedAnnotations" value="Override, Test, Before, After, BeforeClass, AfterClass, Setup, TearDown"/> 213 <property name="allowThrowsTagsForSubclasses" value="true"/> 214 </module> 215 <module name="MethodName"> 216 <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/> 217 <message key="name.invalidPattern" 218 value="Method name ''{0}'' must match pattern ''{1}''."/> 219 </module> 220 <module name="SingleLineJavadoc"> 221 <!-- TODO(ejona): Based on mis-reading of style; consider upstreaming 222 <property name="ignoreInlineTags" value="false"/--> 223 </module> 224 <module name="EmptyCatchBlock"> 225 <property name="exceptionVariableName" value="expected"/> 226 </module> 227 <module name="CommentsIndentation"/> 228 </module> 229</module> 230