26 12. IDE instructions

Ilkka Seppälä edited this page 2024-03-30 10:55:08 +02:00

Table of Contents

• Get the code
• IntelliJ IDEA
• Checkstyle
• SonarLint

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
  • Check "Bind project to SonarCloud / SonarQube"
  • Configure the connection - Click + icon - Select SonarCloud - Enter token: c9e61f6ba34e72faba39c554b984b49712743846
  • Now you should be able to run Sonar scans using the same settings as the SonarCloud project uses (https://sonarcloud.io/project/overview?id=iluwatar_java-design-patterns)

Home

01. How to contribute

03. Coding conventions

05. Collaboration

06. Working with issues

07. Categories and Tags

08. Reviewing pull requests

09. Team

10. Technology selections & decisions

11. Static analysis

12. IDE instructions

13. Roadmap

15. Support for multiple languages

17. Recognizing contributors

21. New Pattern Template