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

Plugin Dependencies: edits, relayout

Browse Source
This commit is contained in:
Yann Cébron 2019-08-21 19:39:40 +02:00
parent 697c07ab1f
commit 966a4550c0
1 changed files with 34 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
basics/plugin_structure/plugin_dependencies.md
View File

@ -3,43 +3,54 @@ title: Plugin Dependencies
---
Your plugin may depend on classes from other plugins, either bundled, third-party or your own. In order to express such
dependencies (e.g. Kotlin), you need to perform the following steps:
* If the plugin is not bundled, run the sandbox instance of your target IDE and install the plugin there.
* If you are using Gradle with a Kotlin build script to build your plugin, use `setPlugins()`[^gradleplugin] within the `intellij` block, for example:
dependencies, you need to perform the following three steps:
```kotlin
intellij {
setPlugins("org.jetbrains.kotlin:1.3.11-release-IJ2018.3-1")
}
```
* If you're using Gradle with a groovy build script to build your plugin, add the dependency to the `plugins`[^gradleplugin] parameter of the `intellij` block in your build.gradle, for example:
### 1. Preparing Sandbox
If the plugin is not bundled, run the sandbox instance of your target IDE and install the plugin there.
### 2. Project Setup
Depending on your chosen workflow (Gradle or DevKit), one of the two following steps is necessary.
### 2.1 Gradle
> **NOTE** Please see the `plugins` attribute [gradle-intellij-plugin: Configuration](https://github.com/JetBrains/gradle-intellij-plugin#configuration) for acceptable values.
If you're using [Gradle](/tutorials/build_system.md) with a Groovy build script to build your plugin, add the dependency to the `plugins` parameter of the `intellij` block in your build.gradle, for example:
```groovy
intellij {
plugins 'org.jetbrains.kotlin:1.3.11-release-IJ2018.3-1'
}
```
* If you aren't using Gradle, add the jars of the plugin you're depending on to the classpath of your *IntelliJ Platform SDK*.
In order to do that, open the Project Structure dialog, select the SDK you're using, press the + button in the Classpath tab, and
select the plugin jar file or files.
* For bundled plugins, the plugin jar files are located in `plugins/<pluginname>` or `plugins/<pluginname>/lib` under the main installation directory.
If you're not sure which jar to add, you can add all of them.
* For non-bundled plugins, the plugin jar files are located in `config/plugins/<pluginname>` or `config/plugins/<pluginname>/lib` under the directory specified as "Sandbox Home" in the IntelliJ Platform Plugin SDK settings.
If you are using [Gradle](/tutorials/build_system.md) with a Kotlin build script to build your plugin, use `setPlugins()` within the `intellij` block, for example:
```kotlin
intellij {
setPlugins("org.jetbrains.kotlin:1.3.11-release-IJ2018.3-1")
}
```
#### 2.2 DevKit
If you are using [DevKit](/basics/getting_started/using_dev_kit.md), add the JARs of the plugin you're depending on to the classpath of your *IntelliJ Platform SDK*.
> **WARNING** Do not add the plugin JARs as a library: this will fail at runtime because IntelliJ Platform will load two separate copies of the dependency plugin classes.
In order to do that, open the Project Structure dialog, select the SDK you're using, press the + button in the Classpath tab, and
select the plugin JAR file or files:
* For bundled plugins, the plugin JAR files are located in `plugins/<pluginname>` or `plugins/<pluginname>/lib` under the main installation directory.
If you're not sure, which JAR to add, you can add all of them.
* For non-bundled plugins, the plugin JAR files are located in `config/plugins/<pluginname>` or `config/plugins/<pluginname>/lib` under the directory specified as "Sandbox Home" in the IntelliJ Platform Plugin SDK settings.
![Adding Plugin to Classpath](img/add_plugin_dependency.png)
> **warning** Do not add the plugin jars as a library: this will fail at runtime because IntelliJ Platform will load two separate copies of the dependency plugin classes.
* Add a `<depends>` tag to your plugin.xml, adding the ID of the plugin you're depending on as the contents of the tag.
### 3. Declaration in plugin.xml
In your `plugin.xml`, add a `<depends>` tag with the ID of the dependency plugin as its content (autocompletion is available).
For example:
```xml
<depends>org.jetbrains.kotlin</depends>
```
To find out the ID of the plugin you're depending on, locate the `META-INF/plugin.xml` file inside its jar and check the contents of the `<id>` tag.
## Optional Plugin Dependencies
You can also specify an optional plugin dependency. In this case, your plugin will load even if the plugin you depend on
@ -47,9 +58,9 @@ is not installed or enabled, but part of the functionality of your plugin will n
add `optional="true" config-file="otherconfig.xml"` to the `<depends>` tag.
For example,
if you're working on a plugin that adds additional highlighting for Java and Kotlin files, you can use the following
setup. Your main plugin.xml will define an annotator for Java and specify an optional dependency on the Kotlin plugin:
if you're working on a plugin that adds additional highlighting for Java and Kotlin files, you can use the following setup.
Your main `plugin.xml` will define an annotator for Java and specify an optional dependency on the Kotlin plugin:
```xml
<idea-plugin>
...
@ -61,9 +72,8 @@ setup. Your main plugin.xml will define an annotator for Java and specify an opt
</idea-plugin>
```
Then, you create a file called withKotlin.xml, in the same directory as your main plugin.xml file. In that file, you
Then, you create a file called `withKotlin.xml`, in the same directory as your main `plugin.xml` file. In that file, you
define an annotator for Kotlin:
```xml
<idea-plugin>
<extensions defaultExtensionNs="com.intellij">
@ -72,5 +82,3 @@ define an annotator for Kotlin:
</idea-plugin>
```
---
[^gradleplugin]: See the `plugins` attribute [gradle-intellij-plugin: Configuration](https://github.com/JetBrains/gradle-intellij-plugin#configuration) for acceptable values.