cs61b_sp17_checks.xml

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

<!--

  Checkstyle configuration for CS61B.  Modified from sun_checks.xml, which checks the 
  sun coding conventions from:

    - the Java Language Specification at
      http://java.sun.com/docs/books/jls/second_edition/html/index.html

    - the Sun Code Conventions at http://java.sun.com/docs/codeconv/

    - the Javadoc guidelines at
      http://java.sun.com/j2se/javadoc/writingdoccomments/index.html

    - the JDK Api documentation http://java.sun.com/j2se/docs/api/index.html

    - some best practices

  For information on configuration, see http://checkstyle.sf.net.

  Most Checks are configurable, be sure to consult the documentation.

  To completely disable a check, just comment it out or delete it from the file.

  Finally, it is worth reading the documentation.

-->

<module name="Checker">
    <!--
        If you set the basedir property below, then all reported file
        names will be relative to the specified directory. See
        http://checkstyle.sourceforge.net/5.x/config.html#Checker

        <property name="basedir" value="${basedir}"/>
    -->
    <!-- removed b/c IntelliJ virtual file system -->
    <!--<property name="basedir" value="${user.dir}"/>-->

    <!-- Checks whether files end with a new line.                        -->
    <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
    <module name="NewlineAtEndOfFile">
      <property name="lineSeparator" value="lf_cr_crlf"/>
    </module>

    <!-- Checks that property files contain the same keys.         -->
    <!-- See http://checkstyle.sf.net/config_misc.html#Translation -->
    <module name="Translation"/>

    <!-- Checks for Size Violations.                    -->
    <!-- See http://checkstyle.sf.net/config_sizes.html -->
    <module name="FileLength">
         <property name="max" value="2000"/>
    </module>

    <module name="LineLength">
        <property name="max" value="100"/>
    </module>

    <!-- Checks for whitespace                               -->
    <!-- See http://checkstyle.sf.net/config_whitespace.html -->
    <!-- note from Eli: I hate this rule. Tabs >> Spaces -->
    <module name="FileTabCharacter"/>

    <module name="TreeWalker">
        <!-- Checks for Naming Conventions.                  -->
        <!-- See http://checkstyle.sf.net/config_naming.html -->
        <module name="ConstantName">
          <property name="format" value="^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$"/>
          <message key="name.invalidPattern"
                  value="Constant ''{0}'' must be in all capitals." />
        </module>
        <module name="LocalFinalVariableName">
          <property name="format" value="^([A-Z][0-9]*|[a-z][a-zA-Z0-9]*)$"/>
          <message key="name.invalidPattern"
                   value="Local final variable ''{0}'' must start with a lower-case letter, or consist of a single, upper-case letter." />
        </module>
        <module name="LocalVariableName">
          <property name="format" value="^([A-Z][0-9]*|[a-z][a-zA-Z0-9]*)$"/>
          <message key="name.invalidPattern"
                  value="Local variable ''{0}'' must start with a lower-case letter, or consist of a single, upper-case letter." />
        </module>
        <module name="MemberName">
          <property name="format" value="^_?[a-z][a-zA-Z0-9]*$|_?[A-Z]$"/>
          <message key="name.invalidPattern"
                  value="Instance variable ''{0}'' must start with either a lower-case letter or '_'."/>
        </module>
        <module name="MethodName">
          <property name="format" value="^([A-Z][0-9]*|[a-z][a-zA-Z0-9]*)$"/>
          <message key="name.invalidPattern"
                   value="Method name ''{0}'' must start with a lower-case letter, or consist of a single, upper-case letter." />
        </module>
        <module name="PackageName">
          <property name="format"
                    value="^[a-z][a-z0-9_]*(\.[a-zA-Z_][a-zA-Z0-9_]*)*$" />
          <message key="name.invalidPattern"
                   value="Package name ''{0}'' must start with a lower-case letter."/>
        </module>
        <module name="ParameterName">
          <property name="format" value="^([A-Z][0-9]*|[a-z][a-zA-Z0-9]*)$"/>
          <message key="name.invalidPattern"
                   value="Parameter ''{0}'' must start with a lower-case letter, or consist of a single, upper-case letter." />
        </module>
        <module name="StaticVariableName">
          <property name="format" value="^_?[a-z][a-zA-Z0-9]*$|_?[A-Z]$"/>
          <message key="name.invalidPattern"
                   value="Static variable ''{0}'' must be in all capitals." />
        </module>
        <module name="TypeName">
          <property name="format" value="^[A-Z][A-Za-z0-9]*$"/>
          <message key="name.invalidPattern"
                   value="Type (class) name ''{0}'' must start with a capital letter."/>
        </module>
        <module name="ClassTypeParameterName">
          <property name="format" value="^[A-Z][A-Za-z0-9]*$"/>
          <message key="name.invalidPattern"
                   value="Type parameter ''{0}'' must start with a capital letter."/>
        </module>
        <module name="MethodTypeParameterName">
          <property name="format" value="^[A-Z][A-Za-z0-9]*$"/>
          <message key="name.invalidPattern"
                   value="Type parameter ''{0}'' must start with a capital letter."/>
        </module>

        <!-- Checks for imports                              -->
        <!-- See http://checkstyle.sf.net/config_import.html -->
        <module name="AvoidStarImport">
          <property name="excludes"
		    value="java.lang.Math,org.junit.Assert,java.lang.Double"/>
          <property name="allowStaticMemberImports" value="true"/>
        </module>
        <module name="IllegalImport"/> <!-- defaults to sun.* packages -->
        <module name="RedundantImport"/>
        <module name="UnusedImports"/>

        <!-- Checks for Size Violations.                    -->
        <!-- See http://checkstyle.sf.net/config_sizes.html -->

        <module name="MethodLength">
           <property name="max" value="80"/>
        </module>
        <module name="ParameterNumber">
           <property name="max" value="8"/>
        </module>

        <module name="OuterTypeNumber">
           <property name="max" value="1"/>
        </module>


        <!-- Checks for whitespace                               -->
        <!-- See http://checkstyle.sf.net/config_whitespace.html -->
        <module name="GenericWhitespace"/>
        <module name="MethodParamPad">
          <property name="allowLineBreaks" value="true"/>
        </module>
        <module name="NoWhitespaceAfter">
          <property name="tokens"
                    value="BNOT,DEC,DOT,INC,LNOT,UNARY_MINUS,UNARY_PLUS"/>
        </module>
        <module name="NoWhitespaceBefore"/>
        <module name="OperatorWrap"/>
        <module name="ParenPad"/>
        <module name="TypecastParenPad"/>
        <module name="WhitespaceAfter"/>
        <module name="WhitespaceAround"/>

        <!-- Modifier Checks                                    -->
        <!-- See http://checkstyle.sf.net/config_modifiers.html -->
        <module name="ModifierOrder"/>
        <module name="RedundantModifier"/>

        <!-- Checks for blocks. You know, those {}'s         -->
        <!-- See http://checkstyle.sf.net/config_blocks.html -->
        <module name="EmptyBlock">
          <property name="option" value="statement"/>
          <property name="tokens" value="LITERAL_DO,LITERAL_ELSE,LITERAL_FINALLY,LITERAL_IF,LITERAL_FOR,LITERAL_TRY,INSTANCE_INIT,STATIC_INIT"/>
        </module>
        <module name="EmptyBlock">
          <property name="option" value="text"/>
          <property name="tokens" value="LITERAL_CATCH,LITERAL_WHILE"/>
        </module>
        <module name="LeftCurly"/>
        <module name="NeedBraces"/>
        <module name="RightCurly"/>


        <!-- Checks for common coding problems               -->
        <!-- See http://checkstyle.sf.net/config_coding.html -->
        <!-- <module name="AvoidInlineConditionals"/> -->
        <!--<module name="DoubleCheckedLocking"/>-->
        <module name="EmptyStatement"/>
        <module name="EqualsHashCode"/>
        <module name="HiddenField">
          <property name="ignoreConstructorParameter" value="true"/>
          <property name="ignoreSetter" value="true"/>
        </module>
        <!--<module name="MagicNumber">
          <property name="ignoreNumbers"
                    value="-10, -9, -8, -7, -6, -5, -4, -3, -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 26, 100, 1000, 0.5, -0.5, 0.25, -0.25"/>
        </module>-->
        <module name="MissingSwitchDefault"/>
        <module name="SimplifyBooleanExpression"/>
        <module name="SimplifyBooleanReturn"/>

        <module name="StringLiteralEquality"/>
        <module name="IllegalCatch">
          <property name="illegalClassNames"
                    value="java.lang.Exception, java.lang.Throwable,
                             java.lang.Error"/>
        </module>
        <module name="FallThrough"/>

        <!-- Checks for class design                         -->
        <!-- See http://checkstyle.sf.net/config_design.html -->
        <!-- <module name="DesignForExtension"/> -->
        <!-- <module name="FinalClass"/> -->
        <!-- <module name="HideUtilityClassConstructor"/> -->
        <module name="InterfaceIsType"/>
        <module name="VisibilityModifier">
          <property name="protectedAllowed" value="true"/>
          <property name="packageAllowed" value="true"/>
          <message key="variable.notPrivate"
                   value="Variable ''{0}'' may not be public."/>
        </module>

        <!-- this is to prevent the style checker from throwing an absurd amount of errors if you have tabs-->
        <property name="tabWidth" value="4"/>

        <!-- indentation checks                           -->
        <module name="Indentation">
          <property name="basicOffset" value="4"/>
          <property name="braceAdjustment" value="0"/>
        </module>

        <!-- Miscellaneous other checks.                   -->
        <!-- See http://checkstyle.sf.net/config_misc.html -->
        <module name="ArrayTypeStyle"/>
        <module name="TodoComment"/>
        <module name="UpperEll"/>

    </module>

</module>