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.31 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         </module>
 201         <module name="ReturnCount">
 202             <property name="max" value="5" />
 203             <property name="maxForVoid" value="5" />
 204         </module>
 205         <module name="SimplifyBooleanExpression" />
 206         <module name="SimplifyBooleanReturn" />
 207         <module name="StringLiteralEquality" />
 208         <module name="SuperClone" />
 209         <module name="SuperFinalize" />
 210         <module name="UnnecessaryParentheses" />
 211         <module name="UnnecessarySemicolonAfterOuterTypeDeclaration" />
 212         <module name="UnnecessarySemicolonAfterTypeMemberDeclaration" />
 213         <module name="UnnecessarySemicolonInEnumeration" />
 214         <module name="UnnecessarySemicolonInTryWithResources" />
 215         <module name="VariableDeclarationUsageDistance" />
 216
 217
 218     <!-- Imports -->
 219
 220         <module name="AvoidStarImport" />
 221         <module name="AvoidStaticImport" />
 222         <module name="CustomImportOrder" />
 223         <module name="IllegalImport" />
 224         <!--module name="ImportControl" /-->
 225         <module name="ImportOrder" />
 226         <module name="RedundantImport" />
 227         <module name="UnusedImports" />
 228
 229
 230     <!-- Javadoc Comments -->
 231
 232         <module name="AtclauseOrder" />
 233         <module name="InvalidJavadocPosition" />
 234         <module name="JavadocBlockTagLocation" />
 235         <module name="JavadocContentLocationCheck" />
 236         <module name="JavadocMethod" />
 237         <module name="JavadocParagraph" />
 238         <module name="JavadocStyle">
 239             <property
 240                 name="endOfSentenceFormat"
 241                 value="([。.?!][ \t\n\r\f&lt;])|([。.?!]$)" />
 242             <property name="checkEmptyJavadoc" value="true" />
 243             <property name="checkHtml" value="true" />
 244         </module>
 245         <module name="JavadocTagContinuationIndentation" />
 246         <module name="JavadocType" />
 247         <module name="JavadocVariable">
 248             <property name="scope" value="protected" />
 249         </module>
 250         <module name="MissingJavadocMethod" />
 251         <module name="MissingJavadocPackage" />
 252         <module name="MissingJavadocType" />
 253         <module name="NonEmptyAtclauseDescription" />
 254         <module name="SingleLineJavadoc" />
 255         <module name="SummaryJavadocCheck" />
 256         <module name="WriteTag" />
 257
 258
 259     <!-- Metrics -->
 260
 261         <module name="BooleanExpressionComplexity" />
 262         <module name="ClassDataAbstractionCoupling" />
 263         <module name="ClassFanOutComplexity" />
 264         <module name="CyclomaticComplexity" />
 265         <module name="JavaNCSS" />
 266         <module name="NPathComplexity" />
 267
 268
 269     <!-- Miscellaneous -->
 270
 271         <module name="ArrayTypeStyle" />
 272         <module name="AvoidEscapedUnicodeCharacters">
 273             <property name="allowEscapesForControlCharacters" value="true" />
 274             <property name="allowByTailComment" value="true" />
 275             <property name="allowIfAllCharactersEscaped" value="true" />
 276             <property name="allowNonPrintableEscapes" value="true" />
 277         </module>
 278         <module name="CommentsIndentation" />
 279         <module name="DescendantToken" />
 280         <module name="FinalParameters" />
 281         <module name="Indentation">
 282             <property name="caseIndent" value="0" />
 283         </module>
 284         <module name="OuterTypeFilename" />
 285         <module name="TodoComment">
 286             <property name="format" value="TODO" />
 287         </module>
 288         <module name="TrailingComment" />
 289         <module name="UncommentedMain" />
 290         <module name="UpperEll" />
 291
 292
 293     <!-- Modifiers -->
 294
 295         <module name="ClassMemberImpliedModifier" />
 296         <module name="InterfaceMemberImpliedModifier" />
 297         <module name="ModifierOrder" />
 298         <module name="RedundantModifier" />
 299
 300
 301     <!-- Naming Conventions -->
 302
 303         <module name="AbbreviationAsWordInName" />
 304         <module name="AbstractClassName" />
 305         <module name="CatchParameterName" />
 306         <module name="ClassTypeParameterName" />
 307         <module name="ConstantName" />
 308         <module name="InterfaceTypeParameterName" />
 309         <module name="LambdaParameterName" />
 310         <module name="LocalFinalVariableName" />
 311         <module name="LocalVariableName" />
 312         <module name="MemberName" />
 313         <module name="MethodName" />
 314         <module name="MethodTypeParameterName" />
 315         <module name="PackageName" />
 316         <module name="ParameterName" />
 317         <module name="StaticVariableName" />
 318         <module name="TypeName" />
 319
 320
 321     <!-- Regex -->
 322
 323         <module name="Regexp">
 324             <property name="format" value="@author" />
 325             <property name="illegalPattern" value="true" />
 326         </module>
 327         <module name="Regexp">
 328             <property name="format" value="^ \* Copyright\(c\)" />
 329         </module>
 330         <module name="Regexp">
 331             <property name="format" value="^ \* License : The MIT License" />
 332             <property name="duplicateLimit" value="1" />
 333         </module>
 334         <module name="RegexpSinglelineJava">
 335             <property name="format" value="\u0000" />
 336         </module>
 337
 338
 339     <!-- Size Violations -->
 340
 341         <module name="AnonInnerLength" />
 342         <module name="ExecutableStatementCount" />
 343         <module name="MethodCount" />
 344         <module name="MethodLength" />
 345         <module name="OuterTypeNumber" />
 346         <module name="ParameterNumber" />
 347
 348
 349     <!-- Whitespace -->
 350
 351         <module name="EmptyForInitializerPad" />
 352         <module name="EmptyForIteratorPad" />
 353         <module name="EmptyLineSeparator">
 354             <property
 355                 name="tokens"
 356                 value="PACKAGE_DEF,
 357                        IMPORT,
 358                        CLASS_DEF,
 359                        INTERFACE_DEF,
 360                        ENUM_DEF,
 361                        STATIC_INIT,
 362                        INSTANCE_INIT,
 363                        METHOD_DEF,
 364                        CTOR_DEF,
 365                        "
 366             />
 367         </module>
 368         <module name="GenericWhitespace" />
 369         <module name="MethodParamPad">
 370             <property
 371                 name="tokens"
 372                 value="CTOR_DEF, LITERAL_NEW, METHOD_DEF, SUPER_CTOR_CALL"
 373             />
 374         </module>
 375         <module name="NoLineWrap" />
 376         <module name="NoWhitespaceAfter">
 377             <property name="allowLineBreaks" value="false" />
 378             <property name="tokens" value="INC, DEC, DOT" />
 379         </module>
 380         <module name="NoWhitespaceBefore">
 381             <property name="allowLineBreaks" value="false" />
 382             <property name="tokens" value="COMMA, POST_INC, POST_DEC" />
 383         </module>
 384         <module name="OperatorWrap" />
 385         <module name="ParenPad">
 386             <property name="option" value="nospace" />
 387             <property
 388                 name="tokens"
 389                 value="CTOR_CALL, METHOD_CALL, SUPER_CTOR_CALL"
 390             />
 391         </module>
 392         <module name="SeparatorWrap">
 393             <property name="tokens" value="DOT" />
 394             <property name="option" value="nl" />
 395         </module>
 396         <module name="SingleSpaceSeparator" />
 397         <module name="TypecastParenPad" />
 398         <module name="WhitespaceAfter" >
 399             <property name="tokens" value="COMMA, SEMI," />
 400         </module>
 401         <module name="WhitespaceAround">
 402             <property
 403                 name="tokens"
 404                 value="ASSIGN,
 405                        LAND, LOR,
 406                        BAND, BOR, BXOR, BSR,
 407                        BAND_ASSIGN, BOR_ASSIGN, BXOR_ASSIGN, BSR_ASSIGN,
 408                        SL, SR,
 409                        SL_ASSIGN, SR_ASSIGN,
 410                        MINUS, STAR, DIV, MOD,
 411                        PLUS_ASSIGN, MINUS_ASSIGN,
 412                        STAR_ASSIGN, DIV_ASSIGN, MOD_ASSIGN,
 413                        EQUAL, NOT_EQUAL, GT, GE, LT, LE,
 414                        "
 415             />
 416         </module>
 417
 418
 419     </module>
 420
 421
 422 </module>
 423
 424 <!-- EOF -->