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

IntelliJPlatformDependenciesExtension

abstract class IntelliJPlatformDependenciesExtension @Inject constructor(dependenciesHelper: IntelliJPlatformDependenciesHelper, extensionProvider: Provider<IntelliJPlatformExtension>, objects: ObjectFactory)

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

dependenciesHelper

IntelliJ Platform dependencies helper instance

Constructors

IntelliJPlatformDependenciesExtension

@Inject

constructor(dependenciesHelper: IntelliJPlatformDependenciesHelper, extensionProvider: Provider<IntelliJPlatformExtension>, objects: ObjectFactory)

Types

object Companion

Functions

fun androidStudio(version: String, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

fun androidStudio(version: Provider<String>, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

Adds a dependency on Android Studio.

fun bundledLibrary(path: String)

fun bundledLibrary(path: Provider<String>)

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

fun bundledModule(id: String)

fun bundledModule(id: Provider<String>)

Adds a dependency on a bundled IntelliJ Platform module.

fun bundledModules(ids: List<String>)

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

fun bundledModules(vararg ids: String)

Adds dependencies on bundled IntelliJ Platform modules.

fun bundledPlugin(id: String)

fun bundledPlugin(id: Provider<String>)

Adds a dependency on a bundled IntelliJ Platform plugin.

fun bundledPlugins(ids: List<String>)

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

fun bundledPlugins(vararg ids: String)

Adds dependencies on bundled IntelliJ Platform plugins.

fun clion(version: String, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

fun clion(version: Provider<String>, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

Adds a dependency on CLion.

compatiblePlugin

fun compatiblePlugin(id: String)

fun compatiblePlugin(id: Provider<String>)

Adds a dependency on a plugin in a version compatible with the current IntelliJ Platform.

compatiblePlugins

fun compatiblePlugins(ids: List<String>)

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

fun compatiblePlugins(vararg ids: String)

Adds a dependency on plugins in versions compatible with the current IntelliJ Platform.

@Incubating

fun composeUI()

Configures and bundles the necessary modules for the Compose UI framework.

fun create(configure: Action<IntelliJPlatformDependencyConfiguration>)

fun create(configuration: IntelliJPlatformDependencyConfiguration)

Creates and configures an instance of IntelliJPlatformDependencyConfiguration and adds an IntelliJ Platform dependency based on the provided configuration.

fun create(type: Any, version: String, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

fun create(type: Any, version: Provider<String>, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

fun create(type: Provider<*>, version: Provider<String>, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

Adds a dependency on the IntelliJ Platform.

fun datagrip(version: String, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

fun datagrip(version: Provider<String>, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

Adds a dependency on DataGrip.

fun dataspell(version: String, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

fun dataspell(version: Provider<String>, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

Adds a dependency on DataSpell.

fun fleetBackend(version: String, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

fun fleetBackend(version: Provider<String>, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

Adds a dependency on Fleet Backend.

fun gateway(version: String, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

fun gateway(version: Provider<String>, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

Adds a dependency on Gateway.

fun goland(version: String, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

fun goland(version: Provider<String>, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

Adds a dependency on GoLand.

fun grammarKit(version: String = Constraints.GRAMMAR_KIT_VERSION)

fun grammarKit(version: Provider<String>)

Adds a Grammar Kit dependency to generate lexer code.

fun intellijIdea(version: String, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

fun intellijIdea(version: Provider<String>, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

Adds a dependency on IntelliJ IDEA Community.

intellijIdeaCommunity

fun intellijIdeaCommunity(version: String, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

fun intellijIdeaCommunity(version: Provider<String>, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

Adds a dependency on IntelliJ IDEA Community.

intellijIdeaUltimate

fun intellijIdeaUltimate(version: String, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

fun intellijIdeaUltimate(version: Provider<String>, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

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 jflex(version: String = Constraints.JFLEX_VERSION)

fun jflex(version: Provider<String>)

Adds a JFlex dependency to generate lexer code.

fun local(localPath: File)

fun local(localPath: Path)

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, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

fun mps(version: Provider<String>, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

Adds a dependency on MPS.

fun phpstorm(version: String, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

fun phpstorm(version: Provider<String>, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

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.

pluginComposedModule

fun pluginComposedModule(dependency: Dependency?): Boolean?

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

fun pluginModule(dependency: Dependency?): Boolean?

A base method for adding a project dependency on a module to be moved into lib/modules by PrepareSandboxTask.

fun plugins(notations: List<String>)

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

fun plugins(vararg notations: 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.

fun pycharm(version: String, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

fun pycharm(version: Provider<String>, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

Adds a dependency on PyCharm.

pycharmCommunity

fun pycharmCommunity(version: String, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

fun pycharmCommunity(version: Provider<String>, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

Adds a dependency on PyCharm Community.

pycharmProfessional

fun pycharmProfessional(version: String, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

fun pycharmProfessional(version: Provider<String>, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

Adds a dependency on PyCharm Professional.

fun rider(version: String, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

fun rider(version: Provider<String>, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

Adds a dependency on Rider.

fun rubymine(version: String, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

fun rubymine(version: Provider<String>, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

Adds a dependency on RubyMine.

fun rustRover(version: String, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

fun rustRover(version: Provider<String>, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

Adds a dependency on Rust Rover.

testBundledModule

fun testBundledModule(id: String)

fun testBundledModule(id: Provider<String>)

Adds a test dependency on a bundled IntelliJ Platform module.

testBundledModules

fun testBundledModules(ids: List<String>)

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

fun testBundledModules(vararg ids: String)

Adds test dependencies on bundled IntelliJ Platform modules.

testBundledPlugin

fun testBundledPlugin(id: String)

fun testBundledPlugin(id: Provider<String>)

Adds a test dependency on a bundled IntelliJ Platform plugin.

testBundledPlugins

fun testBundledPlugins(ids: List<String>)

fun testBundledPlugins(vararg ids: String)

Adds test dependencies on bundled IntelliJ Platform plugins.

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

test Adds dependencies on bundled IntelliJ Platform plugins.

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.

testLocalPlugin

fun testLocalPlugin(localPath: File)

fun testLocalPlugin(localPath: String)

fun testLocalPlugin(dependency: ProjectDependency): Boolean

fun testLocalPlugin(localPath: Directory)

fun testLocalPlugin(localPath: Provider<*>)

Adds a test dependency on a local IntelliJ Platform plugin.

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 testPlugin(notation: String)

fun testPlugin(notation: Provider<String>)

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

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

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

Adds a test dependency on a plugin for IntelliJ Platform.

fun testPlugins(notations: List<String>)

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

fun testPlugins(vararg notations: String)

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

fun webstorm(version: String, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

fun webstorm(version: Provider<String>, configure: Action<IntelliJPlatformDependencyConfiguration> = Action {})

Adds a dependency on WebStorm.

fun zipSigner(version: String = Constraints.LATEST_VERSION)

fun zipSigner(version: Provider<String>)

Adds a dependency on Marketplace ZIP Signer.