From e26518b9fa81b9a17170b30b1494e91aa31f764e Mon Sep 17 00:00:00 2001 From: Tadaya Tsuyukubo Date: Tue, 15 Feb 2022 23:30:15 -0800 Subject: [PATCH] Document how to set up Checkstyle-IDEA plugin See gh-318 Signed-off-by: Tadaya Tsuyukubo --- README.adoc | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.adoc b/README.adoc index 9bf71c62..89d7f401 100644 --- a/README.adoc +++ b/README.adoc @@ -240,6 +240,29 @@ The plugin is automatically enabled when one or more of the following conditions * For maven based project, `spring-javaformat-maven-plugin` plugin is defined in `pom.xml` * For gradle based project, `io.spring.javaformat` plugin is applied +==== IntelliJ IDEA CheckStyle-IDEA plugin +The https://plugins.jetbrains.com/plugin/1065-checkstyle-idea[CheckStyle-IDEA plugin] provides checkstyle integration to the IntelliJ IDEA. + +To configure the plugin, first you need to create your own checkstyle configuration file. + +[source,xml,indent=0] +---- + + + + + +---- + +Once configuration file is created: + +* Open `Preferences` - `Tools` - `Checkstyle` +* Add `spring-javaformat-checkstyle-[VERSION].jar` and `spring-javaformat-config-[VERSION].jar` to the `Third-Party Checks` +* Specify appropriate `Checkstyle version` +* Add your checkstyle configuration file. + === About the Conventions