DEVELOPING.md

Developing

Software Requirements

You should have the following things installed:

• Git
• Java 25 - should be as unmodified as possible (Recommended: Eclipse Adoptium)
• Gradle (shipped inside the repo as Gradle Wrapper - also available inside IntelliJ)

Recommended setup

• Install IntelliJ
  • Recommended setup actions
    • Disable not needed plugins
    • Disable telemetry
    • Configure the available memory
  • Import the project
  • You will get prompted to install the required plugins
  • Ensure that everything is encoded in UTF-8
  • Ensure that the JDK/Java-Version is correct

Development environment

See also JetBrains Docs for developing IntelliJ Plugins

The plugin is built with gradle, but you don't need to install it if you build with the IntelliJ gradle plugin (check out the prerequisites). If you don't intend to use the IntelliJ gradle plugin, you can use native gradle (replace ./gradlew by gradle).

Start idea and import the build.gradle file with "File > Open". Then in the "Import Project from Gradle" window, make sure you check "Use gradle 'wrapper' task configuration" before clicking "Finish". You now have a gradle wrapper installed (gradlew) that you can use on the command line to generate idea folders:

# Initialize idea folders
./gradlew cleanIdea idea

IntelliJ should refresh and the project is now configured as a gradle project. You can find IntelliJ gradle tasks in "Gradle > Gradle projects > intellij-plugin-save-actions > Tasks > intellij". To run the plugin, use the runIde task:

# Run the plugin (starts new idea)
./gradlew runIde

Releasing

Before releasing:

• Consider doing a test-deployment before actually releasing.
• Check the changelog

If the develop is ready for release, create a pull request to the master-Branch and merge the changes

When the release is finished do the following:

• Merge the auto-generated PR (with the incremented version number) back into the develop