oamo.checkstyle-config.4.0.source-code.checkstyle-library.xml Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of checkstyle-config Show documentation
A set of checkstyle configurations
The newest version!
<?xml version="1.0" encoding="windows-1252"?>
<!DOCTYPE module PUBLIC
          "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
          "https://checkstyle.org/dtds/configuration_1_3.dtd">
<!--
The MIT License

Copyright 2022 James Amoore.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-->

<module name="Checker">
   <property name="tabWidth" value="3"/>
   <module name="SuppressWarningsFilter"/>
   <module name="TreeWalker">
      
      <module name="SuppressWarningsHolder"/>

      <module name="SuppressWarnings">
        <property name="id" value="checkstyle:suppresswarnings"/>
      </module>
      <!-- 
         Block Checks: 
         https://checkstyle.sourceforge.io/config_blocks.html
      -->
      <module name="LeftCurly">
         <property name="option" value="nl"/>
      </module>
      <module name="NeedBraces"/>
      <module name="RightCurly">
         <property name="option" value="alone"/>
      </module>
      <module name="EmptyCatchBlock"/>                        
      <!-- 
         Class Design Checks: 
         https://checkstyle.sourceforge.io/config_design.html
      -->
      <module name="DesignForExtension"/>
      <module name="FinalClass"/>
      <module name="HideUtilityClassConstructor"/>
      <module name="InterfaceIsType"/>
      <module name="MutableException"/>
      <module name="OneTopLevelClass"/>
      <module name="ThrowsCount">
         <property name="max" value="3"/>
      </module>
      <module name="VisibilityModifier"/>
      <!-- 
         Coding Checks: 
         https://checkstyle.sourceforge.io/config_coding.html
      -->
      <module name="ArrayTrailingComma"/>
      <module name="CovariantEquals"/>
      <module name="DeclarationOrder"/>
      <module name="DefaultComesLast"/>
      <module name="EmptyStatement"/>
      <module name="EqualsAvoidNull"/>
      <module name="EqualsHashCode"/>
      <module name="FallThrough"/>
      <module name="IllegalCatch"/>
      <module name="IllegalInstantiation"/>
      <module name="IllegalToken"/>
      <module name="MagicNumber"/>
      <module name="MissingSwitchDefault"/>
      <module name="ModifiedControlVariable"/>
      <module name="MultipleStringLiterals"/>
      <module name="MultipleVariableDeclarations"/>
      <module name="NestedForDepth"/>
      <module name="NestedIfDepth"/>
      <module name="NestedTryDepth"/>
      <module name="OneStatementPerLine"/>
      <module name="OverloadMethodsDeclarationOrder"/>
      <module name="PackageDeclaration"/>
      <module name="RequireThis">
         <property name="checkMethods" value="false"/>
         <property name="validateOnlyOverlapping" value="true"/>
      </module>
      <module name="SimplifyBooleanExpression"/>
      <module name="SimplifyBooleanReturn"/>
      <module name="StringLiteralEquality"/>
      <module name="UnnecessaryParentheses"/>
                       
      <module name="UnnecessarySemicolonAfterTypeMemberDeclaration"/>
      <module name="UnnecessarySemicolonInEnumeration"/>
      <module name="UnnecessarySemicolonInTryWithResources"/>
      <module name="VariableDeclarationUsageDistance"/>
      <!-- 
         Import Checks: 
         https://checkstyle.sourceforge.io/config_imports.html 
      -->
      <module name="IllegalImport"/>
      <module name="AvoidStarImport"/>
      <module name="RedundantImport"/>
      <module name="UnusedImports"/>
      <!-- 
         Javadoc Checks: 
         https://checkstyle.sourceforge.io/config_javadoc.html 
      -->
      <module name="AtclauseOrder"/>
      <module name="InvalidJavadocPosition"/>
      <module name="JavadocBlockTagLocation"/>
      <module name="JavadocMethod"/>
      <module name="JavadocParagraph"/>
      <module name="JavadocStyle"/>
      <module name="JavadocType"/>
      <module name="MissingJavadocMethod"/>
      <module name="MissingJavadocType"/>
      <module name="NonEmptyAtclauseDescription"/>
      <!-- 
         Metrics Checks: 
         https://checkstyle.sourceforge.io/config_metrics.html
      -->
      <module name="BooleanExpressionComplexity"/>
      <module name="ClassDataAbstractionCoupling">
         <property name="max" value="15"/>
      </module>
                        
      <module name="ClassFanOutComplexity">
         <property name="max" value="30"/>
      </module>
      <module name="CyclomaticComplexity"/>
      <module name="JavaNCSS"/>
      <module name="NPathComplexity"/>
      <!-- 
         Miscellaneous Checks: 
         https://checkstyle.sourceforge.io/config_misc.html
      -->
      <module name="CommentsIndentation"/>
      <module name="OuterTypeFilename"/>
      <module name="TodoComment"/>
      <module name="UpperEll"/>
      <!-- 
         Modifiers Checks: 
         https://checkstyle.sourceforge.io/config_modifier.html
      -->
      <module name="ClassMemberImpliedModifier">
         <property name="violateImpliedStaticOnNestedEnum" value="false"/>
      </module>
      <module name="RedundantModifier"/>
      <!-- 
         Name Convention Checks: 
         https://checkstyle.sourceforge.io/config_modifier.html
      -->
      <module name="ClassTypeParameterName"/>
      <module name="ConstantName"/>
      <module name="InterfaceTypeParameterName"/>
      <module name="LambdaParameterName"/>
      <module name="LocalFinalVariableName"/>
      <module name="LocalVariableName"/>
      <module name="MemberName"/>
      <module name="MethodName"/>
      <module name="MethodTypeParameterName"/>
      <module name="PackageName"/>
      <module name="ParameterName"/>
      <module name="StaticVariableName"/>
      <!-- 
         Size Violations Checks: 
         https://checkstyle.sourceforge.io/config_sizes.html
      -->
      <module name="AnonInnerLength"/>
      <module name="MethodLength">
         <property name="max" value="30"/>
      </module>
      <module name="OuterTypeNumber"/>
      <!-- 
         Whitespace Checks: 
         https://checkstyle.sourceforge.io/config_whitespace.html
      -->
      <module name="EmptyForInitializerPad"/>
      <module name="EmptyForIteratorPad"/>
      <module name="MethodParamPad"/>
      <module name="GenericWhitespace"/>
      <module name="NoWhitespaceAfter"/>
      <module name="NoWhitespaceBefore"/>
      <module name="ParenPad"/>
      <module name="SingleSpaceSeparator"/>
      <module name="TypecastParenPad"/>
   </module>
   <module name="NewlineAtEndOfFile"/>
   <module name="FileLength"/>
   <module name="LineLength">
      <property name="max" value="120"/>
   </module>
</module>