checkstyle.xml

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

<!--
    Derived Checkstyle configuration that checks the Google naming conventions from Google Java Style
    that can be found at https://google.github.io/styleguide/javaguide.html Formatting conventions are
    enforced by the spotless plugin.

    This configuration is based on the Google Checks that can be found at:
    https://github.com/checkstyle/checkstyle/blob/master/src/main/resources/google_checks.xml
     
 -->

<module name="Checker">
    <property name="charset" value="UTF-8" />
    <property name="fileExtensions" value="java, properties, xml" />

    <module name="SuppressWarningsFilter" />

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

    <!-- for suppression of rules; to use, surround code to exclude with comments: -->
    <!-- CHECKSTYLE.OFF: RuleToDisable   AND   CHECKSTYLE.ON: RuleToDisable -->
    <module name="SuppressWithPlainTextCommentFilter">
        <property name="offCommentFormat" value="CHECKSTYLE.OFF\: ([\w\|]+)" />
        <property name="onCommentFormat" value="CHECKSTYLE.ON\: ([\w\|]+)" />
    </module>

    <!-- for default checks, see https://checkstyle.sourceforge.io/checks.html -->
    <module name="TreeWalker">
        <!-- Make the @SuppressWarnings annotations available to Checkstyle -->
		<module name="SuppressWarningsHolder" />
        <module name="AbstractClassName">
            <property name="format" value="^(Base|Abstract).+$" />
        </module>
        <module name="MemberName">
            <property name="format"
                value="^(?!((m|s|my|our|the)[A-Z])[a-zA-Z0-9]*)([a-z][a-zA-Z0-9]*)$" />
            <message key="name.invalidPattern"
                value="Member ''{0}'' should be named with camelCase and without prefixes." />
        </module>
        <module name="ParameterName">
            <property name="format"
                value="^(?!((m|s|my|our|the)[A-Z])[a-zA-Z0-9]*)([a-z][a-zA-Z0-9]*)$" />
            <message key="name.invalidPattern"
                value="Member ''{0}'' should be named with camelCase and without prefixes." />
        </module>
        <module name="MethodName">
            <property name="format"
                value="^(?!((m|s|my|our|the)[A-Z])[a-zA-Z0-9]*)([a-z][a-zA-Z0-9]*)$" />
            <message key="name.invalidPattern"
                value="Member ''{0}'' should be named with camelCase and without prefixes." />
        </module>
        <module name="StaticVariableName">
            <property name="format"
                value="^(?!((m|s|my|our|the)[A-Z])[a-zA-Z0-9]*)([a-z][a-zA-Z0-9]*)$" />
            <message key="name.invalidPattern"
                value="Member ''{0}'' should be named with camelCase and without prefixes." />
        </module>
        <module name="NoFinalizer" />
        <!-- no dangling ; -->
        <module name="EmptyStatement"/>
        <!-- util and constant classes have no public constructors -->
        <module name="HideUtilityClassConstructor"/>
        <!-- do not allow imports from some packages -->
        <module name="IllegalImport">
            <property name="illegalPkgs" value="org.jetbrains.annotations" />
        </module>

    </module>
</module>