oject.build-tools.0.9.0.source-code.custom_checkstyle.xml Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of build-tools Show documentation
A set of tools for managing code quality and builds
The newest version!
<?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" />
    <property name="fileExtensions" value="java, properties, xml"/>
    <module name="NewlineAtEndOfFile"/>
    <module name="Translation"/>
    <module name="FileTabCharacter"/>
    <module name="FileLength" />
    <module name="RegexpSingleline">
        <property name="format" value="\s+$"/>
        <property name="minimum" value="0"/>
        <property name="maximum" value="0"/>
        <property name="message" value="Line has trailing spaces."/>
    </module>
    <module name="TreeWalker">
        <property name="tabWidth" value="4" />
        <module name="FileContentsHolder" />
        <module name="AnnotationUseStyle">
            <property name="elementStyle" value="compact"/>
            <property name="trailingArrayComma" value="never"/>
            <property name="closingParens" value="never"/>
        </module>
        <module name="ClassTypeParameterName" />
        <module name="ConstantName" />
        <module name="LocalVariableName" />
        <module name="MemberName" />
        <module name="MethodName" />
        <module name="MethodTypeParameterName" />
        <module name="PackageName" />
        <module name="ParameterName" />
        <module name="StaticVariableName" />
        <module name="TypeName" />
        <module name="MissingDeprecated" />
        <module name="MissingOverride" />
        <module name="AvoidStarImport" />
        <module name="IllegalImport" />
       
        <!-- unfortunetaly could not synchronize with eclipse -->
        <!-- <module name="ImportOrder"> <property name="separated" value="true"/> 
        <property name="groups" value="java,javax,/com\..*/,/org\..*/,android"/> 
        <property name="option" value="top"/> </module> -->
        <module name="RedundantImport" />
        <module name="UnusedImports" />

        <module name="MethodLength" />
        <module name="ParameterNumber" />
        <module name="OuterTypeNumber" />
        <module name="MethodCount" />
        <module name="EmptyForInitializerPad" />
        <module name="EmptyForIteratorPad" />
        <module name="NoWhitespaceAfter">
            <property name="tokens"
                      value="BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS, UNARY_PLUS" />
        </module>
        <module name="NoWhitespaceBefore" />

        <module name="OperatorWrap">
            <property name="option" value="NL"/>
            <property name="tokens" value="BAND, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR "/>
        </module>
        
        <module name="MethodParamPad" />
        <module name="ParenPad" />
        <module name="TypecastParenPad" />
        <module name="WhitespaceAfter" />
        <module name="WhitespaceAround">
            <property name="tokens"
                      value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, DO_WHILE, EQUAL, GE, GT, LAND, LCURLY, LE, LITERAL_ASSERT, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN, NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, SL, SLIST, SL_ASSIGN, SR, SR_ASSIGN, STAR, STAR_ASSIGN, TYPE_EXTENSION_AND" />
        </module>
        <module name="RedundantModifier" />
        <module name="AvoidNestedBlocks">
            <property name="allowInSwitchCase" value="true" />
        </module>
        <module name="LeftCurly">
            <property name="maxLineLength" value="100" />
        </module>
        <module name="NeedBraces" />
        <module name="RightCurly">
            <property name="option" value="alone"/>
            <property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, STATIC_INIT, INSTANCE_INIT"/>
        </module>
        <module name="CovariantEquals" />
        <module name="DefaultComesLast" />
        <module name="EmptyStatement" />
        <module name="EqualsHashCode" />
        <module name="FallThrough" />
        <module name="IllegalThrows" />
        <module name="IllegalType">
            <property name="illegalClassNames	"
                      value="java.util.GregorianCalendar, java.util.Hashtable, java.util.HashSet, java.util.HashMap, java.util.LinkedList, java.util.LinkedHashMap, java.util.LinkedHashSet, java.util.TreeSet, java.util.TreeMap, java.util.Vector" />
        </module>
        <module name="InnerAssignment" />
        <module name="ModifiedControlVariable" />
        <module name="MultipleVariableDeclarations" />
        <module name="NestedForDepth">
            <property name="max" value="2" />
        </module>
        <module name="NestedIfDepth"> <!-- this is too high, we should refactor those parts -->
            <property name="max" value="5" />
        </module>
        <module name="NestedTryDepth" />
        <module name="NoClone" />
        <module name="NoFinalizer" />
        <module name="PackageDeclaration" />
        <module name="SimplifyBooleanExpression" />
        <module name="SimplifyBooleanReturn" />
        <module name="StringLiteralEquality" />
        <module name="ArrayTrailingComma" />
        <module name="UnnecessaryParentheses" />
        <module name="OneStatementPerLine" />
        <module name="HideUtilityClassConstructor" />
        <module name="InterfaceIsType" />
        <module name="MutableException" />
        <module name="ThrowsCount">
            <property name="max" value="2" />
        </module>
        <!-- we should really enable the following -->
        <!-- <module name="VisibilityModifier"> <property name="packageAllowed" 
        value="true"/> <property name="protectedAllowed" value="true"/> </module> -->
        <module name="ArrayTypeStyle" />
        <module name="Indentation">
            <property name="severity" value="error"/>
            <property name="basicOffset" value="4"/>
            <property name="throwsIndent" value="8"/>
            <property name="lineWrappingIndentation" value="8"/>
        </module>
        <!--
        <module name="RegexpSinglelineJava">
                <property name="format" value="^\t* +\t*\S" />
                <property name="message"
                        value="Line has leading space characters; indentation should be performed with tabs only." />
                <property name="ignoreComments" value="true" />
        </module>-->
        <module name="UpperEll" />
        <module name="OuterTypeFilename" />
        <module name="OuterTypeNumber" />
        <module name="JavadocTagContinuationIndentation"/>
        <module name="JavadocStyle">
            <property name="scope" value="public"/>
        </module>
        <module name="SummaryJavadocCheck">
            <property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
        </module>
        <module name="JavadocParagraph"> 
            <property name="allowNewlineParagraph" value="false"/>
        </module>
        <!--        <module name="JavadocMethod">
            <property name="scope" value="public"/>
            <property name="allowMissingParamTags" value="true"/>
            <property name="allowMissingThrowsTags" value="true"/>
            <property name="allowMissingReturnTag" value="true"/>
            <property name="minLineCount" value="2"/>
            <property name="allowedAnnotations" value="Override, Test"/>
            <property name="allowThrowsTagsForSubclasses" value="true"/>
        </module>-->
        <module name="SingleLineJavadoc">
            <property name="ignoreInlineTags" value="false"/>
        </module>
    </module>

</module>