From 26e4996d9cf83d62c09874927b7a6847c7e88445 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Alexander=20Preu=C3=9F?= <alexander.preuss@streamnative.io>
Date: Thu, 20 Oct 2022 15:24:01 +0200
Subject: [PATCH] [misc] Bump checkstyle version to 8.29 Also bumps
 checkstyle-maven-plugin version to 3.1.1

---
 pom.xml                       |  4 +--
 src/checkstyle/checkstyle.xml | 60 ++++++++++++++---------------------
 2 files changed, 26 insertions(+), 38 deletions(-)

diff --git a/pom.xml b/pom.xml
index 49b3a9d..a109905 100644
--- a/pom.xml
+++ b/pom.xml
@@ -57,11 +57,11 @@
 
     <!-- build plugin dependencies -->
     <license.plugin.version>3.0</license.plugin.version>
-    <maven-checkstyle-plugin.version>3.0.0</maven-checkstyle-plugin.version>
+    <maven-checkstyle-plugin.version>3.1.1</maven-checkstyle-plugin.version>
     <maven-compiler-plugin.version>3.7.0</maven-compiler-plugin.version>
     <maven-surefire-plugin.version>2.21.0</maven-surefire-plugin.version>
     <nifi.nar.plugin.version>1.2.0</nifi.nar.plugin.version>
-    <puppycrawl.checkstyle.version>6.19</puppycrawl.checkstyle.version>
+    <puppycrawl.checkstyle.version>8.29</puppycrawl.checkstyle.version>
     <spotbugs-maven-plugin.version>3.1.8</spotbugs-maven-plugin.version>
   </properties>
 
diff --git a/src/checkstyle/checkstyle.xml b/src/checkstyle/checkstyle.xml
index 890a862..0bfb714 100644
--- a/src/checkstyle/checkstyle.xml
+++ b/src/checkstyle/checkstyle.xml
@@ -33,6 +33,21 @@ page at http://checkstyle.sourceforge.net/config.html -->
         <!-- Checks that there are no tab characters in the file. -->
     </module>
 
+    <module name="LineLength">
+        <!-- Checks if a line is too long. -->
+        <property name="max" value="120"/>
+        <property name="severity" value="error"/>
+
+        <!--
+          The default ignore pattern exempts the following elements:
+            - import statements
+            - long URLs inside comments
+        -->
+
+        <property name="ignorePattern"
+                  value="^(package .*;\s*)|(import .*;\s*)|( *\* .*https?://.*)$"/>
+    </module>
+
     <module name="RegexpSingleline">
         <!-- Checks that TODOs don't have stuff in parenthesis, e.g., username. -->
         <property name="format" value="((//.*)|(\*.*))TODO\(" />
@@ -57,16 +72,6 @@ page at http://checkstyle.sourceforge.net/config.html -->
         <property name="fileNamePattern" value=".*Tests\.java$" />
     </module>
 
-    <!-- Allow use of comment to suppress javadocstyle -->
-    <module name="SuppressionCommentFilter">
-        <property name="offCommentFormat" value="CHECKSTYLE.OFF\: ([\w\|]+)"/>
-        <property name="onCommentFormat" value="CHECKSTYLE.ON\: ([\w\|]+)"/>
-        <property name="checkFormat" value="$1"/>
-    </module>
-    <module name="SuppressionFilter">
-        <property name="file" value="${checkstyle.suppressions.file}" default="suppressions.xml" />
-    </module>
-
     <!-- Check that every module has a package-info.java -->
     <module name="JavadocPackage"/>
 
@@ -95,6 +100,7 @@ page at http://checkstyle.sourceforge.net/config.html -->
             <property name="severity" value="error"/>
             <!-- This ensures that static imports go first. -->
             <property name="option" value="top"/>
+            <property name="separatedStaticGroups" value="true" />
             <property name="sortStaticImportsAlphabetically" value="true"/>
             <property name="tokens" value="STATIC_IMPORT, IMPORT"/>
             <message key="import.ordering"
@@ -145,22 +151,22 @@ page at http://checkstyle.sourceforge.net/config.html -->
 
         -->
 
+        <!-- Allow use of comment to suppress javadocstyle -->
+        <module name="SuppressionCommentFilter">
+            <property name="offCommentFormat" value="CHECKSTYLE.OFF\: ([\w\|]+)"/>
+            <property name="onCommentFormat" value="CHECKSTYLE.ON\: ([\w\|]+)"/>
+            <property name="checkFormat" value="$1"/>
+        </module>
+
         <!-- Checks for Javadoc comments.                     -->
         <!-- See http://checkstyle.sf.net/config_javadoc.html -->
         <module name="JavadocMethod">
             <property name="scope" value="protected"/>
             <property name="severity" value="error"/>
-            <property name="allowMissingJavadoc" value="true"/>
             <property name="allowMissingParamTags" value="true"/>
             <property name="allowMissingReturnTag" value="true"/>
-            <property name="allowMissingThrowsTags" value="true"/>
-            <property name="allowThrowsTagsForSubclasses" value="true"/>
-            <property name="allowUndeclaredRTE" value="true"/>
         </module>
 
-        <!-- Check that paragraph tags are used correctly in Javadoc. -->
-        <module name="JavadocParagraph"/>
-
         <module name="JavadocType">
             <property name="scope" value="protected"/>
             <property name="severity" value="error"/>
@@ -279,25 +285,10 @@ page at http://checkstyle.sourceforge.net/config.html -->
 
         <!--
 
-        LENGTH and CODING CHECKS
+        CODING CHECKS
 
         -->
 
-        <module name="LineLength">
-            <!-- Checks if a line is too long. -->
-            <property name="max" value="120"/>
-            <property name="severity" value="error"/>
-
-            <!--
-              The default ignore pattern exempts the following elements:
-                - import statements
-                - long URLs inside comments
-            -->
-
-            <property name="ignorePattern"
-                      value="^(package .*;\s*)|(import .*;\s*)|( *\* .*https?://.*)$"/>
-        </module>
-
         <module name="LeftCurly">
             <!-- Checks for placement of the left curly brace ('{'). -->
             <property name="severity" value="error"/>
@@ -438,8 +429,5 @@ page at http://checkstyle.sourceforge.net/config.html -->
             <property name="severity" value="error"/>
         </module>
 
-        <!-- Required to support SuppressWarningsComment -->
-        <module name="FileContentsHolder"/>
-
     </module>
 </module>