config/checkstyle/checkstyle.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2
   3 <!DOCTYPE module PUBLIC
   4     "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
   5     "https://checkstyle.org/dtds/configuration_1_3.dtd">
   6
   7 <!--
   8     Checkstyle modules
   9     for Checkstyle 8.21 or later
  10
  11     [ https://checkstyle.org/ ]
  12
  13     Copyright(c) 2019 olyutorskii
  14 -->
  15
  16
  17 <module name="Checker">
  18
  19     <property name="charset" value="UTF-8" />
  20     <property name="localeCountry" value="JP" />
  21     <property name="localeLanguage" value="en" />
  22     <!--property name="localeLanguage" value="ja" /-->
  23     <property name="fileExtensions" value="java, properties, xml, xsd, md, txt" />
  24     <property name="severity" value="error" />
  25
  26
  27     <!-- Filters -->
  28
  29     <module name="SeverityMatchFilter" />
  30     <!--module name="SuppressionFilter" /-->
  31     <module name="SuppressWarningsFilter" />
  32     <module name="SuppressWithPlainTextCommentFilter" />
  33
  34
  35     <!-- Headers -->
  36
  37     <module name="Header">
  38         <property name="header" value="&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot; ?&gt;" />
  39         <property name="fileExtensions" value="xml" />
  40     </module>
  41     <module name="RegexpHeader">
  42         <!-- /* ... */ -->
  43         <property name="header" value="^/\*$\n^ \*( .*)?$\n^ \*/$\n" />
  44         <property name="multiLines" value="2" />
  45         <property name="fileExtensions" value="java" />
  46     </module>
  47
  48
  49     <!-- Javadoc Comments -->
  50
  51     <module name="JavadocPackage" />
  52
  53
  54     <!-- Miscellaneous -->
  55
  56     <module name="NewlineAtEndOfFile">
  57         <property name="fileExtensions" value="java, properties, xml, xsd, md, txt" />
  58     </module>
  59     <module name="Translation" />
  60     <module name="UniqueProperties" />
  61
  62
  63     <!-- Regexp -->
  64
  65     <module name="RegexpMultiline">
  66         <property name="format" value="[\u000b\f\u001a]" />
  67     </module>
  68     <module name="RegexpOnFilename" />
  69     <module name="RegexpSingleline">
  70         <property name="format" value="\s+$" />
  71     </module>
  72     <module name="RegexpSingleline">
  73         <!-- scm conflict -->
  74         <property name="format" value="&lt;&lt;&lt;&lt;&lt;" />
  75     </module>
  76
  77
  78     <!-- Size Violations -->
  79
  80     <module name="FileLength" />
  81
  82
  83     <!-- Whitespace -->
  84
  85     <module name="FileTabCharacter" />
  86
  87
  88     <module name="BeforeExecutionExclusionFileFilter">
  89         <property name="fileNamePattern" value="module\-info\.java$" />
  90     </module>
  91
  92
  93     <module name="TreeWalker">
  94
  95         <property name="tabWidth" value="8" />
  96         <property name="fileExtensions" value="java" />
  97
  98         <module name="SuppressWarningsHolder" />
  99
 100
 101     <!-- Filters -->
 102
 103         <module name="SuppressionCommentFilter" />
 104         <module name="SuppressWithNearbyCommentFilter" />
 105         <!--module name="SuppressionXpathFilter" /-->
 106         <!--module name="SuppressionXpathSingleFilter" /-->
 107
 108
 109     <!-- Annotations -->
 110
 111         <module name="AnnotationLocation" />
 112         <module name="AnnotationOnSameLine" />
 113         <module name="AnnotationUseStyle" />
 114         <module name="MissingDeprecated" />
 115         <module name="MissingOverride" />
 116         <module name="PackageAnnotation" />
 117         <module name="SuppressWarnings" />
 118         <module name="SuppressWarningsHolder" />
 119
 120
 121     <!-- Block Checks -->
 122
 123         <module name="AvoidNestedBlocks" />
 124         <module name="EmptyBlock" />
 125         <module name="EmptyCatchBlock" />
 126         <module name="LeftCurly" />
 127         <module name="NeedBraces">
 128             <property name="allowSingleLineStatement" value="true" />
 129         </module>
 130         <module name="RightCurly" />
 131
 132
 133     <!-- Class Design -->
 134
 135         <module name="DesignForExtension" />
 136         <module name="FinalClass" />
 137         <module name="HideUtilityClassConstructor" />
 138         <module name="InnerTypeLast" />
 139         <module name="InterfaceIsType" />
 140         <module name="MutableException" />
 141         <module name="OneTopLevelClass" />
 142         <module name="ThrowsCount" />
 143         <module name="VisibilityModifier" />
 144
 145
 146     <!-- Coding -->
 147
 148         <module name="ArrayTrailingComma" />
 149         <module name="AvoidInlineConditionals" />
 150         <module name="CovariantEquals" />
 151         <module name="DeclarationOrder" />
 152         <module name="DefaultComesLast" />
 153         <module name="EmptyStatement" />
 154         <module name="EqualsAvoidNull" />
 155         <module name="EqualsHashCode" />
 156         <module name="ExplicitInitialization" />
 157         <module name="FallThrough" />
 158         <module name="FinalLocalVariable" />
 159         <module name="HiddenField">
 160             <property name="ignoreConstructorParameter" value="true" />
 161             <property name="ignoreSetter" value="true" />
 162             <property name="setterCanReturnItsClass" value="true" />
 163             <property name="ignoreAbstractMethods" value="true" />
 164         </module>
 165         <module name="IllegalCatch" />
 166         <module name="IllegalInstantiation" />
 167         <module name="IllegalThrows" />
 168         <module name="IllegalToken">
 169             <property name="tokens" value="LITERAL_NATIVE" />
 170         </module>
 171         <module name="IllegalTokenText" />
 172         <module name="IllegalType" />
 173         <module name="InnerAssignment" />
 174         <module name="MagicNumber" />
 175         <module name="MissingCtor" />
 176         <module name="MissingSwitchDefault" />
 177         <module name="ModifiedControlVariable" />
 178         <module name="MultipleStringLiterals" />
 179         <module name="MultipleVariableDeclarations" />
 180         <module name="NestedForDepth" />
 181         <module name="NestedIfDepth" />
 182         <module name="NestedTryDepth" />
 183         <module name="NoClone" />
 184         <module name="NoFinalizer" />
 185         <module name="OneStatementPerLine" />
 186         <module name="OverloadMethodsDeclarationOrder" />
 187         <module name="PackageDeclaration" />
 188         <module name="ParameterAssignment" />
 189         <module name="RequireThis">
 190             <property name="checkMethods" value="false" />
 191         </module>
 192         <module name="ReturnCount">
 193             <property name="max" value="5" />
 194             <property name="maxForVoid" value="5" />
 195         </module>
 196         <module name="SimplifyBooleanExpression" />
 197         <module name="SimplifyBooleanReturn" />
 198         <module name="StringLiteralEquality" />
 199         <module name="SuperClone" />
 200         <module name="SuperFinalize" />
 201         <module name="UnnecessaryParentheses" />
 202         <module name="VariableDeclarationUsageDistance">
 203             <property name="allowedDistance" value="5"/>
 204         </module>
 205
 206
 207     <!-- Imports -->
 208
 209         <module name="AvoidStarImport" />
 210         <module name="AvoidStaticImport" />
 211         <module name="CustomImportOrder" />
 212         <module name="IllegalImport" />
 213         <!--module name="ImportControl" /-->
 214         <module name="ImportOrder" />
 215         <module name="RedundantImport" />
 216         <module name="UnusedImports" />
 217
 218
 219     <!-- Javadoc Comments -->
 220
 221         <module name="AtclauseOrder" />
 222         <module name="JavadocMethod" />
 223         <module name="JavadocParagraph" />
 224         <module name="JavadocStyle">
 225             <property
 226                 name="endOfSentenceFormat"
 227                 value="([。.?!][ \t\n\r\f&lt;])|([。.?!]$)" />
 228             <property name="checkEmptyJavadoc" value="true" />
 229             <property name="checkHtml" value="true" />
 230         </module>
 231         <module name="JavadocTagContinuationIndentation" />
 232         <module name="JavadocType" />
 233         <module name="JavadocVariable">
 234             <property name="scope" value="protected" />
 235         </module>
 236         <module name="MissingJavadocMethod" />
 237         <module name="MissingJavadocType" />
 238         <module name="NonEmptyAtclauseDescription" />
 239         <module name="SingleLineJavadoc" />
 240         <module name="SummaryJavadocCheck" />
 241         <module name="WriteTag" />
 242
 243
 244     <!-- Metrics -->
 245
 246         <module name="BooleanExpressionComplexity" />
 247         <module name="ClassDataAbstractionCoupling" />
 248         <module name="ClassFanOutComplexity" />
 249         <module name="CyclomaticComplexity" />
 250         <module name="JavaNCSS" />
 251         <module name="NPathComplexity" />
 252
 253
 254     <!-- Miscellaneous -->
 255
 256         <module name="ArrayTypeStyle" />
 257         <module name="AvoidEscapedUnicodeCharacters">
 258             <property name="allowEscapesForControlCharacters" value="true" />
 259             <property name="allowByTailComment" value="true" />
 260             <property name="allowIfAllCharactersEscaped" value="true" />
 261             <property name="allowNonPrintableEscapes" value="true" />
 262         </module>
 263         <module name="CommentsIndentation" />
 264         <module name="DescendantToken" />
 265         <module name="FinalParameters" />
 266         <module name="Indentation">
 267             <property name="caseIndent" value="0" />
 268         </module>
 269         <module name="OuterTypeFilename" />
 270         <module name="TodoComment">
 271             <property name="format" value="TODO" />
 272         </module>
 273         <module name="TrailingComment" />
 274         <module name="UncommentedMain" />
 275         <module name="UpperEll" />
 276
 277
 278     <!-- Modifiers -->
 279
 280         <module name="ClassMemberImpliedModifier" />
 281         <module name="InterfaceMemberImpliedModifier" />
 282         <module name="ModifierOrder" />
 283         <module name="RedundantModifier" />
 284
 285
 286     <!-- Naming Conventions -->
 287
 288         <module name="AbbreviationAsWordInName" />
 289         <module name="AbstractClassName" />
 290         <module name="CatchParameterName" />
 291         <module name="ClassTypeParameterName" />
 292         <module name="ConstantName" />
 293         <module name="InterfaceTypeParameterName" />
 294         <module name="LambdaParameterName" />
 295         <module name="LocalFinalVariableName" />
 296         <module name="LocalVariableName" />
 297         <module name="MemberName" />
 298         <module name="MethodName" />
 299         <module name="MethodTypeParameterName" />
 300         <module name="PackageName" />
 301         <module name="ParameterName" />
 302         <module name="StaticVariableName" />
 303         <module name="TypeName" />
 304
 305
 306     <!-- Regex -->
 307
 308         <module name="Regexp">
 309             <property name="format" value="@author" />
 310             <property name="illegalPattern" value="true" />
 311         </module>
 312         <module name="Regexp">
 313             <property name="format" value="^ \* Copyright\(c\)" />
 314         </module>
 315         <module name="Regexp">
 316             <property name="format" value="^ \* License : The MIT License" />
 317             <property name="duplicateLimit" value="1" />
 318         </module>
 319         <module name="RegexpSinglelineJava">
 320             <property name="format" value="\u0000" />
 321         </module>
 322
 323
 324     <!-- Size Violations -->
 325
 326         <module name="AnonInnerLength" />
 327         <module name="ExecutableStatementCount" />
 328         <module name="LineLength">
 329             <property name="max" value="78" />
 330         </module>
 331         <module name="MethodCount" />
 332         <module name="MethodLength" />
 333         <module name="OuterTypeNumber" />
 334         <module name="ParameterNumber" />
 335
 336
 337     <!-- Whitespace -->
 338
 339         <module name="EmptyForInitializerPad" />
 340         <module name="EmptyForIteratorPad" />
 341         <module name="EmptyLineSeparator">
 342             <property
 343                 name="tokens"
 344                 value="PACKAGE_DEF,
 345                        IMPORT,
 346                        CLASS_DEF,
 347                        INTERFACE_DEF,
 348                        ENUM_DEF,
 349                        STATIC_INIT,
 350                        INSTANCE_INIT,
 351                        METHOD_DEF,
 352                        CTOR_DEF,
 353                        "
 354             />
 355         </module>
 356         <module name="GenericWhitespace" />
 357         <module name="MethodParamPad" />
 358         <module name="NoLineWrap" />
 359         <module name="NoWhitespaceAfter">
 360             <property
 361                 name="tokens"
 362                 value="AT, INC, DEC, UNARY_MINUS, UNARY_PLUS, DOT"
 363             />
 364         </module>
 365         <module name="NoWhitespaceBefore">
 366             <property name="allowLineBreaks" value="true" />
 367         </module>
 368         <module name="OperatorWrap" />
 369         <module name="ParenPad" />
 370         <module name="SeparatorWrap">
 371             <property name="tokens" value="DOT"/>
 372             <property name="option" value="nl"/>
 373         </module>
 374         <module name="SingleSpaceSeparator" />
 375         <module name="TypecastParenPad" />
 376         <module name="WhitespaceAfter" >
 377             <property name="tokens" value="COMMA, SEMI," />
 378         </module>
 379         <module name="WhitespaceAround">
 380             <property
 381                 name="tokens"
 382                 value="ASSIGN,
 383                        LAND, LOR,
 384                        BAND, BOR, BXOR, BSR,
 385                        BAND_ASSIGN, BOR_ASSIGN, BXOR_ASSIGN, BSR_ASSIGN,
 386                        SL, SR,
 387                        SL_ASSIGN, SR_ASSIGN,
 388                        MINUS, STAR, DIV, MOD,
 389                        PLUS_ASSIGN, MINUS_ASSIGN,
 390                        STAR_ASSIGN, DIV_ASSIGN, MOD_ASSIGN,
 391                        EQUAL, NOT_EQUAL, GT, GE, LT, LE,
 392                        "
 393             />
 394         </module>
 395
 396
 397     </module>
 398
 399
 400 </module>
 401
 402 <!-- EOF -->