com.io7m.changelog.checkstyle.checkstyle.xml Maven / Gradle / Ivy

Go to download
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE module PUBLIC
  "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
  "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">

<module name="Checker">
  <property name="severity" value="error"/>
  <module name="TreeWalker">
    <!--
    <module name="AbstractClassName"/>
    <module name="AnnotationUseStyle"/>
    -->

    <!-- Require that anonymous inner classes are less than 100 lines. -->
    <module name="AnonInnerLength">
      <property name="max" value="100"/>
    </module>

    <module name="ArrayTrailingComma"/>
    <module name="ArrayTypeStyle"/>
    <!--
    <module name="AvoidInlineConditionals"/>
    <module name="AvoidNestedBlocks"/>
    -->
    <module name="AvoidStarImport"/>
    <module name="AvoidStaticImport"/>
    <module name="BooleanExpressionComplexity"/>
    <module name="ClassDataAbstractionCoupling">
      <property name="max" value="20"/>
    </module>
    <module name="ClassFanOutComplexity">
      <property name="max" value="85"/>
    </module>
    <module name="ClassTypeParameterName"/>
    <module name="ConstantName"/>
    <module name="CovariantEquals"/>
    <module name="CyclomaticComplexity">
      <property name="max" value="20"/>
    </module>
    <!--
    <module name="DeclarationOrder"/>
    -->
    <module name="DefaultComesLast"/>
    <module name="DescendantToken"/>
    <module name="DesignForExtension"/>

    <!-- Require that empty blocks contain either a statement or -->
    <!-- an explanatory comment. -->
    <module name="EmptyBlock">
      <property name="option" value="text"/>
    </module>

    <module name="EmptyForInitializerPad"/>
    <module name="EmptyForIteratorPad"/>
    <module name="EmptyStatement"/>
    <module name="EqualsAvoidNull"/>
    <module name="EqualsHashCode"/>
    <module name="ExecutableStatementCount">
      <property name="max" value="60"/>
    </module>
    <module name="ExplicitInitialization"/>
    <module name="FallThrough"/>
    <module name="FinalClass"/>
    <module name="FinalLocalVariable"/>
    <module name="FinalParameters"/>
    <module name="GenericWhitespace"/>
    <module name="HiddenField"/>
    <module name="HideUtilityClassConstructor"/>
    <!-- <module name="IllegalCatch"/> -->
    <module name="IllegalImport"/>
    <module name="IllegalInstantiation"/>
    <module name="IllegalThrows"/>
    <module name="IllegalToken">
      <property name="tokens" value="POST_INC,POST_DEC"/>
    </module>
    <module name="IllegalTokenText"/>
    <module name="IllegalType"/>
    <!-- <module name="ImportControl"/> -->
    <!-- <module name="ImportOrder"/> -->
    <!-- <module name="Indentation"/> -->
    <module name="InnerAssignment"/>
    <!-- <module name="InnerTypeLast"/> -->
    <module name="InterfaceIsType"/>
    <module name="JUnitTestCase"/>
    <module name="JavaNCSS">
      <property name="methodMaximum" value="60"/>
    </module>
    <module name="JavadocMethod">
      <property name="scope" value="public"/>
    </module>
    <module name="JavadocType">
      <property name="scope" value="public"/>
    </module>
    <module name="JavadocVariable">
      <property name="scope" value="public"/>
    </module>
    <!-- <module name="LeftCurly"/> -->
    <module name="LineLength">
      <property name="max" value="180"/>
    </module>
    <module name="LocalFinalVariableName">
      <property name="format" value="^([a-z][a-z0-9_]*|_)$"/>
    </module>
    <module name="LocalVariableName">
      <property name="format" value="^([a-z][a-z0-9_]*|_)$"/>
    </module>
    <!-- <module name="MagicNumber"/> -->
    <module name="MemberName">
      <property name="format" value="^[a-z][a-z0-9_]*$"/>
    </module>
    <module name="MethodCount">
      <property name="maxTotal" value="150"/>
      <property name="maxPackage" value="150"/>
    </module>
    <module name="MethodName">
      <property name="format" value="^[a-z][A-Za-z0-9]*$"/>
    </module>
    <module name="MethodParamPad"/>
    <module name="MethodTypeParameterName">
      <property name="format" value="^[A-Z][A-Z0-9]*$"/>
    </module>
    <module name="MissingCtor"/>
    <module name="MissingDeprecated"/>
    <module name="MissingOverride"/>
    <!-- <module name="MissingSwitchDefault"/> -->
    <module name="ModifiedControlVariable"/>
    <!-- <module name="ModifierOrder"/> -->
    <!-- <module name="MultipleStringLiterals"/> -->
    <module name="MultipleVariableDeclarations"/>
    <module name="MutableException"/>
    <module name="NPathComplexity">
      <property name="max" value="130"/>
    </module>
    <module name="NeedBraces"/>
    <module name="NestedForDepth">
      <property name="max" value="2"/>
    </module>
    <module name="NestedIfDepth">
      <property name="max" value="2"/>
    </module>
    <module name="NestedTryDepth">
      <property name="max" value="2"/>
    </module>
    <module name="NoClone"/>
    <module name="NoFinalizer"/>
    <module name="NoWhitespaceAfter"/>
    <module name="NoWhitespaceBefore"/>
    <module name="OneStatementPerLine"/>
    <module name="OperatorWrap"/>
    <module name="OuterTypeFilename"/>
    <module name="OuterTypeNumber"/>
    <module name="PackageAnnotation"/>
    <module name="PackageDeclaration"/>
    <module name="PackageName"/>
    <module name="ParameterAssignment"/>
    <module name="ParameterName">
      <property name="format" value="^([a-z][a-z0-9_]*|_)$"/>
    </module>
    <module name="ParameterNumber">
      <property name="max" value="12"/>
    </module>
    <module name="ParenPad"/>
    <module name="RedundantImport"/>
    <module name="RedundantModifier"/>
    <!-- <module name="RedundantThrows"/> -->
    <module name="RequireThis"/>
    <!-- <module name="SimplifyBooleanExpression"/> -->
    <module name="SimplifyBooleanReturn"/>
    <module name="StaticVariableName">
      <property name="format" value="^[A-Z][A-Z0-9]*$"/>
    </module>
    <module name="StringLiteralEquality"/>
    <module name="TrailingComment"/>

    <!-- Restrict class names -->
    <module name="TypeName">
      <property name="format" value="^[A-Z][a-zA-Z0-9_]*$"/>
      <property name="tokens" value="CLASS_DEF"/>
    </module>

    <!-- Restrict interface type names -->
    <module name="TypeName">
      <property name="format" value="^[A-Z][a-zA-Z0-9_]*Type$"/>
      <property name="tokens" value="INTERFACE_DEF"/>
    </module>

    <module name="TypecastParenPad"/>
    <module name="UncommentedMain"/>
    <module name="UnusedImports"/>
    <module name="UpperEll"/>
    <module name="VisibilityModifier"/>
    <module name="WhitespaceAfter"/>
    <module name="WhitespaceAround"/>
  </module>

  <module name="FileLength"/>
  <module name="FileTabCharacter"/>

  <!-- Check license headers of all Java files -->
  <module name="Header">
    <property name="header" value="/*\n * Copyright © 2014 &lt;[email protected]&gt; http://io7m.com\n"/>
    <property name="charset" value="UTF-8"/>
  </module>

  <module name="JavadocPackage"/>
  <module name="NewlineAtEndOfFile"/>
  <!-- <module name="StrictDuplicateCode"/> -->

</module>