Migrating from Gradle IntelliJ Plugin (1.x)

Use: intellijPlatform.pluginConfiguration.name:

intellijPlatform {
  pluginConfiguration {
    name = ...
  }
}

Define the IntelliJ Platform dependency in dependencies{} block:

repositories {
  mavenCentral()
  intellijPlatform {
    defaultRepositories()
  }
}

dependencies {
  intellijPlatform {
    create(type, version)
  }
}

See: Dependencies Extension

The intellij.plugins property is no longer available.

note

Bundled plugins are now defined separately from plugins of other sources (like JetBrains Marketplace).

Define dependencies on plugins or bundled plugins in dependencies {} block instead:

Example:

Setting up dependencies on comma-separated plugins listed in platformPlugins and platformBundledPlugins properties from gradle.properties.

repositories {
  mavenCentral()
  intellijPlatform {
    defaultRepositories()
  }
}

dependencies {
  intellijPlatform {
    plugins(providers.gradleProperty("platformPlugins").map { it.split(',') })
    bundledPlugins(providers.gradleProperty("platformBundledPlugins").map { it.split(',') })
  }
}

See:

• Plugins

• Dependency on bundled plugin is not resolved after migrating from 1.x

tip

localPlatformArtifacts() and defaultRepositories()

Note that unless using recommended default defaultRepositories(), the localPlatformArtifacts() entry needs to be added to the repositories {} block explicitly to use local dependencies (bundled plugins, local IDE, custom plugin repositories, etc.).

Define dependencies on local IDE instance in dependencies {} block:

repositories {
  mavenCentral()
  intellijPlatform {
    defaultRepositories()
  }
}

dependencies {
  intellijPlatform {
    local(localPath)
  }
}

See: Custom Target Platforms

tip

localPlatformArtifacts() and defaultRepositories()

Note that unless using recommended default defaultRepositories(), the localPlatformArtifacts() entry needs to be added to the repositories {} block explicitly to use local dependencies (bundled plugins, local IDE, custom plugin repositories, etc.).

The since/until properties in the plugin.xml file are now managed by the intellijPlatform extension.

Use the intellijPlatform.sandboxContainer.

Use the repositories {} block to manage repositories instead.

See: Repositories Extension

Downloading sources is managed by the Plugin DevKit plugin in version 2024.1+.

Access the ProductInfo object using the intellijPlatform.productInfo property.

An explicit dependency on a test framework is now required.

The Robot Server Plugin can now be downloaded using plugins { robotServerPlugin() } dependency helper when declaring a custom task.

The runIdeForUiTests task is obsolete and should be replaced with an explicit declaration.

The task running IDE with the Robot Server Plugin should be declared now as a custom runIde task with plugin loaded:

val runIdeForUiTests by intellijPlatformTesting.runIde.registering {
  task {
    jvmArgumentProviders += CommandLineArgumentProvider {
      listOf(
        "-Drobot-server.port=8082",
        "-Dide.mac.message.dialogs.as.sheets=false",
        "-Djb.privacy.policy.text=<!--999.999-->",
        "-Djb.consents.confirmation.enabled=false",
      )
    }
  }

  plugins {
    robotServerPlugin()
  }
}

val runIdeForUiTests by intellijPlatformTesting.runIde.registering {
  task {
    jvmArgumentProviders.add({
      [
        '-Drobot-server.port=8082',
        '-Dide.mac.message.dialogs.as.sheets=false',
        '-Djb.privacy.policy.text=<!--999.999-->',
        '-Djb.consents.confirmation.enabled=false',
      ]
    } as CommandLineArgumentProvider)
  }

  plugins {
    robotServerPlugin()
  }
}

The task for running the IntelliJ Plugin Verifier is now called verifyPlugin.

Use intellijPlatform.pluginVerification extension to configure it.

To make the IntelliJ SDK dependency available in the IDE, the setupDependencies task was provided by Gradle IntelliJ Plugin 1.x. This task is no longer required, but when switching from 1.x, Gradle may still want to execute it in the afterSync phase.

warning

Task 'setupDependencies' not found

Due to the presence of the setupDependencies task in the Tasks Activation, the IDE may fail with the following exception if the task is not present:

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

To fix this problem, remove any references to setupDependencies task from your project.

To completely drop this approach, it is mandatory to remove its reference manually in the IDE.

Alternatively, edit the .idea/workspace.xml file and remove the setupDependencies entry.

Add an explicit dependency on the plugin in build.gradle.kts:

plugins {
  id("org.jetbrains.gradle.plugin.idea-ext") version "1.1.9"
}

plugins {
  id 'org.jetbrains.gradle.plugin.idea-ext' version '1.1.9'
}