checkstyle-suppressions.xml

<?xml version="1.0"?>
<!--
  ~ Copyright 2015 Groupon.com
  ~
  ~ Licensed under the Apache License, Version 2.0 (the "License");
  ~ you may not use this file except in compliance with the License.
  ~ You may obtain a copy of the License at
  ~
  ~     http://www.apache.org/licenses/LICENSE-2.0
  ~
  ~ Unless required by applicable law or agreed to in writing, software
  ~ distributed under the License is distributed on an "AS IS" BASIS,
  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  ~ See the License for the specific language governing permissions and
  ~ limitations under the License.
  -->
<!DOCTYPE suppressions PUBLIC
    "-//Puppy Crawl//DTD Suppressions 1.1//EN"
    "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">

<suppressions>
    <!-- Exclude non-Java files -->
    <suppress checks="." files=".*\.js"/>
    <suppress checks="." files=".*\.ts"/>
    <suppress checks="." files=".*\.html"/>

    <!-- Exclude generated Java files -->
    <suppress checks="." files=".*[\\/]?generated-sources[\\/].*"/>

    <!-- Exclude certain checks from test code -->
    <suppress checks="JavadocVariable" files=".*Test\.java"/>
    <suppress checks="JavadocVariable" files=".*IT\.java"/>
    <suppress checks="JavadocVariable" files=".*PT\.java"/>
    <suppress checks="JavadocMethod" files=".*Test\.java"/>
    <suppress checks="JavadocMethod" files=".*IT\.java"/>
    <suppress checks="JavadocMethod" files=".*PT\.java"/>
    <suppress checks="EmptyBlock" files=".*Test\.java"/>
    <suppress checks="EmptyBlock" files=".*IT\.java"/>
    <suppress checks="EmptyBlock" files=".*PT\.java"/>
    <suppress checks="ExecutableStatementCount" files=".*Test\.java"/>
    <suppress checks="ExecutableStatementCount" files=".*IT\.java"/>
    <suppress checks="ExecutableStatementCount" files=".*PT\.java"/>
    <suppress checks="ThrowsCount" files=".*Test\.java"/>
    <suppress checks="ThrowsCount" files=".*IT\.java"/>
    <suppress checks="ThrowsCount" files=".*PT\.java"/>
    <suppress checks="FileLength" files=".*Test\.java"/>
    <suppress checks="FileLength" files=".*IT\.java"/>
    <suppress checks="FileLength" files=".*PT\.java"/>

    <!-- Exclude specific logback steno files from certain checks -->
    <suppress checks="FileLength" files="src/main/java/com/arpnetworking/steno/Logger\.java"/>
    <suppress checks="MethodCount" files="src/main/java/com/arpnetworking/steno/Logger\.java"/>
    <suppress checks="MethodCount" files="src/test/java/com/arpnetworking/steno/LoggerTest\.java"/>

    <!-- Do not require a package-info.java in external package path -->
    <suppress checks="JavadocPackage" files="src/main/java/ch/qos/logback/core/rolling/helper/CustomSizeAndTimeBasedArchiveRemover.java"/>

    <!-- Do not require a package-info.java for AspectJ files -->
    <suppress checks="JavadocPackage" files="src/main/aspect/com/arpnetworking/steno/aspect/LogBuilderAspect.java"/>

    <!-- Exclude all regex checks until inline suppressions are supported -->
    <!-- See: https://github.com/checkstyle/checkstyle/issues/4841 -->
    <suppress checks="RegexpSingleline" files=".*Test\.java"/>
    <suppress checks="RegexpSingleline" files=".*IT\.java"/>
    <suppress checks="RegexpSingleline" files=".*PT\.java"/>
    <suppress checks="RegexpSingleline" files=".*/widgets.*\.java"/>

</suppressions>