1
0

IntelliJ の CheckStyle-IDEA Plugin で、Checkstyle v8 系の対応が削除されました

Last updated at Posted at 2024-03-13

IntelliJ の CheckStyle-IDEA Plugin ですが、 2024/03/10 にリリースされた v5.88.0 で Checkstyle v8 系の対応が削除されました。

5.88.0: Breaking: Drop support for Checkstyle 8, to reduce archive size.
Release 5.88.0 · jshiell/checkstyle-idea

checkstyle.png

現在、設定で選べる Checkstyle のバージョンが v9.0.1 〜 v10.14.0 になっています。
ただ、Checkstyle はプロパティの入れ替えが結構多いので、バージョンが変わるとこんなエラーが出たりします。

Checkstyle-Plugin: cannot initialize module TreeWalker - cannot initialize module JavadocMethod - Property 'allowUndeclaredRTE' does not exist, please check the documentation
Checkstyle-Plugin: cannot initialize module TreeWalker - cannot initialize module JavadocMethod - Property 'scope' does not exist, please check the documentation

そのため、エラーメッセージをもとに checkstyle.xml の設定を修正する必要があります。

 <module name="JavadocMethod">
-    <property name="scope" value="public"/>
+    <property name="accessModifiers" value="public"/>
 </module>

もしくは、最新の google_checks.xml を持ってきてもいいかもしれません。

ただ、困ったことにIntelliJ でエラーが出ないように checkstyle.xml を直すと、今度は Gradle でエラーになります。
これは Gradle の Checkstyle Plugin が使うバージョンは v8.3.7 になっているためです。

そのため、IntelliJ で設定したのと同じバージョンの Checkstyle が使われるように build.gradle に設定を追加する必要があります。

checkstyle {
    toolVersion = '9.0.1'
}

参考

1
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
1
0