Skip to content

Commit 0a01399

Browse files
authored
[docs] Update checkstyle plugin version and docs (alibaba#237)
1 parent 665e49e commit 0a01399

File tree

3 files changed

+11
-15
lines changed

3 files changed

+11
-15
lines changed

pom.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -884,13 +884,13 @@
884884
<plugin>
885885
<groupId>org.apache.maven.plugins</groupId>
886886
<artifactId>maven-checkstyle-plugin</artifactId>
887-
<version>3.1.2</version>
887+
<version>3.6.0</version>
888888
<dependencies>
889889
<dependency>
890890
<groupId>com.puppycrawl.tools</groupId>
891891
<artifactId>checkstyle</artifactId>
892892
<!-- Note: match version with docs/dev/ide-setup.md -->
893-
<version>8.14</version>
893+
<version>9.3</version>
894894
</dependency>
895895
</dependencies>
896896
<executions>

tools/maven/checkstyle.xml

+8-12
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
limitations under the License.
1616
-->
1717
<!DOCTYPE module PUBLIC
18-
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
19-
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
18+
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
19+
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
2020

2121
<!--
2222
This is a checkstyle configuration file. For descriptions of
@@ -28,10 +28,6 @@ This file is based on the checkstyle file of Apache Beam.
2828

2929
<module name="Checker">
3030

31-
<module name="NewlineAtEndOfFile">
32-
<!-- windows can use \r\n vs \n, so enforce the most used one ie UNIx style -->
33-
<property name="lineSeparator" value="lf"/>
34-
</module>
3531

3632
<module name="RegexpSingleline">
3733
<!-- 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.
264260
<!-- Checks for Javadoc comments. -->
265261
<!-- See http://checkstyle.sf.net/config_javadoc.html -->
266262
<module name="JavadocMethod">
267-
<property name="scope" value="protected"/>
263+
<property name="accessModifiers" value="protected"/>
268264
<property name="severity" value="error"/>
269-
<property name="allowMissingJavadoc" value="true"/>
265+
<!-- <property name="allowMissingJavadoc" value="true"/>-->
270266
<property name="allowMissingParamTags" value="true"/>
271267
<property name="allowMissingReturnTag" value="true"/>
272-
<property name="allowMissingThrowsTags" value="true"/>
273-
<property name="allowThrowsTagsForSubclasses" value="true"/>
274-
<property name="allowUndeclaredRTE" value="true"/>
268+
<!-- <property name="allowMissingThrowsTags" value="true"/>-->
269+
<!-- <property name="allowThrowsTagsForSubclasses" value="true"/>-->
270+
<!-- <property name="allowUndeclaredRTE" value="true"/>-->
275271
<!-- This check sometimes failed for with "Unable to get class information for @throws tag" for custom exceptions -->
276-
<property name="suppressLoadErrors" value="true"/>
272+
<!-- <property name="suppressLoadErrors" value="true"/>-->
277273
</module>
278274

279275
<!-- Check that paragraph tags are used correctly in Javadoc. -->

website/docs/dev/ide-setup.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ You can also format the whole project via Maven by using `mvn spotless:apply`.
119119

120120
1. Go to "Settings" → "Tools" → "Checkstyle".
121121
2. Set "Scan Scope" to "Only Java sources (including tests)".
122-
3. For "Checkstyle Version" select "10.18.2".
122+
3. For "Checkstyle Version" select "9.3".
123123
4. Under "Configuration File" click the "+" icon to add a new configuration.
124124
5. Set "Description" to "Fluss".
125125
6. Select "Use a local Checkstyle file" and point it to `tools/maven/checkstyle.xml` located within

0 commit comments

Comments
 (0)