hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-30 18:27:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

tools_intellij_platform_gradle_plugin_task_awares.md: add GH links

Browse Source
This commit is contained in:
Yann Cébron 2024-02-05 18:32:20 +01:00
parent e67680d82d
commit f9e06618f3
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_task_awares.md
View File

@ -12,6 +12,8 @@ The Task Awares is a set of interfaces that can be applied to custom Gradle task
## CoroutinesJavaAgentAware
{#CoroutinesJavaAgentAware}
[`CoroutinesJavaAgentAware`](%gh-ipgp%/src/main/kotlin/org/jetbrains/intellij/platform/gradle/tasks/aware/CoroutinesJavaAgentAware.kt)
The interface provides the path to the Java Agent file for the Coroutines library required to enable coroutines debugging.
Inherited also by [`RunnableIdeAware`](#RunnableIdeAware).
@ -32,6 +34,8 @@ Default value
## CustomIntelliJPlatformVersionAware
{#CustomIntelliJPlatformVersionAware}
[`CustomIntelliJPlatformVersionAware`](%gh-ipgp%/src/main/kotlin/org/jetbrains/intellij/platform/gradle/tasks/aware/CustomIntelliJPlatformVersionAware.kt)
By default, the project with the IntelliJ Platform Gradle Plugin applied required the presence of the IntelliJ Platform, referred to later by various tasks, configurations, and extensions.
The custom IntelliJ Platform concept allows using another version, i.e., to run a guest IDE or tests against it.
@ -80,6 +84,8 @@ Type
## IntelliJPlatformVersionAware
{#IntelliJPlatformVersionAware}
[`IntelliJPlatformVersionAware`](%gh-ipgp%/src/main/kotlin/org/jetbrains/intellij/platform/gradle/tasks/aware/IntelliJPlatformVersionAware.kt)
This interface provides tasks a possibility for accessing information about the IntelliJ Platform currently used in the project.
The [`intelliJPlatformConfiguration`](#IntelliJPlatformVersionAware-intelliJPlatformConfiguration) input property receives a dependency added to the `intellijPlatform` configuration, which eventually is resolved and lets to access the IntelliJ Platform details such as [`ProductInfo`](tools_intellij_platform_gradle_plugin_types.md#ProductInfo) or the path to the IntelliJ Platform directory.
@ -135,6 +141,8 @@ Throws
## PluginVerifierAware
{#PluginVerifierAware}
[`PluginVerifierAware`](%gh-ipgp%/src/main/kotlin/org/jetbrains/intellij/platform/gradle/tasks/aware/PluginVerifierAware.kt)
The interface provides the path to the IntelliJ Plugin Verifier executable.
It is required to have a dependency on the IntelliJ Plugin Verifier added to the project with [`intellijPlatform.pluginVerifier()`](tools_intellij_platform_gradle_plugin_dependencies_extension.md) dependencies extension.
@ -153,6 +161,8 @@ Type
## RunnableIdeAware
{#RunnableIdeAware}
[`RunnableIdeAware`](%gh-ipgp%/src/main/kotlin/org/jetbrains/intellij/platform/gradle/tasks/aware/RunnableIdeAware.kt)
The interface which utilizes a set of various interfaces required for running a guest IDE. Inherits from:
- [`CoroutinesJavaAgentAware`](#CoroutinesJavaAgentAware)
- [`RuntimeAware`](#RuntimeAware)
@ -163,6 +173,8 @@ The interface which utilizes a set of various interfaces required for running a
## RuntimeAware
{#RuntimeAware}
[`RuntimeAware`](%gh-ipgp%/src/main/kotlin/org/jetbrains/intellij/platform/gradle/tasks/aware/RuntimeAware.kt)
This interface provides access to the Java Runtime (i.e., JetBrains Runtime) resolved with `RuntimeResolver`.
### runtimeDirectory
@ -199,6 +211,8 @@ Type
## SandboxAware
{#SandboxAware}
[`SandboxAware`](%gh-ipgp%/src/main/kotlin/org/jetbrains/intellij/platform/gradle/tasks/aware/SandboxAware.kt)
The interface provides quick access to the sandbox container and specific directories located within it.
The path to the sandbox container is obtained using the [`intellijPlatform.sandboxContainer`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-sandboxContainer) extension property and the type and version of the IntelliJ Platform applied to the project.
@ -271,6 +285,8 @@ Type
## SigningAware
{#SigningAware}
[`SigningAware`](%gh-ipgp%/src/main/kotlin/org/jetbrains/intellij/platform/gradle/tasks/aware/SigningAware.kt)
The interface provides the path to the Marketplace ZIP Signer executable.
It is required to have a dependency on the Marketplace ZIP Signer added to the project with [`intellijPlatform.zipSigner()`](tools_intellij_platform_gradle_plugin_dependencies_extension.md) dependencies extension.