Skip to content

Commit 23c2fd0

Browse files
committed
[FLINK-34893] Bump checkstyle to 9.3
1 parent cfcf0ac commit 23c2fd0

File tree

4 files changed

+7
-13
lines changed

4 files changed

+7
-13
lines changed

docs/content.zh/docs/flinkDev/ide_setup.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ IntelliJ 使用 Checkstyle-IDEA 插件在 IDE 中支持 checkstyle。
103103
1. 从 IntelliJ 插件存储库中安装 "Checkstyle-IDEA" 插件。
104104
2. 通过 Settings → Tools → Checkstyle 配置插件。
105105
3. 将 "Scan Scope" 设置为仅 Java 源(包括测试)。
106-
4. 在 "Checkstyle Version" 下拉菜单中选择 _8.14_ 版本,然后单击 "apply"。**此步骤很重要,请勿跳过!**
106+
4. 在 "Checkstyle Version" 下拉菜单中选择 _9.3_ 版本,然后单击 "apply"。**此步骤很重要,请勿跳过!**
107107
5. 在 "Configuration File" 窗格中,点击 "+" 图标添加新配置:
108108
1. 将 "Description" 设置为 Flink。
109109
2. 选择 "Use a local Checkstyle file" ,然后将其指向你存储库中 `"tools/maven/checkstyle.xml"` 文件。

docs/content/docs/flinkDev/ide_setup.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ any of these modules.
169169

170170
1. Go to "Settings" → "Tools" → "Checkstyle".
171171
2. Set "Scan Scope" to "Only Java sources (including tests)".
172-
3. For "Checkstyle Version" select "8.14".
172+
3. For "Checkstyle Version" select "9.3".
173173
4. Under "Configuration File" click the "+" icon to add a new configuration.
174174
5. Set "Description" to "Flink".
175175
6. Select "Use a local Checkstyle file" and point it to `tools/maven/checkstyle.xml` located within

pom.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ under the License.
175175
<orc.version>1.5.6</orc.version>
176176
<japicmp.referenceVersion>1.18.0</japicmp.referenceVersion>
177177
<japicmp.outputDir>tools/japicmp-output</japicmp.outputDir>
178-
<checkstyle.version>8.14</checkstyle.version>
178+
<checkstyle.version>9.3</checkstyle.version>
179179
<!-- can be removed with maven-spotless-plugin:2.38+ -->
180180
<spotless.skip>false</spotless.skip>
181181
<spotless.version>2.27.1</spotless.version>
@@ -2170,7 +2170,7 @@ under the License.
21702170
<plugin>
21712171
<groupId>org.apache.maven.plugins</groupId>
21722172
<artifactId>maven-checkstyle-plugin</artifactId>
2173-
<version>3.1.2</version>
2173+
<version>3.3.1</version>
21742174
<dependencies>
21752175
<dependency>
21762176
<groupId>com.puppycrawl.tools</groupId>

tools/maven/checkstyle.xml

+3-9
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ This file is based on the checkstyle file of Apache Beam.
208208

209209
<module name="RedundantModifier">
210210
<!-- Checks for redundant modifiers on various symbol definitions.
211-
See: http://checkstyle.sourceforge.net/config_modifier.html#RedundantModifier
211+
See: https://checkstyle.sourceforge.io/checks/modifier/redundantmodifier.html#RedundantModifier
212212
213213
We exclude METHOD_DEF to allow final methods in final classes to make them more future-proof.
214214
-->
@@ -236,18 +236,12 @@ This file is based on the checkstyle file of Apache Beam.
236236
-->
237237

238238
<!-- Checks for Javadoc comments. -->
239-
<!-- See http://checkstyle.sf.net/config_javadoc.html -->
239+
<!-- See https://checkstyle.sourceforge.io/checks/javadoc/javadocmethod.html -->
240240
<module name="JavadocMethod">
241-
<property name="scope" value="protected"/>
241+
<property name="accessModifiers" value="protected"/>
242242
<property name="severity" value="error"/>
243-
<property name="allowMissingJavadoc" value="true"/>
244243
<property name="allowMissingParamTags" value="true"/>
245244
<property name="allowMissingReturnTag" value="true"/>
246-
<property name="allowMissingThrowsTags" value="true"/>
247-
<property name="allowThrowsTagsForSubclasses" value="true"/>
248-
<property name="allowUndeclaredRTE" value="true"/>
249-
<!-- This check sometimes failed for with "Unable to get class information for @throws tag" for custom exceptions -->
250-
<property name="suppressLoadErrors" value="true"/>
251245
</module>
252246

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

0 commit comments

Comments
 (0)