checkstyle-suppressions.xml

<?xml version="1.0"?>
<!--
  ~     Copyright (C) 2023  Intergral GmbH
  ~
  ~     This program is free software: you can redistribute it and/or modify
  ~     it under the terms of the GNU Affero General Public License as published by
  ~     the Free Software Foundation, either version 3 of the License, or
  ~     (at your option) any later version.
  ~
  ~     This program 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 Affero General Public License for more details.
  ~
  ~     You should have received a copy of the GNU Affero General Public License
  ~     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  -->

<!DOCTYPE suppressions PUBLIC
  "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
  "https://checkstyle.org/dtds/suppressions_1_2.dtd">
<suppressions>
  <!-- Relax the requirements for test files  -->
  <suppress checks="MissingJavadocMethod" files=".*Test(Target|).java"/>
  <suppress checks="MissingJavadocType" files=".*Test(Target|).java"/>
  <suppress checks="MissingJavadocMethod" files=".*Mock.*.java"/>
  <suppress checks="MissingJavadocType" files=".*Mock.*.java"/>
  <suppress checks="MissingJavadocType" files=".*/tests/.*"/>
  <suppress checks="MissingJavadocMethod" files=".*/tests/.*"/>
  <suppress checks="AvoidStarImport" files=".*Test(Target|).java"/>
  <!-- We do not care to check the method names in this file  -->
  <suppress checks="MethodName" files=".*MockMixinTemplate.java"/>
  <!-- These files are imported from external libraries and should not have our copyright -->
  <suppress id="license-agpl" files=".*resource/Resource.*"/>
  <suppress id="license-agpl" files=".*resource/SpiUtil.*"/>
  <suppress id="license-agpl" files=".*api/spi.*"/>
  <suppress id="license-agpl" files=".*agent/IDUtils.*"/>
  <suppress id="license-agpl" files=".*utils/string/.*"/>
  <!-- properties files do not match java comments  -->
  <suppress id="license-agpl" files=".*.properties"/>
  <!-- these files are used as targets for tracepoints and we want to ensure they do not change, so we ignore them  -->
  <suppress checks=".*" files=".*/test/target/.*"/>
  <!-- These types are mock classes used to load cf, lucee and railo tests we do not want to scan them  -->
  <suppress checks=".*" files=".*/coldfusion/.*"/>
  <suppress checks=".*" files=".*/lucee/.*"/>
  <suppress checks=".*" files=".*/railo/.*"/>
  <!-- Checkstyle doesn't like unnamed scope blocks  -->
  <suppress checks="Indentation" files=".*SourceMapParserTest.java"/>
  <suppress checks="Indentation" files=".*TracepointConfigServiceTest.java"/>
  <suppress checks="Indentation" files=".*SettingsTest.java"/>
  <!-- CF methods use uppercase names  -->
  <suppress checks="MethodName" files=".*CFUtilsTest.java"/>
  <!-- Visitor is complex so ignore line length to let us better format this class  -->
  <suppress checks="LineLength" files=".*Visitor.java"/>
  <!-- No need to doc source map atm -->
  <suppress checks="MissingJavadocType" files=".*/jsp/sourcemap/.*"/>
  <suppress checks="MissingJavadocMethod" files=".*/jsp/sourcemap/.*"/>
  <!-- Type is copied from external source.-->
  <suppress checks="OverloadMethodsDeclarationOrder" files=".*utils/string/TextStringBuilder.java"/>
</suppressions>