Skip to content

feat: add docs for linter setup #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 13, 2022
Merged

feat: add docs for linter setup #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/assets/checkstyle-intellij.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 15 additions & 0 deletions docs/linter-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.