cs1302_checks.xml

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
          "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
          "https://checkstyle.org/dtds/configuration_1_3.dtd">

<!--
    Checkstyle configuration that checks the CS1302 Style Guide
    that can be found at https://github.com/cs1302uga/cs1302-styleguide.
    Authors: Michael E. Cotterell, Bradley J. Barnes
 -->

<!--
    2022-12-09 Added more comments to this configuration file.
    2022-12-09 Removed 'xml' from 'fileExtensions' property.
    2020-04-03 Updated for Checkstyle 8.31.
    2019-09-30 Updated default severity to 'error' to avoid confusion.
 -->

<module name="Checker">

  <!-- General configuration options.                     -->
  <property name="charset" value="UTF-8"/>
  <property name="severity" value="error"/>
  <property name="fileExtensions" value="java, properties"/>

  <!-- Excludes all 'module-info.java' files.             -->
  <!-- See https://checkstyle.org/config_filefilters.html -->
  <module name="BeforeExecutionExclusionFileFilter">
    <property name="fileNamePattern" value="module\-info\.java$"/>
  </module>

  <!-- Checks for whitespace.                              -->
  <!-- See http://checkstyle.sf.net/config_whitespace.html -->
  <module name="FileTabCharacter">
    <property name="eachLine" value="true"/>
  </module>

  <!-- Checks for long lines. -->
  <!-- https://checkstyle.sourceforge.io/config_sizes.html#LineLength -->
  <module name="LineLength">
    <property name="max" value="100"/>
    <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
  </module>

  <module name="TreeWalker">

    <module name="OuterTypeFilename"/>

    <module name="OneTopLevelClass"/>

    <module name="EmptyBlock">
      <property name="tokens" value="LITERAL_WHILE,LITERAL_TRY,LITERAL_FINALLY,LITERAL_DO,LITERAL_IF,LITERAL_ELSE,LITERAL_FOR,INSTANCE_INIT,STATIC_INIT,LITERAL_SWITCH,LITERAL_SYNCHRONIZED,LITERAL_CATCH"/>
    </module>

    <module name="EmptyCatchBlock"/>

    <module name="NeedBraces"/>

    <module name="LeftCurly"/>

    <module name="RightCurly">
      <property name="option" value="same"/>
    </module>

    <module name="WhitespaceAround">
      <property name="allowEmptyConstructors" value="true"/>
      <property name="allowEmptyLambdas" value="true"/>
      <property name="allowEmptyMethods" value="true"/>
      <property name="allowEmptyTypes" value="true"/>
      <property name="allowEmptyLoops" value="true"/>
      <message key="ws.notFollowed"
               value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)"/>
      <message key="ws.notPreceded"
               value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
    </module>

    <module name="OneStatementPerLine"/>

    <module name="ArrayTypeStyle"/>

    <module name="ModifierOrder"/>

    <module name="EmptyLineSeparator">
      <property name="allowNoEmptyLineBetweenFields" value="true"/>
    </module>

    <module name="TypeName">
      <message key="name.invalidPattern"
               value="Type name ''{0}'' must match pattern ''{1}''."/>
    </module>

    <module name="MemberName">
      <message key="name.invalidPattern"
               value="Member name ''{0}'' must match pattern ''{1}''."/>
    </module>

    <module name="MethodName">
      <message key="name.invalidPattern"
               value="Method name ''{0}'' must match pattern ''{1}''."/>
    </module>

    <module name="MethodLength">
      <property name="max" value="60"/>
    </module>

    <module name="ConstantName"/>

    <module name="Indentation">
      <property name="caseIndent" value="0"/>
    </module>

    <module name="SummaryJavadoc"/>

    <module name="JavadocMethod">
      <property name="allowedAnnotations" value="Override, Test, SafeVarargs"/>
    </module>

    <module name="MissingJavadocType">
      <property name="scope" value="private"/>
    </module>

    <module name="MissingJavadocMethod">
      <property name="scope" value="private"/>
      <property name="allowedAnnotations" value="Override, Test, SafeVarargs"/>
      <property name="ignoreMethodNamesRegex" value="^main$"/>
    </module>

  </module>
</module>