Skip to content

Commit 35e44a2

Browse files
committed
tools_intellij_platform_gradle_plugin_tasks.md: update task properties, deprecate coroutinesJavaAgent, and revise code instrumentation guidelines
1 parent 2a533e9 commit 35e44a2

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_tasks.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Type
9292
: `DirectoryProperty`
9393

9494
Default value
95-
: <path>[buildDirectory]/searchableOptions</path>
95+
:: <path>[buildDirectory]/tmp/buildSearchableOptions</path>
9696

9797

9898
### `showPaidPluginWarning`
@@ -153,9 +153,9 @@ Type
153153

154154
**Available in:** [](tools_intellij_platform_gradle_plugin_plugins.md#platform), [](tools_intellij_platform_gradle_plugin_plugins.md#module)
155155

156-
**Extends**: [`DefaultTask`][gradle-default-task], [`IntelliJPlatformVersionAware`](tools_intellij_platform_gradle_plugin_task_awares.md#IntelliJPlatformVersionAware)
156+
**Extends**: [`DefaultTask`][gradle-default-task], [`KotlinMetadataAware`](tools_intellij_platform_gradle_plugin_task_awares.md#KotlinMetadataAware)
157157

158-
**Sources**: [`InitializeIntelliJPlatformPluginTask`](%gh-ijpgp%/src/main/kotlin/org/jetbrains/intellij/platform/gradle/tasks/InitializeIntelliJPlatformPluginTask.kt)
158+
**Sources**: [`GenerateManifestTask`](%gh-ijpgp%/src/main/kotlin/org/jetbrains/intellij/platform/gradle/tasks/GenerateManifestTask.kt)
159159

160160
</tldr>
161161

@@ -236,10 +236,8 @@ Executes before every other task introduced by IntelliJ Platform Gradle Plugin t
236236
It is responsible for:
237237

238238
- checking if the project uses IntelliJ Platform Gradle Plugin in the latest available version
239-
- preparing the KotlinX Coroutines Java Agent file to enable coroutines debugging when developing the plugin
240239

241240
The self-update check can be disabled via [`selfUpdateCheck`](tools_intellij_platform_gradle_plugin_gradle_properties.md#selfUpdateCheck) Gradle property.
242-
To make the Coroutines Java Agent available for the task, inherit from [`CoroutinesJavaAgentAware`](tools_intellij_platform_gradle_plugin_task_awares.md#CoroutinesJavaAgentAware).
243241

244242

245243
### `offline`
@@ -286,7 +284,7 @@ Type
286284
### `coroutinesJavaAgent`
287285
{#initializeIntelliJPlatformPlugin-coroutinesJavaAgent}
288286

289-
Specifies the Java Agent file for the Coroutines library required to enable coroutines debugging.
287+
Deprecated: this task no longer exposes a coroutines agent property. To enable coroutines debugging, use tasks implementing [CoroutinesJavaAgentAware](tools_intellij_platform_gradle_plugin_task_awares.md#CoroutinesJavaAgentAware) which provide `coroutinesJavaAgentFile`.
290288

291289
{type="narrow"}
292290
Type
@@ -323,7 +321,7 @@ Defines that the current project has only the [](tools_intellij_platform_gradle_
323321

324322
{type="narrow"}
325323
Type
326-
: `Property<String>`
324+
: `Property<Boolean>`
327325

328326

329327

@@ -348,8 +346,8 @@ Executes the code instrumentation using the Ant tasks provided by the used Intel
348346
The code instrumentation scans the compiled Java and Kotlin classes for JetBrains Annotations usages to replace them with their relevant functionalities.
349347

350348
The task is controlled with the [`intellijPlatform.instrumentCode`](tools_intellij_platform_gradle_plugin_extension.md#intellijPlatform-instrumentCode) extension property, enabled by default.
351-
To properly run the instrumentation, it is required to add [`instrumentationTools()`](tools_intellij_platform_gradle_plugin_dependencies_extension.md#code-instrumentation) dependencies to the project.
352-
This dependency is available via the [`intellijDependencies()`](tools_intellij_platform_gradle_plugin_repositories_extension.md#additional-repositories) repository, which can be added separately or using the [`defaultRepositories()`](tools_intellij_platform_gradle_plugin_repositories_extension.md#default-repositories) helper.
349+
To properly run the instrumentation, a Java Compiler dependency must be available. This is applied by default by the plugin; previously, the `instrumentationTools()` helper was used, but it is now deprecated and calling it is no longer necessary. You can still add and configure the dependency manually via [`javaCompiler()`](tools_intellij_platform_gradle_plugin_dependencies_extension.md#code-instrumentation) if needed.
350+
This dependency is resolved via the [`intellijDependencies()`](tools_intellij_platform_gradle_plugin_repositories_extension.md#additional-repositories) repository, which can be added separately or using the [`defaultRepositories()`](tools_intellij_platform_gradle_plugin_repositories_extension.md#default-repositories) helper.
353351

354352
See also:
355353
- [](#instrumentedJar)

0 commit comments

Comments
 (0)