org.jukito.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://users.tpg.com.au/ojburn/dtds/configuration_1_3.dtd">

<module name="Checker">
    <property name="severity" value="warning"/>
    <module name="TreeWalker">
        <module name="FileContentsHolder"/>
        <module name="DeclarationOrder"/>
        <module name="EqualsHashCode"/>
        <module name="ExplicitInitialization"/>
        <module name="GenericWhitespace"/>
        <module name="MethodParamPad"/>
        <module name="MissingOverride">
            <property name="severity" value="error"/>
        </module>
        <module name="ModifiedControlVariable"/>
        <module name="ParameterAssignment"/>
        <module name="ParenPad"/>
        <module name="SimplifyBooleanExpression"/>
        <module name="SimplifyBooleanReturn"/>
        <module name="StringLiteralEquality"/>
        <module name="UnnecessaryParentheses"/>
        <module name="LineLength">
            <property name="severity" value="error"/>
            <property name="max" value="120"/>
            <property name="ignorePattern" value="^(import|package) [^ ]+$"/>
        </module>
        <module name="MissingSwitchDefault">
            <property name="severity" value="info"/>
        </module>
        <module name="InterfaceIsType">
            <property name="severity" value="error"/>
        </module>
        <module name="RedundantImport">
            <property name="severity" value="error"/>
        </module>
        <module name="UnusedImports">
            <property name="severity" value="error"/>
        </module>
        <module name="IllegalImport">
            <property name="severity" value="error"/>
        </module>
        <module name="AvoidStarImport">
            <property name="severity" value="error"/>
        </module>
        <module name="ImportOrder">
            <property name="severity" value="error"/>
            <property name="option" value="bottom"/>
            <property name="ordered" value="true"/>
            <property name="separated" value="true"/>
            <property name="groups" value="com,org,java,javax"/>
        </module>
        <module name="JavadocType">
            <property name="severity" value="info"/>
            <property name="scope" value="protected"/>
        </module>
        <module name="JavadocMethod">
            <property name="severity" value="info"/>
            <property name="scope" value="protected"/>
            <property name="allowUndeclaredRTE" value="true"/>
            <property name="allowMissingParamTags" value="true"/>
            <property name="allowMissingThrowsTags" value="true"/>
            <property name="allowMissingReturnTag" value="true"/>
            <property name="allowMissingJavadoc" value="true"/>
            <property name="allowMissingPropertyJavadoc" value="true"/>
            <property name="logLoadErrors" value="true"/>
            <property name="tokens" value="METHOD_DEF"/>
            <metadata name="com.atlassw.tools.eclipse.checkstyle.lastEnabledSeverity" value="info"/>
        </module>
        <module name="JavadocStyle">
            <property name="severity" value="info"/>
            <property name="checkHtml" value="false"/>
            <property name="tokens" value="CLASS_DEF,CTOR_DEF,INTERFACE_DEF,METHOD_DEF,VARIABLE_DEF"/>
            <metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Well formed java docs"/>
        </module>
        <module name="ParameterName">
            <property name="severity" value="error"/>
        </module>
        <module name="LocalFinalVariableName">
            <property name="severity" value="error"/>
        </module>
        <module name="LocalVariableName">
            <property name="severity" value="error"/>
            <property name="tokens" value="PARAMETER_DEF,VARIABLE_DEF"/>
        </module>
        <module name="LeftCurly"/>
        <module name="RightCurly"/>
        <module name="NeedBraces">
            <metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="make sure if has braces"/>
        </module>
        <module name="CovariantEquals">
            <property name="severity" value="error"/>
        </module>
        <module name="HiddenField">
            <property name="severity" value="error"/>
            <property name="tokens" value="VARIABLE_DEF"/>
            <property name="ignoreConstructorParameter" value="true"/>
            <property name="ignoreSetter" value="true"/>
        </module>
        <module name="IllegalInstantiation">
            <property name="severity" value="error"/>
            <property name="classes" value="java.lang.Boolean"/>
        </module>
        <module name="UpperEll">
            <property name="severity" value="error"/>
            <metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="checking for 4l rather than 4L"/>
        </module>
        <module name="DefaultComesLast">
            <property name="severity" value="error"/>
        </module>
        <module name="MultipleStringLiterals">
            <property name="severity" value="info"/>
            <property name="ignoreStringsRegexp" value=".{0,3}"/>
        </module>
        <module name="FallThrough">
            <property name="severity" value="error"/>
        </module>
        <module name="IllegalInstantiation">
            <property name="severity" value="error"/>
            <property name="classes" value="Boolean"/>
        </module>
        <module name="Regexp">
            <property name="severity" value="info"/>
            <property name="format" value="[^:^&quot;]:&quot; .*+"/>
            <property name="message" value="check that a space is left after a colon on an assembled error message"/>
            <property name="illegalPattern" value="true"/>
            <metadata name="com.atlassw.tools.eclipse.checkstyle.comment"
                    value="check that a space is left after a colon with an assembled error message"/>
        </module>
        <module name="Regexp">
            <property name="severity" value="error"/>
            <property name="format" value="[\r]?[\n][ \t]*[\r]?[\n][ \t]*[\r]?[\n][ \t]*"/>
            <property name="message" value="more than one blank line"/>
            <property name="illegalPattern" value="true"/>
            <metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="more than one blank line"/>
        </module>
        <module name="Regexp">
            <property name="severity" value="error"/>
            <property name="format" value="[\r]?[\n][ \t]*[\r]?[\n][ \t]+[}][ ]*[\n]"/>
            <property name="message" value="newline before }"/>
            <property name="illegalPattern" value="true"/>
            <metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="newline before }"/>
        </module>
        <module name="Regexp">
            <property name="severity" value="error"/>
            <property name="format" value="[^*][ \t]+[\r]?[\n]"/>
            <property name="message" value="trailing whitespace"/>
            <property name="illegalPattern" value="true"/>
            <metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="trailing whitespace"/>
        </module>
        <module name="RedundantModifier"/>
        <module name="ModifierOrder">
            <property name="severity" value="error"/>
        </module>
        <module name="EmptyStatement">
            <property name="severity" value="error"/>
        </module>
        <module name="MethodName">
            <property name="severity" value="error"/>
        </module>
        <module name="MemberName">
            <property name="severity" value="error"/>
            <property name="format" value="[a-z]|[a-z][a-z_0-9][A-Za-z0-9_]*|[a-z](?&lt;!f)[A-Z0-9]*"/>
        </module>
        <module name="NoWhitespaceBefore">
            <property name="severity" value="error"/>
            <property name="allowLineBreaks" value="true"/>
            <property name="tokens" value="DOT"/>
        </module>
        <module name="NoWhitespaceAfter">
            <property name="severity" value="error"/>
            <property name="allowLineBreaks" value="false"/>
            <property name="tokens" value="BNOT,DEC,DOT,INC,LNOT,UNARY_MINUS,UNARY_PLUS"/>
        </module>
        <module name="WhitespaceAround">
            <property name="severity" value="error"/>
            <property name="tokens"
                    value="COLON,NOT_EQUAL,QUESTION,DIV,DIV_ASSIGN,BXOR,BXOR_ASSIGN,MINUS,LCURLY,STAR,STAR_ASSIGN,TYPE_EXTENSION_AND,BAND,LAND,BAND_ASSIGN,MOD,MOD_ASSIGN,PLUS,PLUS_ASSIGN,LT,SL,SL_ASSIGN,LE,ASSIGN,MINUS_ASSIGN,EQUAL,GT,GE,SR,SR_ASSIGN,BSR,BSR_ASSIGN,BOR,BOR_ASSIGN,LOR,LITERAL_ASSERT,LITERAL_ASSERT,LITERAL_CATCH,LITERAL_DO,LITERAL_ELSE,LITERAL_FINALLY,LITERAL_FOR,LITERAL_IF,LITERAL_RETURN,SLIST,LITERAL_SYNCHRONIZED,LITERAL_TRY,LITERAL_WHILE"/>
            <metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Must have spaces"/>
        </module>
        <module name="WhitespaceAfter">
            <property name="tokens" value="TYPECAST"/>
        </module>
        <module name="TypecastParenPad">
            <property name="severity" value="error"/>
            <property name="tokens" value="RPAREN,TYPECAST"/>
        </module>
    </module>

    <module name="JavadocPackage">
        <property name="severity" value="ignore"/>
        <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
    </module>
    <module name="Translation"/>
    <module name="NewlineAtEndOfFile">
        <property name="severity" value="error"/>
        <property name="lineSeparator" value="lf"/>
    </module>
    <module name="FileTabCharacter">
        <property name="severity" value="error"/>
        <metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="no tabs"/>
    </module>
    <module name="RegexpSingleline">
        <property name="severity" value="error"/>
        <property name="format" value="  [/][/][A-z]"/>
        <property name="message" value="// comments must be followed by a space and be on their own line"/>
        <metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="bad // comment"/>
    </module>
    <module name="SuppressionCommentFilter">
        <property name="offCommentFormat" value="CHECKSTYLE_OFF"/>
        <property name="onCommentFormat" value="CHECKSTYLE_ON"/>
    </module>
    <module name="SuppressionCommentFilter">
        <property name="offCommentFormat" value="CHECKSTYLE_NAMING_OFF"/>
        <property name="onCommentFormat" value="CHECKSTYLE_NAMING_ON"/>
        <property name="checkFormat" value=".*Name.*"/>
        <property name="messageFormat" value=".*name.*"/>
        <metadata name="com.atlassw.tools.eclipse.checkstyle.comment" value="Avoid name checking"/>
    </module>
    <module name="RegexpHeader">
        <property name="fileExtensions" value="java"/>
        <property name="severity" value="error"/>
        <property name="header" value="^/\*\*$\n^ \* Copyright \d{4} ArcBees Inc\.$\n^ \*$\n^ \* Licensed under the Apache License, Version 2\.0 \(the &quot;License&quot;\); you may not$\n^ \* use this file except in compliance with the License\. You may obtain a copy of$\n^ \* the License at$\n^ \*$\n^ \* http://www\.apache\.org/licenses/LICENSE-2\.0$\n^ \*$\n^ \* Unless required by applicable law or agreed to in writing, software$\n^ \* distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT$\n^ \* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied\. See the$\n^ \* License for the specific language governing permissions and limitations under$\n^ \* the License\.$\n^ \*/$\n"/>
    </module>
    <module name="SuppressionFilter">
        <property name="file" value="${checkstyle.root}suppressions.xml"/>
    </module>
</module>