Skip to content

12. IDE instructions

Ilkka Seppälä edited this page Mar 30, 2024 · 26 revisions

Get the code

  • Clone the project git clone https://github.com/iluwatar/java-design-patterns.git

IntelliJ IDEA

  • Download IntelliJ IDEA from https://www.jetbrains.com/idea/download/
  • Import project - point to project root pom.xml
  • There is .editorconfig at the root of the repository and it should be applied automatically.
  • Enable annotation processing File - Settings - Build, Execution, Deployment - Compiler - Annotation Processors - Enable annotation processing (Lombok needs this)

Checkstyle

  • We use Checkstyle to enforce code style
  • Install Checkstyle plugin File - Settings - Plugins - CheckStyle-IDEA
  • You can run Checkstyle checks by activating the Checkstyle view with View - Tool windows - Checkstyle and clicking Check project. Ensure that Google Checks ruleset is activated. (command line: ./mvnw validate)

SonarLint

  • We use SonarCloud for static analysis
  • The same scans can be executed on the local machine using SonarLint plugin
  • Install SonarLint plugin: File - Settings - Plugins - SonarLint
  • View - Tool Windows - SonarLint
  • Configure SonarLint