A few weeks ago I took a first stab at creating a Checkstyle 3.0 file for HttpClient, but I never got around to posting it. I don't think I covered all of the rules, but it's a start. I'll try attaching it to this email.

-- Laura

Ortwin Glück wrote:

Cheers.

Are you using Maven for this? I tried that yesterday (first time actually) but found that with a fresh maven installation, the maven tasks are broken. This is mainly caused by a new version of Checkstyle. They moved their configuration from flat properties format to XML. So we need to write a new checkstyle config file. I can do that next week. I will file a bug for that.

Odi

Michael Becke wrote:

I'll redeploy the site. It seems that a number of apache urls(viewcvs and archives) have changed recently.

Mike



---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]


<?xml version="1.0" encoding="UTF-8"?>
<checkstyle-configurations file-format-version="1.0.0">
    <check-configuration name="HttpClient">
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.ConstantNameCheck" severity="warning">
            <config-properties>
                <config-property name="format" value="^[A-Z](_?[A-Z0-9]+)*$"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.EmptyBlockCheck"
            severity="warning" comment="try and finally must contain a statement">
            <config-properties>
                <config-property name="option" value="statement"/>
                <config-property name="tokens" value="LITERAL_FINALLY, LITERAL_TRY"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.EmptyBlockCheck"
            severity="warning" comment="catch must contain text">
            <config-properties>
                <config-property name="option" value="text"/>
                <config-property name="tokens" value="LITERAL_CATCH"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.FileLengthCheck"
            severity="warning" comment="2000">
            <config-properties>
                <config-property name="max" value="2000"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.IllegalImportCheck"
            severity="warning" comment="No sun.* imports">
            <config-properties>
                <config-property name="illegalPkgs" value="sun"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.IllegalInstantiationCheck"
            severity="warning" comment="Use java.lang.Boolean constants">
            <config-properties>
                <config-property name="classes" value="java.lang.Boolean"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.JavadocMethodCheck"
            severity="warning" comment="Require JavaDoc on methods and constructors">
            <config-properties>
                <config-property name="allowMissingParamTags" value="false"/>
                <config-property name="allowMissingReturnTag" value="false"/>
                <config-property name="allowMissingThrowsTags" value="false"/>
                <config-property name="allowThrowsTagsForSubclasses" value="false"/>
                <config-property name="allowUndeclaredRTE" value="true"/>
                <config-property name="scope" value="private"/>
                <config-property name="tokens" value="METHOD_DEF, CTOR_DEF"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.JavadocTypeCheck"
            severity="warning" comment="Require JavaDoc on classes and interfaces">
            <config-properties>
                <config-property name="authorFormat" value=""/>
                <config-property name="scope" value="private"/>
                <config-property name="tokens" value="CLASS_DEF, INTERFACE_DEF"/>
                <config-property name="versionFormat" value=""/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.JavadocVariableCheck"
            severity="warning" comment="Require JavaDoc on all variables">
            <config-properties>
                <config-property name="scope" value="private"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.LeftCurlyCheck"
            severity="warning" comment="Left curly brace at EOL">
            <config-properties>
                <config-property name="maxLineLength" value="100"/>
                <config-property name="option" value="eol"/>
                <config-property name="tokens" value="CLASS_DEF, CTOR_DEF, INTERFACE_DEF, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, METHOD_DEF"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.LineLengthCheck"
            severity="warning" comment="100">
            <config-properties>
                <config-property name="ignorePattern" value="^ \* \$Header: /home/cvspublic/jakarta-commons/httpclient"/>
                <config-property name="max" value="100"/>
                <config-property name="tabWidth" value="4"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.LocalFinalVariableNameCheck" severity="warning">
            <config-properties>
                <config-property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.LocalVariableNameCheck" severity="warning">
            <config-properties>
                <config-property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.MemberNameCheck" severity="warning">
            <config-properties>
                <config-property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.MethodLengthCheck"
            severity="warning" comment="150 (methods and constructors)">
            <config-properties>
                <config-property name="max" value="150"/>
                <config-property name="tokens" value="METHOD_DEF, CTOR_DEF"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.MethodNameCheck" severity="warning">
            <config-properties>
                <config-property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.NeedBracesCheck"
            severity="warning" comment="require braces in conditionals">
            <config-properties>
                <config-property name="tokens" value="LITERAL_DO, LITERAL_ELSE, LITERAL_IF, LITERAL_FOR, LITERAL_WHILE"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.OperatorWrapCheck"
            severity="warning" comment="Operator goes on new line in wrapped expressions">
            <config-properties>
                <config-property name="option" value="nl"/>
                <config-property name="tokens" value="BAND, BOR, BSR, BXOR, COLON, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.PackageNameCheck" severity="warning">
            <config-properties>
                <config-property name="format" value="^[a-z]+(\.[a-z]*)*$"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.ParameterNameCheck" severity="warning">
            <config-properties>
                <config-property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.ParameterNumberCheck"
            severity="warning" comment="7 (methods and constructors)">
            <config-properties>
                <config-property name="max" value="7"/>
                <config-property name="tokens" value="METHOD_DEF, CTOR_DEF"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.ParenPadCheck"
            severity="warning" comment="No paren padding">
            <config-properties>
                <config-property name="option" value="nospace"/>
                <config-property name="tokens" value="CTOR_CALL, LPAREN, METHOD_CALL, RPAREN, SUPER_CTOR_CALL, TYPECAST"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.RedundantModifierCheck"
            severity="warning" comment="No method/variable modifiers in interfaces">
            <config-properties>
                <config-property name="tokens" value="METHOD_DEF, VARIABLE_DEF"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.RightCurlyCheck"
            severity="warning" comment="On same line">
            <config-properties>
                <config-property name="option" value="same"/>
                <config-property name="tokens" value="LITERAL_CATCH, LITERAL_ELSE, LITERAL_TRY"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.StaticVariableNameCheck" severity="warning">
            <config-properties>
                <config-property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.TabCharacterCheck"
            severity="warning" comment="Death to Tabs!">
            <config-properties/>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.TodoCommentCheck"
            severity="info" comment="TODO and FIXME">
            <config-properties>
                <config-property name="format" value="(TODO)|(FIXME)"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.TypeNameCheck" severity="warning">
            <config-properties>
                <config-property name="format" value="^[A-Z][a-zA-Z0-9]*$"/>
                <config-property name="tokens" value="CLASS_DEF, INTERFACE_DEF"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.UpperEllCheck"
            severity="warning" comment="Long constants must use uppercase L">
            <config-properties/>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.VisibilityModifierCheck"
            severity="warning" comment="Data members must be private">
            <config-properties>
                <config-property name="packageAllowed" value="false"/>
                <config-property name="protectedAllowed" value="false"/>
                <config-property name="publicMemberPattern" value="^serialVersionUID"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.WhitespaceAfterCheck"
            severity="warning" comment="Whitespace after , ; cast">
            <config-properties>
                <config-property name="tokens" value="COMMA, SEMI, TYPECAST"/>
            </config-properties>
        </rule-configuration>
        <rule-configuration
            classname="com.puppycrawl.tools.checkstyle.checks.WhitespaceAroundCheck"
            severity="warning" comment="Whitespace around operators &amp; keywords">
            <config-properties>
                <config-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, LCURLY, 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, RCURLY, SL, SLIST, SL_ASSIGN, SR, SR_ASSIGN, STAR, STAR_ASSIGN"/>
            </config-properties>
        </rule-configuration>
    </check-configuration>
</checkstyle-configurations>

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to