checkstyle.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
  ~ @Copyright 2018-2023 HardBackNutter
  ~ @License GNU General Public License
  ~
  ~ This file is part of NeverTooManyBooks.
  ~
  ~ NeverTooManyBooks is free software: you can redistribute it and/or modify
  ~ it under the terms of the GNU General Public License as published by
  ~ the Free Software Foundation, either version 3 of the License, or
  ~ (at your option) any later version.
  ~
  ~ NeverTooManyBooks is distributed in the hope that it will be useful,
  ~ but WITHOUT ANY WARRANTY; without even the implied warranty of
  ~ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  ~ See the GNU General Public License for more details.
  ~
  ~ You should have received a copy of the GNU General Public License
  ~ along with NeverTooManyBooks. If not, see <http://www.gnu.org/licenses/>.
  -->

<!DOCTYPE module PUBLIC "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
    "http://checkstyle.org/dtds/configuration_1_3.dtd">
<!--
    Docs: https://checkstyle.org/checks.html

    Template:
    should match: https://source.android.com/setup/contribute/code-style
    copied from: https://gist.github.com/shareme/4197561
-->
<module name="Checker">
    <property name="severity"
              value="warning" />
    <!-- workaround for CheckStyle issue #483 -->
    <property name="charset"
              value="UTF-8" />

    <!-- ========== Headers ========== -->
    <!--<module name="Header"/>-->
    <!--<module name="RegexpHeader"/>-->

    <!-- Checks that each Java package has a package-info.java file -->
    <!--    <module name="JavadocPackage" />-->

    <!-- Require files to end with newline characters -->
    <module name="NewlineAtEndOfFile">
        <!--        <property name="lineSeparator"-->
        <!--            value="lf" />-->
    </module>

    <!-- Checks for long source files. (default 2000 lines) -->
    <module name="FileLength" />

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

    <!-- Checks that there are no tab characters -->
    <module name="FileTabCharacter" />

    <!--<module name="RegexpMultiline" />-->
    <!-- A check for detecting single lines that match a supplied regular expression. -->
    <module name="RegexpSingleline">
        <property name="severity"
                  value="ignore" />
        <property name="format"
                  value="\s+$" />
        <property name="message"
                  value="Line has trailing spaces." />
    </module>
    <!--<module name="RegexpOnFilename"/>-->

    <!--<module name="Translation" />-->
    <module name="UniqueProperties" />

    <module name="TreeWalker">
        <property name="tabWidth"
                  value="4" />

        <!-- ========== Annotations ========== -->
        <module name="AnnotationLocation" />
        <!--<module name="AnnotationOnSameLine" />-->
        <module name="AnnotationUseStyle" />
        <module name="MissingDeprecated" />
        <module name="MissingOverride" />
        <module name="PackageAnnotation" />
        <module name="SuppressWarnings" />
        <!--<module name="SuppressWarningsHolder" />-->

        <!-- ========== Block Checks ========== -->
        <!-- a switch with nested blocks can be collapsed/expanded in the editor. Useful. -->
        <!-- <module name="AvoidNestedBlocks" />-->
        <module name="EmptyBlock" />
        <module name="EmptyCatchBlock" />
        <module name="LeftCurly" />
        <module name="NeedBraces" />
        <module name="RightCurly" />

        <!-- ========== Class Design ========== -->
        <!--<module name="DesignForExtension" />-->
        <module name="FinalClass" />
        <module name="HideUtilityClassConstructor" />
        <module name="InnerTypeLast" />
        <module name="InterfaceIsType" />
        <module name="MutableException" />
        <module name="OneTopLevelClass" />
        <module name="ThrowsCount">
            <property name="max"
                      value="6" />
        </module>
        <module name="VisibilityModifier" />

        <!-- ========== Coding ========== -->
        <!--        <module name="ArrayTrailingComma" />-->
        <!--        <module name="AvoidInlineConditionals" />-->
        <module name="CovariantEquals" />
        <!--<module name="DeclarationOrder"/>-->
        <module name="DefaultComesLast" />
        <module name="EmptyStatement" />
        <module name="EqualsAvoidNull" />
        <module name="EqualsHashCode" />
        <module name="ExplicitInitialization" />
        <module name="FallThrough" />
        <module name="FinalLocalVariable">
            <!--<property name="tokens" value="VARIABLE_DEF,PARAMETER_DEF"/>-->
            <property name="tokens"
                      value="PARAMETER_DEF" />
        </module>
        <!--        <module name="HiddenField" />-->
        <module name="IllegalCatch" />
        <module name="IllegalInstantiation" />
        <module name="IllegalThrows" />
        <module name="IllegalToken" />
        <!--<module name="IllegalTokenText" />-->
        <module name="IllegalType" />
        <module name="InnerAssignment" />
        <module name="MagicNumber" />
        <!--<module name="MissingCtor" />-->
        <!--        <module name="MissingSwitchDefault" />-->
        <module name="ModifiedControlVariable" />
        <module name="MultipleStringLiterals" />
        <module name="MultipleVariableDeclarations" />
        <!--<module name="NestedForDepth"/>-->
        <!--<module name="NestedIfDepth"/>-->
        <module name="NoClone" />
        <module name="NoFinalizer" />
        <module name="OneStatementPerLine" />
        <!--        <module name="OverloadMethodsDeclarationOrder" />-->
        <module name="ParameterAssignment" />
        <!--<module name="RequireThis"/>-->
        <module name="ReturnCount">
            <property name="max"
                      value="5" />
            <property name="maxForVoid"
                      value="5" />
        </module>
        <module name="SimplifyBooleanExpression" />
        <module name="SimplifyBooleanReturn" />
        <module name="StringLiteralEquality" />
        <module name="SuperClone" />
        <module name="SuperFinalize" />
        <module name="UnnecessaryParentheses" />
        <!--<module name="VariableDeclarationUsageDistance"/>-->

        <!-- ========== Imports ========== -->
        <module name="AvoidStarImport" />
        <module name="AvoidStaticImport" />
        <!--<module name="CustomImportOrder" />-->
        <module name="IllegalImport" />
        <!--<module name="ImportControl" />-->
        <!--<module name="ImportOrder" />-->
        <module name="RedundantImport" />
        <module name="UnusedImports" />

        <!-- ========== Javadoc Comments ========== -->
        <!--<module name="AtclauseOrder" />-->
        <module name="JavadocMethod">
            <property name="validateThrows"
                      value="true" />
        </module>
        <!--<module name="JavadocParagraph"/>-->
        <!--<module name="JavadocTagContinuationIndentation" />-->
        <!--<module name="JavadocStyle" />-->
        <module name="JavadocType" />
        <!--<module name="JavadocVariable" />-->
        <module name="NonEmptyAtclauseDescription" />
        <module name="SingleLineJavadoc" />
        <module name="SummaryJavadocCheck" />

        <!-- ========== Metrics ========== -->
        <module name="BooleanExpressionComplexity" />
        <!-- IDEA checks this now-->
        <!-- <module name="JavaNCSS" />-->
        <!-- The NPATH metric computes the number of possible execution paths through a function.
         -->
        <!-- <module name="NPathComplexity">-->
        <!--     <property name="max"-->
        <!--               value="5000" />-->
        <!-- </module>-->

        <!-- ========== Miscellaneous ========== -->
        <module name="ArrayTypeStyle" />
        <!--<module name="AvoidEscapedUnicodeCharacters"/>-->
        <module name="CommentsIndentation" />
        <!--<module name="DescendantToken" />-->
        <module name="FinalParameters" />
        <!-- Useful, but cannot use 'align' of parameters etc when enabled -->
        <!--<module name="Indentation" />-->
        <!--<module name="OuterTypeFilename"/>-->
        <!--<module name="TodoComment" />-->
        <module name="TrailingComment" />

        <module name="UpperEll" />

        <!-- ========== Modifiers ========== -->
        <!--<module name="ClassMemberImpliedModifier" />-->
        <!--<module name="InterfaceMemberImpliedModifier"/>-->
        <module name="ModifierOrder" />
        <module name="RedundantModifier" />

        <!-- ========== Naming Conventions ========== -->
        <module name="AbbreviationAsWordInName" />
        <!--<module name="AbstractClassName" />-->
        <!--<module name="CatchParameterName" />-->
        <!--<module name="ClassTypeParameterName" />-->
        <module name="ConstantName" />
        <!--<module name="InterfaceTypeParameterName" />-->
        <module name="LambdaParameterName" />
        <module name="LocalFinalVariableName" />
        <module name="LocalVariableName" />
        <module name="MemberName" />
        <module name="MethodName" />
        <module name="MethodTypeParameterName">
            <property name="format"
                      value="^[A-Z]{1,3}$" />
        </module>
        <module name="PackageName" />
        <module name="ParameterName" />
        <module name="StaticVariableName" />
        <module name="TypeName" />

        <!-- ========== Regexp ========== -->
        <!--<module name="Regexp" />-->
        <!--<module name="RegexpSinglelineJava" />-->

        <!-- ========== Size Violations ========== -->
        <module name="AnonInnerLength">
            <property name="max"
                      value="30" />
        </module>
        <!--<module name="ExecutableStatementCount"/>-->
        <!--<module name="FileLength" /> on top-level -->
        <module name="MethodCount" />
        <module name="MethodLength" />
        <module name="OuterTypeNumber" />
        <module name="ParameterNumber" />

        <!-- ========== Whitespace ========== -->
        <!--<module name="EmptyForInitializerPad"/>-->
        <module name="EmptyForIteratorPad" />
        <!--<module name="EmptyLineSeparator"/>-->
        <module name="GenericWhitespace" />
        <module name="MethodParamPad" />
        <module name="NoLineWrap" />
        <module name="NoWhitespaceAfter" />
        <module name="NoWhitespaceBefore" />
        <module name="OperatorWrap" />
        <module name="ParenPad" />
        <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="SingleSpaceSeparator" />
        <module name="TypecastParenPad" />
        <module name="WhitespaceAfter" />
        <module name="WhitespaceAround" />


    </module>


</module>