Page History

IntelliJ is popular and widely used by Beam developers, particularly for Java. If you're choosing a Java IDE, IntelliJ is a good choice.

These are best-effort community-contributed tips, and are not guaranteed to work with any particular IntelliJ setup.

Create a working Gradle module

(as of IntelliJ 2018.1.6)

1. Create an empty IntelliJ project outside of the Beam source tree.
2. Under File > Project Structure > Project, select a Project SDK.
3. Under File > Project Structure > Modules, click the + sign to add a module and select “Import Module”.
   1. Select the directory containing the Beam source tree.
   2. Tick the “Import module from external model” button and select Gradle from the list.
   3. Tick the following boxes.
      • Create separate module per source set
      • Use default gradle wrapper
4. Delegate build actions to Gradle by going to FIle > Settings/Preferences > Build, Execution, Deployment > Build Tools > Gradle > Runner and checking “Delegate IDE build/run actions to gradle”.

This should result in a working Gradle project. Build the project by executing the “build” task in the root Gradle module.

Checkstyle

IntelliJ supports checkstyle within the IDE using the Checkstyle-IDEA plugin.

Note: Older versions of IntelliJ may not support the Checkstyle file used by Beam.

1. Install the “Checkstyle-IDEA” plugin from the IntelliJ plugin repository
2. Configure the plugin by going to Settings -> Other Settings -> Checkstyle
3. Set Checkstyle version to the same as in /build_rules.gradle (e.g. 8.7)
4. Set the “Scan Scope” to “Only Java sources (including tests)”
5. In the “Configuration File” pane, add a new configuration using the plus icon:
   1. Set the “Description” to “Beam”
   2. Select “Use a local Checkstyle file”, and point it to sdks/java/build-tools/src/main/resources/beam/checkstyle.xml within your repository
   3. Check the box for “Store relative to project location”, and click “Next”
   4. Configure the checkstyle.suppressions.file property value to suppressions.xml, and click “Next”, then “Finish”
6. Select “Beam” as the only active configuration file, and click “Apply” and “OK”
7. Checkstyle will now give warnings in the editor for any Checkstyle violations

You can also scan an entire module by opening the Checkstyle tools window and clicking the “Check Module” button. The scan should report no errors.

Note: Selecting “Check Project” may report some errors from the archetype modules as they are not configured for Checkstyle validation.

Code Style

Uniform formatting for Java and Groovy code is automated by the build through the Spotless Gradle plugin. Instead of relying on the IDE, now you can run ./gradlew spotlessApply to reformat changes prior to commit.

You can find documentation on various developer workflows in the sub-pages.

If you're setting up a brand new development environment, start with Set up IntelliJ from scratch.

If you're having a specific IntelliJ issue, be sure to check the FAQ.

If you can't find the documentation you need, please let us know!

Note: this documentation needs improvement, and you can help out! See: