IntelliJPlatformGradlePlugin/org.jetbrains.intellij.platform.gradle.extensions/IntelliJPlatformDependenciesExtension

IntelliJPlatformDependenciesExtension

abstract class IntelliJPlatformDependenciesExtension @Inject constructor(configurations: ConfigurationContainer, dependencies: DependencyHandler, layout: ProjectLayout, objects: ObjectFactory, providers: ProviderFactory, resources: ResourceHandler, rootProjectDirectory: Path)

Extension class for managing IntelliJ Platform dependencies in a Gradle build script applied to the DependencyHandler.

This class provides methods for adding dependencies to different IntelliJ Platform products and managing local dependencies. It also includes methods for adding JetBrains Runtime, IntelliJ Platform plugins, IntelliJ Platform bundled plugins, IntelliJ Plugin Verifier, and Marketplace ZIP Signer.

Parameters

configurations

The Gradle ConfigurationContainer to manage configurations.

dependencies

The Gradle DependencyHandler to manage dependencies.

layout

The Gradle ProjectLayout to manage layout providers.

objects

The Gradle ObjectFactory used for creating objects.

providers

The Gradle ProviderFactory used for creating providers.

resources

The Gradle ResourceHandler used for managing resources.

rootProjectDirectory

The root directory of the Gradle project.

Constructors

IntelliJPlatformDependenciesExtension

@Inject

constructor(configurations: ConfigurationContainer, dependencies: DependencyHandler, layout: ProjectLayout, objects: ObjectFactory, providers: ProviderFactory, resources: ResourceHandler, rootProjectDirectory: Path)

Types

object Companion : Registrable<IntelliJPlatformDependenciesExtension>

Functions

fun androidStudio(version: String, useInstaller: Boolean = true)

fun androidStudio(version: Provider<String>, useInstaller: Boolean = true)

Adds a dependency on Android Studio.

fun aqua(version: String, useInstaller: Boolean = true)

fun aqua(version: Provider<String>, useInstaller: Boolean = true)

Adds a dependency on Aqua.

fun bundledLibrary(path: String)

fun bundledLibrary(path: Provider<String>)

Adds a dependency on a Jar bundled within the current IntelliJ Platform.

fun bundledPlugin(id: String)

fun bundledPlugin(id: Provider<String>)

Adds a dependency on a bundled IntelliJ Platform plugin.

fun bundledPlugins(vararg ids: String)

fun bundledPlugins(ids: List<String>)

fun bundledPlugins(ids: Provider<List<String>>)

Adds dependencies on bundled IntelliJ Platform plugins.

fun clion(version: String, useInstaller: Boolean = true)

fun clion(version: Provider<String>, useInstaller: Boolean = true)

Adds a dependency on CLion.

fun create(notation: String, useInstaller: Boolean = true)

fun create(notation: Provider<String>, useInstaller: Boolean = true)

fun create(type: String, version: String, useInstaller: Boolean = true)

fun create(type: String, version: Provider<String>, useInstaller: Boolean = true)

fun create(type: Provider<*>, version: String, useInstaller: Boolean = true)

fun create(type: Provider<*>, version: Provider<String>, useInstaller: Boolean = true)

fun create(type: Provider<*>, version: Provider<String>, useInstaller: Provider<Boolean>)

fun create(type: IntelliJPlatformType, version: String, useInstaller: Boolean = true)

fun create(type: IntelliJPlatformType, version: Provider<String>, useInstaller: Boolean = true)

fun create(type: Provider<*>, version: Provider<String>, useInstaller: Boolean = true, configurationName: String)

Adds a dependency on the IntelliJ Platform.

fun datagrip(version: String, useInstaller: Boolean = true)

fun datagrip(version: Provider<String>, useInstaller: Boolean = true)

Adds a dependency on DataGrip.

fun dataspell(version: String, useInstaller: Boolean = true)

fun dataspell(version: Provider<String>, useInstaller: Boolean = true)

Adds a dependency on DataSpell.

fun fleetBackend(version: String, useInstaller: Boolean = true)

fun fleetBackend(version: Provider<String>, useInstaller: Boolean = true)

Adds a dependency on Fleet Backend.

fun gateway(version: String, useInstaller: Boolean = true)

fun gateway(version: Provider<String>, useInstaller: Boolean = true)

Adds a dependency on Gateway.

fun goland(version: String, useInstaller: Boolean = true)

fun goland(version: Provider<String>, useInstaller: Boolean = true)

Adds a dependency on GoLand.

instrumentationTools

fun instrumentationTools()

Applies a set of dependencies required for running the InstrumentCodeTask task.

intellijIdeaCommunity

fun intellijIdeaCommunity(version: String, useInstaller: Boolean = true)

fun intellijIdeaCommunity(version: Provider<String>, useInstaller: Boolean = true)

Adds a dependency on IntelliJ IDEA Community.

intellijIdeaUltimate

fun intellijIdeaUltimate(version: String, useInstaller: Boolean = true)

fun intellijIdeaUltimate(version: Provider<String>, useInstaller: Boolean = true)

Adds a dependency on IntelliJ IDEA Ultimate.

fun javaCompiler(version: String = Constraints.CLOSEST_VERSION)

fun javaCompiler(version: Provider<String>)

Adds a Java Compiler dependency for code instrumentation.

jetbrainsRuntime

fun jetbrainsRuntime()

Adds a dependency on JetBrains Runtime. The version is calculated using the current IntelliJ Platform.

fun jetbrainsRuntime(version: String, variant: String? = null, architecture: String? = null)

fun jetbrainsRuntime(version: Provider<String>, variant: Provider<String>, architecture: Provider<String>)

Adds a local dependency on JetBrains Runtime.

jetbrainsRuntimeExplicit

fun jetbrainsRuntimeExplicit(explicitVersion: String)

fun jetbrainsRuntimeExplicit(explicitVersion: Provider<String>)

Adds a dependency on JetBrains Runtime.

jetbrainsRuntimeLocal

fun jetbrainsRuntimeLocal(localPath: Path)

fun jetbrainsRuntimeLocal(localPath: String)

fun jetbrainsRuntimeLocal(localPath: Directory)

fun jetbrainsRuntimeLocal(localPath: Provider<*>)

Adds a dependency on JetBrains Runtime local instance.

fun local(localPath: File)

fun local(localPath: String)

fun local(localPath: Directory)

fun local(localPath: Provider<*>)

fun local(localPath: Provider<*>, configurationName: String)

Adds a local dependency on a local IntelliJ Platform instance.

fun localPlugin(localPath: File)

fun localPlugin(localPath: String)

fun localPlugin(dependency: ProjectDependency): Boolean

fun localPlugin(localPath: Directory)

fun localPlugin(localPath: Provider<*>)

Adds a dependency on a local IntelliJ Platform plugin.

fun mps(version: String, useInstaller: Boolean = true)

fun mps(version: Provider<String>, useInstaller: Boolean = true)

Adds a dependency on MPS.

fun phpstorm(version: String, useInstaller: Boolean = true)

fun phpstorm(version: Provider<String>, useInstaller: Boolean = true)

Adds a dependency on PhpStorm.

platformDependency

fun platformDependency(coordinates: Coordinates, version: String = Constraints.CLOSEST_VERSION, configurationName: String = Configurations.INTELLIJ_PLATFORM_DEPENDENCIES)

fun platformDependency(coordinates: Coordinates, version: Provider<String>, configurationName: String = Configurations.INTELLIJ_PLATFORM_DEPENDENCIES)

Adds a dependency on the test-framework library or its variant, required for testing plugins.

fun plugin(notation: String)

fun plugin(notation: Provider<String>)

Adds a dependency on a plugin for IntelliJ Platform using a string notation, in the following formats:

fun plugin(id: String, version: String, group: String = Dependencies.MARKETPLACE_GROUP)

fun plugin(id: Provider<String>, version: Provider<String>, group: Provider<String>)

Adds a dependency on a plugin for IntelliJ Platform.

fun pluginModule(dependency: Dependency?): Boolean?

Adds dependency on a module to be merged into the main plugin Jar archive by ComposedJarTask.

fun plugins(vararg notations: String)

fun plugins(notations: List<String>)

fun plugins(notations: Provider<List<String>>)

Adds dependencies on a plugin for IntelliJ Platform using a string notation, in the following formats:

fun pluginVerifier(version: String = Constraints.LATEST_VERSION)

fun pluginVerifier(version: Provider<String>)

Adds a dependency on IntelliJ Plugin Verifier.

pycharmCommunity

fun pycharmCommunity(version: String, useInstaller: Boolean = true)

fun pycharmCommunity(version: Provider<String>, useInstaller: Boolean = true)

Adds a dependency on PyCharm Community.

pycharmProfessional

fun pycharmProfessional(version: String, useInstaller: Boolean = true)

fun pycharmProfessional(version: Provider<String>, useInstaller: Boolean = true)

Adds a dependency on PyCharm Professional.

fun rider(version: String, useInstaller: Boolean = true)

fun rider(version: Provider<String>, useInstaller: Boolean = true)

Adds a dependency on Rider.

fun rubymine(version: String, useInstaller: Boolean = true)

fun rubymine(version: Provider<String>, useInstaller: Boolean = true)

Adds a dependency on RubyMine.

fun rustRover(version: String, useInstaller: Boolean = true)

fun rustRover(version: Provider<String>, useInstaller: Boolean = true)

Adds a dependency on Rust Rover.

fun testFramework(type: TestFrameworkType, version: String = Constraints.CLOSEST_VERSION, configurationName: String = Configurations.INTELLIJ_PLATFORM_TEST_DEPENDENCIES)

Adds a dependency on the test-framework library or its variant, required for testing plugins.

fun testFramework(type: TestFrameworkType, version: Provider<String>, configurationName: String = Configurations.INTELLIJ_PLATFORM_TEST_DEPENDENCIES)

Adds a dependency on the test-framework library required for testing plugins.

testPlatformDependency

fun testPlatformDependency(coordinates: Coordinates, version: String = Constraints.CLOSEST_VERSION, configurationName: String = Configurations.INTELLIJ_PLATFORM_TEST_DEPENDENCIES)

fun testPlatformDependency(coordinates: Coordinates, version: Provider<String>, configurationName: String = Configurations.INTELLIJ_PLATFORM_TEST_DEPENDENCIES)

Adds a dependency on the test-framework library or its variant, required for testing plugins.

fun webstorm(version: String, useInstaller: Boolean = true)

fun webstorm(version: Provider<String>, useInstaller: Boolean = true)

Adds a dependency on WebStorm.

fun writerside(version: String, useInstaller: Boolean = true)

fun writerside(version: Provider<String>, useInstaller: Boolean = true)

Adds a dependency on Writerside.

fun zipSigner(version: String = Constraints.LATEST_VERSION)

fun zipSigner(version: Provider<String>)

Adds a dependency on Marketplace ZIP Signer.