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_gradle_grammar_kit_plugin.md: edits, review

Browse Source
This commit is contained in:
Yann Cébron 2024-02-05 18:02:39 +01:00
parent 77308ab68c
commit 33ca10451f
1 changed files with 26 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
topics/appendix/tools/intellij_platform_gradle_plugin/tools_intellij_platform_gradle_plugin_migration.md
View File

@ -2,35 +2,49 @@
# Migration Guide from Gradle IntelliJ Plugin
<link-summary>This is the IntelliJ Platform Gradle Plugin migration guide from the Gradle IntelliJ Plugin 1.x</link-summary>
<link-summary>IntelliJ Platform Gradle Plugin 2.x migration guide from Gradle IntelliJ Plugin 1.x</link-summary>
<include from="tools_intellij_platform_gradle_plugin.md" element-id="EAP_Status"/>
## Plugin name change
As the `2.x` branch brings significant breaking changes to the plugin, we also decided to change its name from _Gradle IntelliJ Plugin_ to _IntelliJ Platform Gradle Plugin_ as the old one was confused with the Gradle support plugin for IntelliJ-based IDEs.
As the `2.x` branch brings significant breaking changes to the plugin, the name was changed from _Gradle IntelliJ Plugin_ to
_IntelliJ Platform Gradle Plugin_ as the old one was confused with the bundled Gradle support plugin in the IDE.
The plugin is published to the Gradle Plugin Portal with a new name as a new entry, and the old one is marked as deprecated.
## Plugin ID change
Plugin ID has changed from `org.jetbrains.intellij` to `org.jetbrains.intellij.platform`.
To apply is, use:
To apply it, use:
```kotlin
plugins {
id("org.jetbrains.intellij.platform")
id("org.jetbrains.intellij.platform")
}
```
## Minimal Gradle version
The minimal required Gradle version is now `8.0`.
The minimal required Gradle version is now `8.0`. See also [](tools_intellij_platform_gradle_plugin.md#requirements).
## `intellij` extension
The `intellij {}` extension is no longer available and was replaced with `intellijPlatform {}` — note that the available properties differ.
The `intellij {}` extension is no longer available and was replaced with `intellijPlatform {}`.
Note that the available properties differ, see [](tools_intellij_platform_gradle_plugin_extension.md) for details.
## `setupDependencies` task
To make IntelliJ SDK dependency available in the IDE for class resolution and code completion, there was the `setupDependencies` task introduced in the Gradle IntelliJ Plugin 1.x.
With IntelliJ Platform Gradle Plugin, such a task is no longer required, but if you are switching from the previous approach, Gradle still may want to execute it in the _afterSync_ phase.
To completely drop this approach, it is mandatory to remove its reference manualy in your IDE:
1. Open Gradle Tool Window
2. Right-click on the main module and select _Tasks Activation_
3. In the _Tasks Activation_ modal window, find and remove the `setupDependencies` entry.
To make the IntelliJ SDK dependency available in the IDE, the `setupDependencies` task was provided by Gradle IntelliJ Plugin 1.x.
This task is no longer required, but when switching from 1.x, Gradle may still want to execute it in the _afterSync_ phase.
To completely drop this approach, it is mandatory to remove its reference manually in the IDE.
<procedure title="Removing setupDependencies task">
1. Open <control>Gradle</control> Tool Window
2. Right-click on the main module and select <control>Tasks Activation</control>
3. In the <control>Tasks Activation</control> modal window, find and remove the `setupDependencies` entry.
</procedure>