intellij-setup.md

IntelliJ Setup

Tasks to be performed

• open the TripleA project from source code
• install plugins, configure associated settings
• download and import IDEA settings file

Approximate time to complete: 10 - 30 minutes

Open Project

• In IDEA, File > Open and select the build.gradle file that is located at the top level of the project. (Tip by selecting gradle file, IDEA will preconfigure the project as a gradle project)

Plugins:

Note: Settings menu is accessible via, File > Settings or (on Mac OS): IntelliJ IDEA > Preferences

Plugin installation can be initiated from the JetBrains Marketplace web page, by clicking "Install to IDE" link from each plugin's page.

1. Google Java Format plugin
   1. Settings > google-java-format Settings*
   2. Check 'enable'
2. checkstyle-IDEA plugin
   1. after install finish configuration in: Other Settings > Checkstyle
      1. load checkstyle file by clicking on the "plus" and navigating to the file .\IdeaProjects\triplea\config\checkstyle (If you can't find it, you can download it from the repository)
      2. set checkstyle version
      3. set to scan all sources
3. Lombok
   1. Settings > Annotation Processors
   2. Turn on annotation processing.
4. PlantUML Integration
   1. GraphViz also needs to be installed: https://graphviz.org/download/

Google Java Format Plugin Fix

Find your IDEA vmoptions file with: find ~ -name "*vmoptions" (eg: ./.config/JetBrains/IntelliJIdea2022.3/idea64.vmoptions)

Add the following to your vmoptions file:

--add-opens=java.base/java.lang=ALL-UNNAMED
--add-opens=java.base/java.util=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED