checkstyle-suppressions.xml

<?xml version="1.0"?>
<!--

    Copyright (c) 2016, 2024 Oracle and/or its affiliates.

    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"
        "https://checkstyle.sourceforge.net/dtds/suppressions_1_1.dtd">

<!--
Use in Helidon:
This file is used when running the aggregate report (and configuration in modules is ignored in that case).
This file SHOULD ONLY contain exclusions for whole modules where appropriate.
Single check exclusions should be handled through @SuppressWarning("checkstyle:....") annotation.

Only exceptional cases that cannot be handled through annotations may be provided here.
This is to keep the checkstyle exclusions co-located with the code, so if the code changes, we do not leave an outdated
record here.
-->
<suppressions>
    <!--
    - File exclusions (exceptions)
    - FileLength cannot be excluded using a @SuppressWarnings
    -->
    <!-- the huffman constants are long, but this is not actual code, just a set of constants -->
    <suppress files="http/http2/src/main/java/io/helidon/http/http2/Http2HuffmanConstants\.java"
            checks="FileLength"/>

    <suppress files="integrations/cdi/jpa-cdi/src/main/java/io/helidon/integrations/cdi/jpa/JpaExtension\.java"
            checks="FileLength"/>

    <!-- This can be removed once Jwt class has all Validators removed. They are deprecated now -->
    <suppress files="security/jwt/src/main/java/io/helidon/security/jwt/Jwt\.java"
            checks="FileLength"/>

    <!--
    - Module exclusions
    -->

    <!-- JMH benchmark is not required to follow code style -->
    <suppress files="webserver/benchmark/"
            checks=".*"/>

    <suppress files="builder/tests/"
            checks=".*"/>
    <suppress files="inject/tests/"
            checks=".*"/>
    <suppress files="inject/configdriven/tests/"
            checks=".*"/>
    <suppress files="service/tests/"
            checks=".*"/>
    <suppress files="examples/inject/"
            checks=".*"/>
    <suppress files="integrations/oci/sdk/tests/"
            checks=".*"/>

    <!-- Java comments, import order and style of the files should be generated by OpenApi Tools. -->
    <suppress checks="ConstantName"
              files="examples/openapi-tools/"/>
    <suppress checks="ImportOrder"
              files="examples/openapi-tools/"/>
    <suppress checks="JavadocMethod"
              files="examples/openapi-tools/"/>
    <suppress checks="JavadocStyle"
              files="examples/openapi-tools/"/>
    <suppress checks="JavadocVariable"
              files="examples/openapi-tools/"/>
    <suppress checks="RegexpSinglelineJava"
              files="examples/openapi-tools/"/>
    <suppress checks="MissingJavadocMethod"
              files="examples/openapi-tools/"/>
    <suppress checks="MissingJavadocType"
              files="examples/openapi-tools/"/>
    <suppress checks="NewlineAtEndOfFile"
              files="examples/openapi-tools/"/>
    <suppress checks="HideUtilityClassConstructor"
              files="examples/openapi-tools/"/>

</suppressions>