IntelliJ Platform SDK DevGuide

Edit page

Setting Up a Development Environment

Preliminary Steps

Use the following checklist to ensure that you are ready to develop your custom plugins.

  • Get IntelliJ IDEA CE source code on your local computer. Getting IntelliJ IDEA CE source code is not a requirement for plugin development, but having it makes debugging your plugins much easier. For detailed instructions refer to the Getting IntelliJ IDEA Community Edition Source Code section of Check Out And Build Community Edition. Note that building IntelliJ IDEA CE from source code is not required for plugin development.
  • Plugin DevKit plugin must be enabled in IntelliJ IDEA
  • IntelliJ Platform SDK must be configured for your IDEA project. For more information, see below.

Configuring IntelliJ Platform SDK

To set up your plugin development environment:

  • Create a new IntelliJ Platform SDK under File | Project Structure:

    Create IntelliJ Platform SDK

  • Specify the installation folder of IntelliJ IDEA Community Edition as the home directory.

    Set Home Directory

  • Select the IDEA jdk as the default Java SDK. See the IntelliJ Build Configuration section of Check Out And Build Community Edition for instructions about creating the IDEA jdk.

    Set IDEA JDK

  • In the Sourcepath tab of the SDK settings, click the Add button:

    Add Sourcepath

  • Specify the source code directory for the IntelliJ IDEA Community Edition:

    Specify Source Paths

  • Select File | New | Module and choose the IntelliJ Platform Plugin module type

    IntelliJ Platform Plugin Module

  • Enter your desired plugin name.

  • Go to File | Project Structure and select the newly created IntelliJ Platform SDK as the default SDK for the plugin module:

    Set Plugin Module SDK

Last modified: 9 July 2018