IntelliJ Platform Gradle Plugin docs adjustments

This commit is contained in:
Jakub Chrzanowski 2025-03-12 11:53:47 +01:00
parent 04bead58f6
commit a9207d4fa9
No known key found for this signature in database
GPG Key ID: 56E9E73CB8E7486B
3 changed files with 7 additions and 17 deletions

View File

@ -33,7 +33,7 @@ Learn more about it in the [Release Announcement](https://blog.jetbrains.com/pla
IntelliJ Platform Gradle Plugin 2.x requires the following *minimal* versions: IntelliJ Platform Gradle Plugin 2.x requires the following *minimal* versions:
- IntelliJ Platform: **2022.3** - IntelliJ Platform: **2022.3**
- Gradle: **8.2** - Gradle: **8.5**
See [the Gradle Installation guide](https://gradle.org/install/) on how to upgrade. See [the Gradle Installation guide](https://gradle.org/install/) on how to upgrade.
- Java Runtime: **17** - Java Runtime: **17**

View File

@ -45,10 +45,6 @@ dependencies {
bundledPlugin("com.intellij.java") bundledPlugin("com.intellij.java")
pluginVerifier()
zipSigner()
instrumentationTools()
testFramework(TestFrameworkType.Platform) testFramework(TestFrameworkType.Platform)
} }
@ -77,10 +73,6 @@ dependencies {
bundledPlugin 'com.intellij.java' bundledPlugin 'com.intellij.java'
pluginVerifier()
zipSigner()
instrumentationTools()
testFramework TestFrameworkType.Platform.INSTANCE testFramework TestFrameworkType.Platform.INSTANCE
} }
@ -123,7 +115,6 @@ See [](#custom-target-platforms) for non-default targets.
| `rubymine(version, useInstaller = true)` | [RubyMine](rubymine.md) | | `rubymine(version, useInstaller = true)` | [RubyMine](rubymine.md) |
| `rustrover(version, useInstaller = true)` | [RustRover](https://www.jetbrains.com/rust/) | | `rustrover(version, useInstaller = true)` | [RustRover](https://www.jetbrains.com/rust/) |
| `webstorm(version, useInstaller = true)` | [WebStorm](webstorm.md) | | `webstorm(version, useInstaller = true)` | [WebStorm](webstorm.md) |
| `writerside(version, useInstaller = true)` | [Writerside](https://www.jetbrains.com/writerside/) |
### Custom Target Platforms ### Custom Target Platforms
@ -211,14 +202,12 @@ To enable resolving this kind of artifacts, opt-out from the installer dependenc
repositories { repositories {
intellijPlatform { intellijPlatform {
defaultRepositories() defaultRepositories()
jetbrainsRuntime()
} }
} }
dependencies { dependencies {
intellijPlatform { intellijPlatform {
intellijIdeaCommunity("%ijPlatform%", useInstaller = false) intellijIdeaCommunity("%ijPlatform%", useInstaller = false)
jetbrainsRuntime()
} }
} }
``` ```
@ -230,14 +219,12 @@ dependencies {
repositories { repositories {
intellijPlatform { intellijPlatform {
defaultRepositories() defaultRepositories()
jetbrainsRuntime()
} }
} }
dependencies { dependencies {
intellijPlatform { intellijPlatform {
intellijIdeaCommunity "%ijPlatform%", false intellijIdeaCommunity "%ijPlatform%", false
jetbrainsRuntime()
} }
} }
``` ```
@ -361,8 +348,8 @@ See also:
| Function | Description | | Function | Description |
|------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `pluginVerifier(version)` | Adds a dependency on [IntelliJ Plugin Verifier](verifying_plugin_compatibility.md). | | `pluginVerifier(version)` | Adds a dependency on [IntelliJ Plugin Verifier](verifying_plugin_compatibility.md). Applied by default and refers to the latest available tool's version. |
| `zipSigner(version)` | Adds a dependency on [Marketplace ZIP Signer](plugin_signing.md). | | `zipSigner(version)` | Adds a dependency on [Marketplace ZIP Signer](plugin_signing.md). Applied by default and refers to the latest available tool's version. |
| `bundledLibrary(path)` | **SEE NOTE BELOW**<p>Adds a dependency on a bundled library JAR file of the current IntelliJ Platform, like <path>lib/annotations.jar</path>.</p> | | `bundledLibrary(path)` | **SEE NOTE BELOW**<p>Adds a dependency on a bundled library JAR file of the current IntelliJ Platform, like <path>lib/annotations.jar</path>.</p> |
| `platformDependency(coordinates, version)` | Adds a dependency on a custom IntelliJ Platform dependency available in the [](tools_intellij_platform_gradle_plugin_repositories_extension.md#intellij-maven-repositories). | | `platformDependency(coordinates, version)` | Adds a dependency on a custom IntelliJ Platform dependency available in the [](tools_intellij_platform_gradle_plugin_repositories_extension.md#intellij-maven-repositories). |
| `testPlatformDependency(coordinates, version)` | Adds a test dependency on a custom IntelliJ Platform dependency available in the [](tools_intellij_platform_gradle_plugin_repositories_extension.md#intellij-maven-repositories). | | `testPlatformDependency(coordinates, version)` | Adds a test dependency on a custom IntelliJ Platform dependency available in the [](tools_intellij_platform_gradle_plugin_repositories_extension.md#intellij-maven-repositories). |
@ -383,6 +370,8 @@ See also:
Using the `jetbrainsRuntime()` or `jetbrainsRuntimeExplicit()` dependency helpers, it is possible to load a custom version of JetBrains Runtime. Using the `jetbrainsRuntime()` or `jetbrainsRuntimeExplicit()` dependency helpers, it is possible to load a custom version of JetBrains Runtime.
However, it is recommended to rely on the runtime bundled within the IntelliJ Platform dependency, if present. However, it is recommended to rely on the runtime bundled within the IntelliJ Platform dependency, if present.
The `jetbrainsRuntime()` helper is applied by default and if JetBrains Runtime is not bundled within the currently used IntelliJ Platform, it refers the relevant runtime version automatically.
| Function | Description | | Function | Description |
|-----------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |-----------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| <p>`jetbrainsRuntime()`</p> | Adds a dependency on [JetBrains Runtime](ide_development_instance.md#using-a-jetbrains-runtime-for-the-development-instance) in version obtained with the current IntelliJ Platform if resolved from IntelliJ Maven Repository. | | <p>`jetbrainsRuntime()`</p> | Adds a dependency on [JetBrains Runtime](ide_development_instance.md#using-a-jetbrains-runtime-for-the-development-instance) in version obtained with the current IntelliJ Platform if resolved from IntelliJ Maven Repository. |
@ -401,6 +390,8 @@ Adds a Java Compiler dependency for code instrumentation.
The version is determined by the IntelliJ Platform build number. The version is determined by the IntelliJ Platform build number.
If the exact version is unavailable, the closest one is used, found by scanning all releases. If the exact version is unavailable, the closest one is used, found by scanning all releases.
The `javaCompiler()` helper is applied by default and refers to the tool version close to the currently used IntelliJ Platform.
| Function | Description | | Function | Description |
|-------------------------------------------------------|------------------------------------------------------------------------| |-------------------------------------------------------|------------------------------------------------------------------------|
| <p>`instrumentationTools()`</p> | A helper function to apply all required dependencies: `javaCompiler()` | | <p>`instrumentationTools()`</p> | A helper function to apply all required dependencies: `javaCompiler()` |

View File

@ -67,7 +67,6 @@ Each entry is composed of a product code and coordinates used for dependency and
| `RubyMine` | `RM` | - | &check; | | `RubyMine` | `RM` | - | &check; |
| `RustRover` | `RR` | `com.jetbrains.intellij.rustrover:RustRover` | &check; | | `RustRover` | `RR` | `com.jetbrains.intellij.rustrover:RustRover` | &check; |
| `WebStorm` | `WS` | `com.jetbrains.intellij.webstorm:webstorm` | &check; | | `WebStorm` | `WS` | `com.jetbrains.intellij.webstorm:webstorm` | &check; |
| `Writerside` | `WRS` | `com.jetbrains.intellij.idea:writerside` | &check; |
## `PluginBean` ## `PluginBean`