intellij-sdk-code-samples/tutorials/build_system/gradle_guide.md

title
Configuring Gradle for IntelliJ Platform Plugins

This page serves as a guide to Gradle-based plugin configuration for IntelliJ Platform projects. The IntelliJ IDEA Ultimate and Community editions bundle the Gradle and Plugin DevKit plugins to support Gradle-based development. The Getting Started with Gradle page provides a tutorial for creating Gradle-based IntelliJ Platform plugins. It may be useful to review the IntelliJ Platform page, particularly the description of versioning in the Open Source section.

• bullet list {:toc}

Overview of the IntelliJ IDEA Gradle Plugin

The IntelliJ IDEA Gradle plugin is built from the open-source project gradle-intellij-plugin. The plugin adds Gradle tasks for the build.gradle file that enable developing IntelliJ Platform plugins. The README file for the gradle-intellij-plugin project is the reference for configuring these tasks.

When getting started, there are several items to note on the README page:

• At the top of the page, the latest production version (e.g. 0.4.8) of the IntelliJ IDEA Gradle plugin is listed.
• Also at the top is the minimum version of Gradle required to support the IntelliJ IDEA Gradle plugin.
• The table of extended Gradle Tasks has a succinct description for each task added by the plugin. This documentation will focus on the configuration and use four of those tasks:
  • Setup DSL - intellij { ... }.
  • Running DSL - runIde { ... }
  • Patching DSL - patchPluginXml { ... }
  • Publishing DSL - publishPlugin { ... }
• Examples are always a helpful resource, and at the bottom of the page are links to example open source IntelliJ Platform plugin projects based on Gradle.
• Almost every Gradle plugin attribute has a default value that will work to get started on a Gradle-based IntelliJ Platform plugin project.

Guide to Configuring Gradle Plugin Functionality

This section presents a guided tour of Gradle plugin attributes to achieve commonly desired functionality.

Configuring the Gradle Plugin for Building IntelliJ Platform Plugin Projects

By default, the Gradle plugin will build a plugin project against the IntelliJ Platform defined by the latest EAP snapshot of the IntelliJ IDEA Community Edition.

If a matching version of the specified IntelliJ Platform is not available on the local machine, the Gradle plugin downloads the correct version and type. IntelliJ IDEA then indexes the build and any associated source code and JetBrains Java Runtime.

IntelliJ Platform Configuration

Explicitly setting the Setup DSL attributes intellij.version and intellij.type tells the Gradle plugin to use that configuration of the IntelliJ Platform to build the plugin project. If a local installation of IntelliJ IDEA is the desired type and version of the IntelliJ Platform, use intellij.localPath to point to that installation. If the intellij.localPath attribute is set, do not set the intellij.version and intellij.type attributes as this could result in undefined behavior.

Plugin Dependencies

IntelliJ Platform plugin projects may depend on either bundled or third-party plugins. In that case, a project should build against a version of those plugins that match the IntelliJ Platform version used to build the plugin project. The Gradle plugin will fetch any plugins in the list defined by intellij.plugins. See the Gradle plugin README for information about specifying the plugin and version.

Note that this attribute describes a dependency so the Gradle plugin can fetch the required artifacts. The IntelliJ Platform plugin project is still required to declare these dependencies in its Plugin Configuration (plugin.xml) file.

Configuring the Gradle Plugin for Running IntelliJ Platform Plugin Projects

By default, the Gradle plugin will use the same version of the IntelliJ Platform for the IDE Development Instance as was used for building the plugin. Using the corresponding JetBrains Runtime is also the default, so for this use case no further configuration is required.

Running Against Alternate Versions and Types of IntelliJ Platform-Based IDEs

The IntelliJ Platform IDE used for the Development Instance can be different from that used to build the plugin project. Setting the Running DSL attribute runIde.ideaDirectory will define an IDE to be used for the Development Instance in that single runIde task. This attribute is commonly used when running or debugging a plugin in an alternate IntelliJ Platform-based IDE.

Running Against Alternate Versions of the JetBrains Runtime

Every version of the IntelliJ Platform has a corresponding version of the JetBrains Runtime. A different version of the runtime can be used by specifying the runIde.jbrVersion attribute, describing a version of the JetBrains Runtime that should be used by the IDE Development Instance. The Gradle plugin will fetch the specified JetBrains Runtime as needed.

Managing Directories used by the Gradle Plugin

There are several attributes to control where the Gradle plugin places directories for downloads and for use by the IDE Development Instance.

The location of the sandbox home directory and its subdirectories can be controlled with Gradle plugin attributes. The intellij.sandboxDirectory attribute is used to set the path for the sandbox directory to be used while running the plugin in an IDE Development Instance. Locations of the sandbox subdirectories can be controlled using the runIde.configDirectory, runIde.pluginsDirectory, and runIde.systemDirectory attributes. If the intellij.sandboxDirectory path is explicitly set, the subdirectory attributes default to the new sandbox directory.

The storage location of downloaded IDE versions and components defaults to the Gradle cache directory. However, it can be controlled by setting the intellij.ideaDependencyCachePath attribute.

Controlling Downloads by the Gradle Plugin

As mentioned in the section about configuring the intellij platform used for building plugin projects, the Gradle plugin will fetch the version of the IntelliJ Platform specified by the default or by the intellij attributes. Standardizing the versions of the Gradle plugin and Gradle system across projects will minimize the time spent downloading versions. There are controls for managing the IntelliJ IDEA Gradle plugin version, and the version of Gradle itself. The Gradle plugin version is defined in the plugins {} section of a project's build.gradle file. The Gradle version is in defined in a project's gradle-wrapper.properties.

Patching the Plugin Configuration File

A plugin project's plugin.xml file has element values that are "patched" at build time from the attributes of the patchPluginXml (Patching DSL) task. As many as possible of the attributes in the Patching DSL will be substituted into the corresponding element values in a plugin project's plugin.xml file:

• If a patchPluginXml attribute default value is defined, the attribute value will be patched in plugin.xml regardless of whether the patchPluginXml task appears in the build.gradle file.
  • For example, the default values for the attributes patchPluginXml.sinceBuild and patchPluginXml.untilBuild are defined based on the declared (or default) value of intellij.version. So by default patchPluginXml.sinceBuild and patchPluginXml.untilBuild are substituted into the <idea-version> element's since-build and until-build attributes in the plugin.xml file.
• If a patchPluginXml attribute value is explicitly defined, the attribute value will be substituted in plugin.xml.
  • If both patchPluginXml.sinceBuild and patchPluginXml.untilBuild attributes are explicitly set, both are substituted in plugin.xml.
  • If one attribute is explicitly set (e.g. patchPluginXml.sinceBuild) and one is not (e.g. patchPluginXml.untilBuild has default value,) both attributes are patched at their respective (explicit and default) values.

A best practice to avoid confusion is to replace the elements in plugin.xml that will be patched by the Gradle plugin with a comment. That way the values for these parameters do not appear in two places in the source code. The Gradle plugin will add the necessary elements as part of the patching process. For those patchPluginXml attributes that contain descriptions such as changeNotes and pluginDescription, a CDATA block is not necessary when using HTML elements.

As discussed in Components of a Wizard-Generated Gradle IntelliJ Platform Plugin, the Gradle properties project.version, project.group, and rootProject.name are all generated based on the input to the Wizard. However, the IntelliJ IDEA Gradle plugin does not combine and substitute those Gradle properties for the default <id> and <name> elements in the plugin.xml file.

Publishing with the Gradle Plugin

Please review the Publishing Plugins with Gradle page before using the Publishing DSL attributes. That documentation explains three different ways to use Gradle for plugin uploads without exposing account credentials.

Common Gradle Plugin Configurations for Development

Different combinations of Gradle plugin attributes are needed to create the desired build or IDE Development Instance environment. This section reviews some of the more common configurations.

Plugins Targeting IntelliJ IDEA

IntelliJ Platform plugins targeting IntelliJ IDEA have the most straightforward Gradle plugin configuration.

• Determine the version of IntelliJ IDEA to use for building the plugin project; this is the desired version of the IntelliJ Platform. This can be EAP (default) or determined from the build number ranges.
  • If a production version of IntelliJ IDEA is the desired target, set the intellij version attributes accordingly.
  • Set the necessary plugin dependencies, if any.
• If the plugin project should be run or debugged in an IDE Development Instance based on the same IntelliJ IDEA version, no further attributes need to be set for the IDE Development Instance. This is the default behavior and is the most common use case.
  • If the plugin project should be run or debugged in an IDE Development Instance based on a different version or type of IntelliJ IDEA, set the Running or Setup DSL attributes accordingly. For projects with only one runIde task, use the Running DSL attribute runIde.ideaDirectory.
  • If the plugin project should be run using a JetBrains Runtime other than the default for the IDE Development Instance, specify the JetBrains Runtime version.
• Set the appropriate attributes for patching the plugin.xml file.

Plugins Targeting Alternate IntelliJ Platform-Based IDEs

The Gradle plugin can also be configured for developing plugins to run in IDEs that are based on the IntelliJ Platform but are not IntelliJ IDEA. This example focuses on the details of developing a plugin for PhpStorm. It will be helpful to review the PhpStorm Plugin Development section.

• The Gradle plugin attributes describing the configuration of the IntelliJ Platform used to build the plugin project must be explicitly set. The type will be "IC" because the IntelliJ Platform is defined by the IntelliJ IDEA Community Edition. The BRANCH.BUILD number of the IntelliJ Platform (IntelliJ IDEA CE) is the same as for the PhpStorm target. Although the FIX (tertiary) number may differ between the same versions of the applications, it won't affect the match of the IntelliJ Platform.
• All PhpStorm plugin projects have a dependency on the PhpStorm OpenAPI Library. Any plugin targeting PhpStorm must list a dependency on the PHP plugin, and its version must be compatible with the target version of PhpStorm. The plugin dependency must be declared using the Gradle plugin intellij.plugins attribute, which lists the id and version of the plugin dependency.
• The best practice is to use the target version of PhpStorm as the IDE Development Instance. That enables running and debugging the plugin in the target (e.g., PhpStorm) application. The choice of application to use for the IDE Development Instance is configured using the Gradle plugin attribute intellij.alternativeIdePath.

The snippet below is an example of configuring the Setup and Running DSLs in a build.gradle file to develop a plugin targeted at PhpStorm. The configuration uses IntelliJ IDEA Community Edition v2019.1.2 (build 191.7141.44) as the IntelliJ Platform against which the plugin project is built. It uses PhpStorm v2019.1.2 (build 191.7141.52) as the IDE Development Instance in which the plugin project is run and debugged.

  intellij {
    // Define IntelliJ Platform against which to build the plugin project.
    version '191.7141.44'  // Same version (2019.1.2) as target PhpStorm   
    type 'IC'              // Use IntelliJ IDEA CE as basis of IntelliJ Platform   
    // Require the Php plugin, must be compatible with target v2019.1.2
    plugins 'com.jetbrains.php:191.6707.66'     
  }
  
  runIde {
      // Path to installed v2019.1.2 PhpStorm to use as IDE Development Instance
      ideaDirectory '/Applications/apps/PhpStorm/ch-0/191.7141.52/PhpStorm.app/Contents'
  }