src/main/config/checks.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2
   3 <!DOCTYPE module PUBLIC
   4     "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
   5     "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
   6
   7 <!--
   8     Checkstyle用チェック項目定義。
   9
  10     Checkstyle 5.5 以降向けに記述。
  11
  12     [ http://checkstyle.sourceforge.net/ ]
  13
  14     Copyright(c) 2010 olyutorskii
  15 -->
  16
  17
  18 <module name="Checker">
  19
  20     <property name="charset" value="UTF-8" />
  21     <property name="localeCountry" value="JP" />
  22     <property name="localeLanguage" value="ja" />
  23     <property name="severity" value="error" />
  24
  25
  26     <!-- Filters -->
  27     <module name="SeverityMatchFilter" />
  28     <module name="SuppressionFilter">
  29         <property name="file" value="src/main/config/suppressions.xml" />
  30     </module>
  31     <module name="SuppressionCommentFilter" />
  32     <module name="SuppressWithNearbyCommentFilter" />
  33
  34
  35     <!-- Duplicate Code -->
  36     <module name="StrictDuplicateCode">
  37         <property name="min" value="20" />
  38     </module>
  39
  40
  41     <!-- Headers -->
  42     <module name="RegexpHeader">
  43         <property name="header" value="^/\*$\n^ \*( .*)?$\n^ \*/$\n" />
  44         <property name="multiLines" value="2" />
  45     </module>
  46
  47
  48     <!-- Javadoc Comments -->
  49     <module name="JavadocPackage" />
  50
  51
  52     <!-- Miscellaneous -->
  53     <module name="NewlineAtEndOfFile" />
  54     <module name="Translation" />
  55
  56
  57     <!-- Regexp -->
  58     <module name="RegexpSingleline">
  59         <property name="format" value="\s+$" />
  60         <property name="minimum" value="0" />
  61         <property name="maximum" value="0" />
  62     </module>
  63
  64
  65     <!-- Size Violations -->
  66     <module name="FileLength" />
  67
  68
  69     <!-- Whitespace -->
  70     <module name="FileTabCharacter" />
  71
  72
  73     <module name="TreeWalker">
  74
  75         <module name="FileContentsHolder" />
  76
  77
  78     <!-- Annotations -->
  79
  80         <module name="AnnotationUseStyle" />
  81         <module name="MissingDeprecated" />
  82         <module name="MissingOverride" />
  83         <module name="PackageAnnotation" />
  84         <module name="SuppressWarnings" />
  85
  86
  87     <!-- Block Checks -->
  88
  89         <module name="EmptyBlock" />
  90         <module name="LeftCurly" />
  91         <module name="NeedBraces">
  92             <property name="tokens" value="LITERAL_DO" />
  93         </module>
  94         <module name="RightCurly" />
  95         <module name="AvoidNestedBlocks" />
  96
  97
  98     <!-- Class Design -->
  99
 100         <module name="VisibilityModifier" />
 101         <module name="FinalClass" />
 102         <module name="InterfaceIsType" />
 103         <module name="HideUtilityClassConstructor" />
 104 <!--    <module name="DesignForExtension" />  -->
 105         <module name="MutableException" />
 106         <module name="ThrowsCount">
 107             <property name="max" value="4" />
 108         </module>
 109         <module name="InnerTypeLast" />
 110
 111
 112     <!-- Coding -->
 113
 114         <module name="ArrayTrailingComma" />
 115         <module name="AvoidInlineConditionals" />
 116         <module name="CovariantEquals" />
 117 <!--    <module name="DoubleCheckedLocking" />  5.6 obsolete -->
 118         <module name="EmptyStatement" />
 119         <module name="EqualsAvoidNull" />
 120         <module name="EqualsHashCode" />
 121 <!--    <module name="FinalLocalVariable" />  -->
 122         <module name="HiddenField">
 123             <property name="ignoreConstructorParameter" value="true" />
 124             <property name="ignoreSetter" value="true" />
 125             <property name="ignoreAbstractMethods" value="true" />
 126         </module>
 127         <module name="IllegalInstantiation" />
 128         <module name="IllegalToken">
 129             <property name="tokens" value="LITERAL_NATIVE, STATIC_IMPORT" />
 130         </module>
 131         <module name="IllegalTokenText">
 132             <property name="tokens" value="NUM_INT, NUM_LONG" />
 133             <property name="format" value="^0[^lx]" />
 134             <property name="ignoreCase" value="true" />
 135         </module>
 136         <module name="InnerAssignment" />
 137         <module name="MagicNumber" />
 138         <module name="MissingSwitchDefault" />
 139         <module name="ModifiedControlVariable" />
 140         <module name="RedundantThrows">
 141             <property name="allowUnchecked" value="true" />
 142             <property name="allowSubclasses" value="true" />
 143         </module>
 144         <module name="SimplifyBooleanExpression" />
 145         <module name="SimplifyBooleanReturn" />
 146         <module name="StringLiteralEquality" />
 147         <module name="NestedForDepth" />
 148         <module name="NestedIfDepth" />
 149         <module name="NestedTryDepth" />
 150         <module name="NoClone" />
 151         <module name="NoFinalizer" />
 152         <module name="SuperClone" />
 153         <module name="SuperFinalize" />
 154         <module name="IllegalCatch" />
 155         <module name="IllegalThrows" />
 156         <module name="PackageDeclaration" />
 157         <module name="JUnitTestCase" />
 158         <module name="ReturnCount">
 159             <property name="max" value="5" />
 160         </module>
 161         <module name="IllegalType" />
 162         <module name="DeclarationOrder" />
 163         <module name="ParameterAssignment" />
 164 <!--    <module name="ExplicitInitialization" />  -->
 165         <module name="DefaultComesLast" />
 166         <module name="MissingCtor" />
 167         <module name="FallThrough" />
 168         <module name="MultipleStringLiterals" />
 169         <module name="MultipleVariableDeclarations" />
 170         <module name="RequireThis">
 171             <property name="checkMethods" value="false" />
 172         </module>
 173         <module name="UnnecessaryParentheses" />
 174         <module name="OneStatementPerLine" />
 175
 176
 177     <!-- Imports -->
 178
 179         <module name="AvoidStarImport" />
 180         <module name="AvoidStaticImport" />
 181         <module name="IllegalImport" />
 182         <module name="RedundantImport" />
 183         <module name="UnusedImports" />
 184         <module name="ImportOrder" />
 185 <!--    <module name="ImportControl" />  -->
 186
 187
 188     <!-- Javadoc Comments -->
 189
 190         <module name="JavadocType" />
 191         <module name="JavadocMethod" />
 192         <module name="JavadocVariable">
 193             <property name="scope" value="protected" />
 194         </module>
 195         <module name="JavadocStyle">
 196             <property
 197                 name="endOfSentenceFormat"
 198                 value="([。.?!][ \t\n\r\f&lt;])|([。.?!]$)" />
 199             <property name="checkEmptyJavadoc" value="true" />
 200             <property name="checkHtml" value="true" />
 201         </module>
 202 <!--    <module name="WriteTag" />  -->
 203
 204
 205     <!-- Metrics -->
 206
 207         <module name="BooleanExpressionComplexity" />
 208         <module name="ClassDataAbstractionCoupling" />
 209         <module name="ClassFanOutComplexity" />
 210         <module name="CyclomaticComplexity" />
 211         <module name="NPathComplexity" />
 212         <module name="JavaNCSS" />
 213
 214
 215     <!-- Miscellaneous -->
 216
 217         <module name="TodoComment">
 218             <property name="format" value="TODO" />
 219         </module>
 220         <module name="UncommentedMain" />
 221         <module name="UpperEll" />
 222         <module name="ArrayTypeStyle" />
 223 <!--    <module name="FinalParameters" />  -->
 224 <!--    <module name="DescendantToken" />  -->
 225 <!--
 226         <module name="Indentation">
 227             <property name="caseIndent" value="0" />
 228         </module>
 229 -->
 230 <!--    <module name="TrailingComment" />  -->
 231         <module name="Regexp">
 232             <property name="format" value="@author" />
 233             <property name="illegalPattern" value="true" />
 234         </module>
 235         <module name="Regexp">
 236             <property name="format" value="^ \* Copyright\(c\)" />
 237         </module>
 238         <module name="Regexp">
 239             <property name="format" value="^ \* License : The MIT License" />
 240             <property name="duplicateLimit" value="1" />
 241         </module>
 242         <module name="OuterTypeFilename" />
 243
 244
 245     <!-- Modifiers -->
 246
 247         <module name="ModifierOrder" />
 248         <module name="RedundantModifier" />
 249
 250
 251     <!-- Naming Conventions -->
 252
 253         <module name="AbstractClassName">
 254             <property
 255                 name="format"
 256                 value="^Abstract.*$|^.*Factory$|^.*Builder$|^.*Adapter$"
 257             />
 258         </module>
 259         <module name="ClassTypeParameterName" />
 260         <module name="ConstantName" />
 261         <module name="LocalFinalVariableName">
 262             <property name="format" value="^[a-z][_a-zA-Z0-9]*$" />
 263         </module>
 264         <module name="LocalVariableName">
 265             <property name="format" value="^[a-z][_a-zA-Z0-9]*$" />
 266         </module>
 267         <module name="MemberName">
 268             <property name="format" value="^[a-z][_a-zA-Z0-9]*$" />
 269         </module>
 270         <module name="MethodName" />
 271         <module name="MethodTypeParameterName" />
 272         <module name="PackageName" />
 273         <module name="ParameterName">
 274             <property name="format" value="^[a-z][_a-zA-Z0-9]*$" />
 275         </module>
 276         <module name="StaticVariableName">
 277             <property name="format" value="^[a-z][_a-zA-Z0-9]*$" />
 278         </module>
 279         <module name="TypeName" />
 280
 281
 282     <!-- Size Violations -->
 283
 284         <module name="ExecutableStatementCount" />
 285         <module name="LineLength">
 286             <property name="max" value="78" />
 287         </module>
 288         <module name="MethodLength" />
 289         <module name="AnonInnerLength" />
 290         <module name="ParameterNumber" />
 291         <module name="OuterTypeNumber" />
 292         <module name="MethodCount" />
 293
 294
 295     <!-- Whitespace -->
 296
 297         <module name="GenericWhitespace" />
 298         <module name="EmptyForInitializerPad" />
 299         <module name="EmptyForIteratorPad" />
 300         <module name="MethodParamPad">
 301             <property
 302                 name="tokens"
 303                 value="CTOR_DEF, LITERAL_NEW, METHOD_DEF, SUPER_CTOR_CALL"
 304             />
 305         </module>
 306         <module name="NoWhitespaceAfter">
 307             <property name="allowLineBreaks" value="false" />
 308             <property name="tokens" value="DEC, DOT, INC" />
 309         </module>
 310         <module name="NoWhitespaceBefore">
 311             <property name="allowLineBreaks" value="false" />
 312             <property name="tokens" value="POST_DEC, POST_INC" />
 313         </module>
 314         <module name="NoWhitespaceBefore">
 315             <property name="allowLineBreaks" value="true" />
 316             <property name="tokens" value="SEMI" />
 317         </module>
 318         <module name="OperatorWrap">
 319             <property name="option" value="eol" />
 320             <property
 321                 name="tokens"
 322                 value="ASSIGN,
 323                        BAND_ASSIGN, BOR_ASSIGN, BXOR_ASSIGN,
 324                        PLUS_ASSIGN, MINUS_ASSIGN,
 325                        STAR_ASSIGN, DIV_ASSIGN, MOD_ASSIGN,
 326                        SL_ASSIGN, SR_ASSIGN"
 327             />
 328         </module>
 329         <module name="OperatorWrap">
 330             <property name="option" value="nl" />
 331             <property
 332                 name="tokens"
 333                 value="BAND, BOR, BXOR,
 334                        MINUS, STAR, DIV, MOD,
 335                        LAND, LOR,
 336                        EQUAL"
 337             />
 338         </module>
 339         <module name="ParenPad">
 340             <property name="option" value="nospace" />
 341             <property
 342                 name="tokens"
 343                 value="CTOR_CALL, METHOD_CALL, SUPER_CTOR_CALL"
 344             />
 345         </module>
 346         <module name="TypecastParenPad" />
 347         <module name="WhitespaceAfter">
 348             <property name="tokens" value="COMMA, SEMI" />
 349         </module>
 350         <module name="WhitespaceAround">
 351             <property
 352                 name="tokens"
 353                 value="ASSIGN,
 354                        LAND, LOR,
 355                        BAND, BOR, BXOR, BSR,
 356                        BAND_ASSIGN, BOR_ASSIGN, BXOR_ASSIGN, BSR_ASSIGN,
 357                        SL, SR,
 358                        SL_ASSIGN, SR_ASSIGN,
 359                        MINUS, STAR, DIV, MOD,
 360                        PLUS_ASSIGN, MINUS_ASSIGN,
 361                        STAR_ASSIGN, DIV_ASSIGN, MOD_ASSIGN,
 362                        EQUAL, NOT_EQUAL, GT, GE, LT, LE,
 363                        "
 364             />
 365         </module>
 366
 367
 368 <!-- 代用品で解決
 369         <module name="Header" />
 370         <module name="RegexpSingleline" />
 371         <module name="RegexpMultiline" />
 372         <module name="RegexpSinglelineJava" />
 373 -->
 374
 375 <!-- Obsolated
 376         <module name="TabCharacter" />
 377 -->
 378
 379     </module>
 380
 381 </module>
 382
 383 <!-- EOF -->