Gradle IntelliJ Plugin (1.x) – FAQ

warning

Gradle Plugin

The Gradle plugin must be chosen depending on the target platform version.

2024.2+

Requires IntelliJ Platform Gradle Plugin (2.x)

2022.3+

Recommended IntelliJ Platform Gradle Plugin (2.x),
Requires Gradle IntelliJ Plugin (1.x) version 1.10.1+ (current: 1.17.4)

runIde task is a Java Exec task and can be modified according to the documentation.

To add some JVM arguments while launching the IDE, configure runIde task as follows:

tasks {
  runIde {
    jvmArgs("-DmyProperty=value")
  }
}

runIde {
  jvmArgs "-DmyProperty=value"
}

Using the very same task documentation, configure runIde task:

tasks {
  runIde {
    systemProperty("name", "value")
  }
}

runIde {
  systemProperty("name", "value")
}

See Enabling Auto-Reload for important caveats.

Configure runIde task as follows:

tasks {
  runIde {
    autoReloadPlugins.set(false)
  }
}

runIde {
  autoReloadPlugins = false
}

Building searchable options can be disabled as a task:

tasks {
  buildSearchableOptions {
    enabled = false
  }
}

buildSearchableOptions.enabled = false

As a result of disabling building searchable options, the Settings that your plugin provides won't be searchable in the Settings dialog. Disabling of the task is suggested for plugins that are not intended to provide custom settings.

The most convenient way to see the logs of running IDE is to add a tab to the Run tool window displaying the contents of idea.log file. In the Gradle runIde run configuration, add the log file path according to sandbox location as described in View logs.

prepareSandbox task is a Sync task and can be modified accordingly. Something like following should work:

tasks {
  prepareSandbox {
    from("yourFile") {
      into("${intellij.pluginName.get()}/lib/")
    }
  }
}

prepareSandbox {
  from("yourFile") {
    into "${intellij.pluginName.get()}/lib/"
  }
}

The setupDependencies task is designed to fetch the target IDE dependency from the IntelliJ Repository in the after-sync Gradle phase, but only when working inside IntelliJ IDEA – to make the IntelliJ SDK classes resolved and code completion available. To achieve that, the gradle-idea-ext-plugin is used, which alters the IDEA project's .idea/workspace.xml file making the setupDependencies task activated on after_sync event.

Unfortunately, this entry remains even after disabling the org.jetbrains.intellij plugin in a project – the setupDependencies task won't be resolved appropriately, which produces the following exception:

Task 'setupDependencies' not found in root project 'projectName'.

To fix that, manually edit the .idea/workspace.xml file removing mentioned entry, go to the Gradle tool window, select the Tasks Activation action from the context menu of the root project item, and remove it.

See the Bundling Plugin API Sources section for details.

With the 1.10.0 release, the runPluginVerifier task uses the XDG_CACHE_HOME environment variable (see XDG Base Directory for more details) to resolve the default directory for downloaded IDEs – instead of the user's home directory. We recommend moving your existing IDEs stored i.e., in ~/.pluginVerifier/ides/ directory into $XDG_CACHE_HOME$/pluginVerifier/ides to avoid downloading them once again.

In case you want to keep the downloaded archives in the previous location, specify the given path explicitly to the runPluginVerifier.downloadDir property:

tasks {
  runPluginVerifier {
    downloadDir.set(System.getProperty("user.home") + "/.pluginVerifier/ides")
  }
}

runPluginVerifier {
  downloadDir = System.getProperty("user.home") + "/.pluginVerifier/ides"
}

The Gradle IntelliJ Plugin, when targeting the IntelliJ SDK 2022.1+, uses the PathClassLoader class loader by the following system property:

-Djava.system.class.loader=com.intellij.util.lang.PathClassLoader

Because of that, JaCoCo – and other external tools that rely on classes available in the bootstrap class loader – fail to discover plugin classes.

In addition, if the code instrumentation is enabled (see intellij.instrumentCode), it's required to switch to the compiled and instrumented output instead of a default compiled classes.

The following changes to your Gradle configuration file:

tasks {
  withType<Test> {
    configure<JacocoTaskExtension> {
      isIncludeNoLocationClasses = true
      excludes = listOf("jdk.internal.*")
    }
  }

  jacocoTestReport {
    classDirectories.setFrom(instrumentCode)
  }

  jacocoTestCoverageVerification {
    classDirectories.setFrom(instrumentCode)
  }
}

test {
  jacoco {
    includeNoLocationClasses = true
    excludes = ["jdk.internal.*"]
  }
}

jacocoTestReport {
  classDirectories.setFrom(instrumentCode)
}

jacocoTestCoverageVerification {
  classDirectories.setFrom(instrumentCode)
}

When using Java 11.0.2 for building plugins, resolving dependencies (or making any other network requests) in Gradle IntelliJ Plugin fails due to the JDK-8220723 issue with the following exception:

Exception in thread "main" javax.net.ssl.SSLPeerUnverifiedException: peer not authenticated

To fix that issue, upgrade the Java version to the latest patch available of the major version of your choice.

It is possible to add a dependency on a plugin available in the file system — like a plugin update downloaded manually from JetBrains Marketplace or built separately in another project.

To configure the dependency, add the File instance to the intellij.plugins property and point it to the extracted plugin's directory which contains the lib directory.

intellij {
    plugins.set(listOf(file("/path/to/plugin/")))
}

intellij {
    plugins = [file("/path/to/plugin/")]
}

It is also possible to refer to the sandbox directory of another Gradle project — to do that, point to the /projects/plugin-name/build/idea-sandbox/plugins/plugin-name/ directory.

Please upgrade to Kotlin 1.9.0. See the Incremental compilation section if using Kotlin 1.8.20.

note

Something missing?

If a topic you are interested in is not covered in the above sections, let us know via the Was this page helpful? feedback form below or other channels.

Please be specific about the topics and reasons for adding them, and leave your email in case we need more details. Thanks for your feedback!