checkstyle.checkstyle.xml Maven / Gradle / Ivy

Go to download
<?xml version="1.0"?>
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
        "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
<module name="Checker">
    <!-- Trailing spaces -->
    <module name="RegexpSingleline">
        <property name="format" value="[^*]\s+$"/>
        <property name="message" value="Line has trailing spaces."/>
    </module>
    <module name="FileTabCharacter"/>
    <module name="NewlineAtEndOfFile"/>
    <module name="TreeWalker">

        <!-- quite a few checks preventing the usage of system default values that really shouldn't be used for server side development -->
        <module name="RegexpSinglelineJava">
            <property name="format" value="LocalDate\.now\(\)"/>
            <property name="message" value="Inappropriate usage of LocalDate.now(). Time time zone should be specified rather than using system default."/>
            <property name="ignoreComments" value="true"/>
        </module>
        <module name="RegexpSinglelineJava">
            <property name="format" value="LocalTime\.now\(\)"/>
            <property name="message" value="Inappropriate usage of LocalTime.now(). Time time zone should be specified rather than using system default."/>
            <property name="ignoreComments" value="true"/>
        </module>
        <module name="RegexpSinglelineJava">
            <property name="format" value="LocalDateTime\.now\(\)"/>
            <property name="message" value="Inappropriate usage of LocalDateTime.now(). Time time zone should be specified rather than using system default."/>
            <property name="ignoreComments" value="true"/>
        </module>
        <module name="RegexpSinglelineJava">
            <property name="format" value="ZonedDateTime\.now\(\)"/>
            <property name="message" value="Inappropriate usage of ZonedDateTime.now(). Time time zone should be specified rather than using system default."/>
            <property name="ignoreComments" value="true"/>
        </module>
        <module name="RegexpSinglelineJava">
            <property name="format" value="Locale\.getDefault\(\)"/>
            <property name="message" value="Inappropriate usage of Locale.getDefault(). Country and language should be explicitly provided, or a locale constant used."/>
            <property name="ignoreComments" value="true"/>
        </module>
        <module name="RegexpSinglelineJava">
            <property name="format" value="ZoneId\.systemDefault\(\)"/>
            <property name="message" value="Inappropriate usage of ZoneId.systemDefault(). The intended time zone should be explicitly stated."/>
            <property name="ignoreComments" value="true"/>
        </module>
        <module name="RegexpSinglelineJava">
            <property name="format" value="TimeZone\.getDefault\(\)"/>
            <property name="message" value="Inappropriate usage of TimeZone.getDefault(). The intended time zone should be explicitly stated."/>
            <property name="ignoreComments" value="true"/>
        </module>
        <module name="RegexpSinglelineJava">
            <property name="format" value="Clock\.systemDefaultZone\(\)"/>
            <property name="message" value="Inappropriate usage of Clock.systemDefaultZone(). The intended time zone should be explicitly stated."/>
            <property name="ignoreComments" value="true"/>
        </module>
        <module name="RegexpSinglelineJava">
            <property name="format" value="Calendar\.getInstance\(\)"/>
            <property name="message" value="Inappropriate usage of Calendar.getInstance(). The intended time zone should be explicitly stated."/>
            <property name="ignoreComments" value="true"/>
        </module>

        <module name="SeparatorWrap">
            <property name="tokens" value="DOT"/>
            <property name="option" value="nl"/>
        </module>
        <module name="SeparatorWrap">
            <property name="tokens" value="COMMA"/>
            <property name="option" value="eol"/>
        </module>
        <module name="OperatorWrap">
            <property name="tokens" value="PLUS"/>
            <property name="option" value="nl"/>
        </module>
        <module name="Indentation">
            <property name="basicOffset" value="4"/>
            <property name="braceAdjustment" value="0"/>
            <property name="caseIndent" value="4"/>
            <property name="throwsIndent" value="4"/>
            <property name="arrayInitIndent" value="4"/>
            <property name="lineWrappingIndentation" value="4"/>
        </module>
        <module name="NeedBraces"/>
        <!-- Checks for Naming Conventions.                  -->
        <!-- See http://checkstyle.sf.net/config_naming.html -->
        <module name="ConstantName"/>
        <module name="LocalFinalVariableName"/>
        <module name="LocalVariableName">
            <property name="format" value="^[a-zA-Z]*[a-z0-9][a-zA-Z0-9]*"/>
        </module>
        <module name="MemberName">
            <property name="format" value="^[a-zA-Z]*[a-z0-9][a-zA-Z0-9]*"/>
        </module>
        <module name="MethodName">
            <property name="format" value="^[a-z][a-zA-Z0-9]+"/>
        </module>
        <module name="PackageName"/>
        <module name="ParameterName"/>

        <module name="IllegalImport"/>
        <module name="RedundantImport"/>
        <module name="UnusedImports"/>

        <!--<module name="LineLength">-->
            <!--<property name="max" value="120"/>-->
        <!--</module>-->

        <module name="GenericWhitespace"/>
        <module name="EmptyForIteratorPad"/>
        <module name="MethodParamPad"/>
        <module name="NoWhitespaceAfter"/>
        <module name="NoWhitespaceBefore"/>
        <module name="ParenPad"/>
        <module name="WhitespaceAfter"/>
        <module name="WhitespaceAround">
            <property name="allowEmptyConstructors" value="true"/>
            <property name="allowEmptyMethods" value="true"/>
            <property name="tokens"
                      value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, EQUAL, GE, GT, LAND, LE, LITERAL_ASSERT, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, 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="ModifierOrder"/>
        <module name="RedundantModifier"/>
        <module name="LeftCurly"/>
        <module name="RightCurly"/>
        <module name="CovariantEquals"/>
        <module name="EmptyStatement"/>
        <module name="EqualsHashCode"/>
        <module name="IllegalInstantiation"/>

        <!--<module name="MagicNumber">-->
            <!--<property name="ignoreHashCodeMethod" value="true"/>-->
            <!--<property name="ignoreNumbers" value="-1, 0, 1, 2, 4, 100"/>-->
        <!--</module>-->
        <!--<module name="MissingSwitchDefault"/>-->
        <!-- Miscellaneous other checks.                   -->

        <module name="ArrayTypeStyle"/>
        <module name="UpperEll"/>
        <!--
            <module name="RedundantThrows">
            <property name="allowUnchecked" value="true"/>
            <property name="allowSubclasses" value="true"/>
            <property name="suppressLoadErrors" value="true"/>
        </module>
                -->

        <module name="HiddenField">
            <property name="tokens" value="VARIABLE_DEF"/>
        </module>

        <module name="FallThrough"/>
        <module name="ExplicitInitialization"/>
        <module name="EmptyStatement"/>

        <module name="DefaultComesLast"/>
        <module name="ArrayTypeStyle"/>
        <module name="StringLiteralEquality"/>
        <!--<module name="MultipleStringLiterals"/>-->
        <module name="UnnecessaryParentheses"/>
        <module name="ImportOrder">
            <property name="option" value="top"/>
            <property name="ordered" value="true"/>
        </module>

    </module>

    <!-- Add suppression later if necessary -->
    <module name="SuppressionFilter">
        <property name="file" value="${checkstyle-suppression-file}" default="/checkstyle/checkstyle-suppression.xml"/>
    </module>
</module>