diff --git a/docs/assets/checkstyle-intellij.png b/docs/assets/checkstyle-intellij.png new file mode 100644 index 00000000..5cb89b89 Binary files /dev/null and b/docs/assets/checkstyle-intellij.png differ diff --git a/docs/linter-setup.md b/docs/linter-setup.md new file mode 100644 index 00000000..9215de3b --- /dev/null +++ b/docs/linter-setup.md @@ -0,0 +1,15 @@ +## How to setup checkstyle in IntelliJ + +1. Install Checkstyle-IDEA plugin + +Go to Settings -> Plugins and look for Checkstyle-IDEA + +2. Add our custom configuration file + +Go to Settings -> Tools -> Checkstyle and add our configuration file located under `/config/chceckstyle/checkstyle.xml`. + +![Checkstyle IntelliJ](assets/checkstyle-intellij.png) + +3. Now you can generate report running `./gradlew check` in project root dir + +4. You can auto-fix the code by using `ctrl+alt+L` shortcut (IntelliJ) or by pressing `ctrl+shift+a` and looking for `Reformat code` option.