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