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

plugin_dependencies.md: note unique filenames (IJSDK-916)

Browse Source
This commit is contained in:
Yann Cébron 2020-11-17 18:42:17 +01:00
parent fe820fea7a
commit 7a1a72bebc
1 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
basics/plugin_structure/plugin_dependencies.md
View File

@ -77,18 +77,25 @@ Continuing with the example from [Section 2](#2-project-setup) above, the depend
## Optional Plugin Dependencies ## Optional Plugin Dependencies
A project can also specify an optional plugin dependency. A project can also specify an optional plugin dependency.
In this case, the plugin will load even if the plugin depends on is not installed or enabled, but part of the plugin's functionality will not be available. In this case, the plugin will load even if the plugin it depends on is not installed or enabled, but part of the plugin's functionality will not be available.
In order to do that, add `optional="true" config-file="otherconfig.xml"` to the `<depends>` tag.
For example, if a plugin project adds additional highlighting for Java and Kotlin files, use the following setup. Declare additional `optional="true"` and `config-file` attribute pointing to optional plugin descriptor file:
The main `plugin.xml` will define an annotator for Java and specify an optional dependency on the Kotlin plugin:
```xml
<depends optional="true" config-file="myPluginId-optionalPluginName.xml">dependency.plugin.id</depends>
```
> **NOTE** Additional plugin descriptor files must follow the naming pattern `myPluginId-$NAME$.xml` resulting in unique filenames to prevent problems with classloaders in tests ([Details](https://youtrack.jetbrains.com/issue/IDEA-205964)).
For example, if a plugin adds additional highlighting for Java and Kotlin files, use the following setup.
The main `plugin.xml` will define an annotator for Java and specify an optional dependency on the Kotlin plugin (`org.jetbrains.kotlin`):
_plugin.xml_ _plugin.xml_
```xml ```xml
<idea-plugin> <idea-plugin>
... ...
<depends optional="true" config-file="withKotlin.xml">org.jetbrains.kotlin</depends> <depends optional="true" config-file="myPluginId-withKotlin.xml">org.jetbrains.kotlin</depends>
<extensions defaultExtensionNs="com.intellij"> <extensions defaultExtensionNs="com.intellij">
<annotator language="JAVA" implementationClass="com.example.MyJavaAnnotator"/> <annotator language="JAVA" implementationClass="com.example.MyJavaAnnotator"/>
@ -96,10 +103,10 @@ _plugin.xml_
</idea-plugin> </idea-plugin>
``` ```
Then create a file called `withKotlin.xml`, in the same directory as the main `plugin.xml` file. Then create a file called `myPluginId-withKotlin.xml`, in the same directory as the main `plugin.xml` file.
In that file, define an annotator for Kotlin: In that file, define an annotator for Kotlin:
_withKotlin.xml_ _myPluginId-withKotlin.xml_
```xml ```xml
<idea-plugin> <idea-plugin>