[docs] Update checkstyle plugin version and docs (#237)

alibaba · Dec 20, 2024 · 0a01399 · 0a01399
1 parent 665e49e
commit 0a01399
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 15 deletions.
diff --git a/pom.xml b/pom.xml
@@ -884,13 +884,13 @@
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-checkstyle-plugin</artifactId>
-                    <version>3.1.2</version>
+                    <version>3.6.0</version>
                     <dependencies>
                         <dependency>
                             <groupId>com.puppycrawl.tools</groupId>
                             <artifactId>checkstyle</artifactId>
                             <!-- Note: match version with docs/dev/ide-setup.md -->
-                            <version>8.14</version>
+                            <version>9.3</version>
                         </dependency>
                     </dependencies>
                     <executions>

diff --git a/tools/maven/checkstyle.xml b/tools/maven/checkstyle.xml
@@ -15,8 +15,8 @@
  limitations under the License.
 -->
 <!DOCTYPE module PUBLIC
-    "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
-    "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
+        "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
+        "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
 
 <!--
 This is a checkstyle configuration file. For descriptions of
@@ -28,10 +28,6 @@ This file is based on the checkstyle file of Apache Beam.
 
 <module name="Checker">
 
-    <module name="NewlineAtEndOfFile">
-        <!-- windows can use \r\n vs \n, so enforce the most used one ie UNIx style -->
-        <property name="lineSeparator" value="lf"/>
-    </module>
 
     <module name="RegexpSingleline">
         <!-- Checks that TODOs don't have stuff in parenthesis, e.g., username. -->
@@ -264,16 +260,16 @@ This file is based on the checkstyle file of Apache Beam.
         <!-- Checks for Javadoc comments.                     -->
         <!-- See http://checkstyle.sf.net/config_javadoc.html -->
         <module name="JavadocMethod">
-            <property name="scope" value="protected"/>
+            <property name="accessModifiers" value="protected"/>
             <property name="severity" value="error"/>
-            <property name="allowMissingJavadoc" value="true"/>
+            <!--            <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"/>
+            <!--            <property name="allowMissingThrowsTags" value="true"/>-->
+            <!--            <property name="allowThrowsTagsForSubclasses" value="true"/>-->
+            <!--            <property name="allowUndeclaredRTE" value="true"/>-->
             <!-- This check sometimes failed for with "Unable to get class information for @throws tag" for custom exceptions -->
-            <property name="suppressLoadErrors" value="true"/>
+            <!--            <property name="suppressLoadErrors" value="true"/>-->
         </module>
 
         <!-- Check that paragraph tags are used correctly in Javadoc. -->

diff --git a/website/docs/dev/ide-setup.md b/website/docs/dev/ide-setup.md
@@ -119,7 +119,7 @@ You can also format the whole project via Maven by using `mvn spotless:apply`.
 
 1. Go to "Settings" → "Tools" → "Checkstyle".
 2. Set "Scan Scope" to "Only Java sources (including tests)".
-3. For "Checkstyle Version" select "10.18.2".
+3. For "Checkstyle Version" select "9.3".
 4. Under "Configuration File" click the "+" icon to add a new configuration.
 5. Set "Description" to "Fluss".
 6. Select "Use a local Checkstyle file" and point it to `tools/maven/checkstyle.xml` located within