插件与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文件中指定模块依赖关系来完成的。

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

<idea-plugin>
    ...
    <depends>com.intellij.modules.lang</depends>
    ...
</idea-plugin>

如果一个插件在其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功能,你可以像这样使用依赖标记:

<depends optional="true" config-file="my-java-features.xml"> 
    com.intellij.modules.java
</depends>

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

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

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,723评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,080评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,604评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,440评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,431评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,499评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,893评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,541评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,751评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,547评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,619评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,320评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,890评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,896评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,137评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,796评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,335评论 2 342

推荐阅读更多精彩内容