插件与IntelliJ平台产品的兼容性

原文链接:
http://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/plugin_compatibility.html

所有基于IntelliJ平台的产品(IntelliJ IDEA、RubyMine、WebStorm、PhpStorm、PyCharm、AppCode等等)共享相同的底层API。因此,如果一个插件没有使用任何Java特定的功能,那么它可以被标记为兼容任何其他产品。这是通过在plugin.xml文件中指定模块依赖关系来完成的。

一个模块依赖就是一个标签,它的内容以com.intellij.modules开头。
例如:


    ...
    com.intellij.modules.lang
    ...

如果一个插件在其plugin.xml中不包含任何模块依赖项标签,则它将被假定为一个旧版插件,并且仅在IntelliJ IDEA中加载。

如果plugin.xml包含一个或多个这样的标签,那么只有在产品包含插件所依赖的所有模块时才会加载该插件。

以下模块目前适用于基于IntelliJ平台的所有产品:

  • com.intellij.modules.platform
  • com.intellij.modules.lang
  • com.intellij.modules.vcs
  • com.intellij.modules.xml
  • com.intellij.modules.xdebugger

以下模块仅在特定产品中可用:

模块 产品
com.intellij.modules.java IntelliJ IDEA
com.intellij.modules.ultimate IntelliJ IDEA Ultimate Edition
com.intellij.modules.androidstudio Android Studio
com.intellij.modules.appcode AppCode
com.intellij.modules.cidr.lang AppCode, CLion
com.intellij.modules.cidr.debugger AppCode, CLion, RubyMotion
com.intellij.modules.clion CLion
com.intellij.modules.database IntelliJ IDEA Ultimate Edition, PhpStorm, RubyMine, PyCharm, DataGrip
com.intellij.modules.python PyCharm
com.intellij.modules.ruby RubyMine

PhpStorm没有任何特定于自身的模块,但它包含PHP插件,你也可以使用它作为依赖:com.jetbrains.php

你还可以指定可选的模块依赖关系。 如果你的插件可以与所有产品配合使用,但提供了一些特定的Java功能,你可以像这样使用依赖标记:

 
    com.intellij.modules.java

在将插件标记兼容所有产品之前,你应该确保它没有使用任何IntelliJ IDEA特定的API。 你可以创建一个指向RubyMine,PyCharm等安装目录的IntelliJ平台SDK,并用其编译插件验证兼容性。

IntelliJ插件库会基于以上规则自动插件与产品的兼容性,确保插件能在这些产品上可用。

IntelliJ平台的API和捆绑的插件可能会在新的发行版中更改。 可能会破坏插件兼容性的更改会在IntelliJ平台和插件API的不兼容更改页面列出。

你可能感兴趣的:(插件与IntelliJ平台产品的兼容性)