IntelliJ Plugin 开发之 plugin.xml 配置文件详解(四)

前面几篇文章,我们一起了解了 Plugin 的项目创建和运行效果。接下来我们开始静下心来深入了解插件的内容了。

从 plugin .xml 核心配置文件开始。

更消息的内容,请参考官方文档:

http://www.jetbrains.org/intellij/sdk/docs/basics/plugin_structure/plugin_configuration_file.html

 

plugin.xml 文件是核心配置文件,你可以理解成 Java web 开发中的 web.xml 文件,Android 开发中的 AndroidManifest.xml 文件。所有的组件的注册都需要在此文件中进行配置,否则该组件不会生效。

plugin.xml 文件所在位置为 /ProjectRoot/resources/META-INF/plugin.xml。如图:

配置文件内容 + 注释描述:


插件的名称,显示在 IDEA 已安装插件列表中(抱歉,之前的文章截图说明中可能有误)插件 ID,用于在插件市场中唯一确定身份的标示,在不同版本中,必须保持一致。
建议设置值为:包名 + 插件名称插件功能说明,显示在插件市场当前插件的副标题位置。插件版本更新内容说明插件版本号当前插件依赖的其他插件的id,本人没用过MySecondPlugin当前插件的起止 IDE 版本支持国际化资源文件messages.MyPluginBundleApplicationComponent 注册,已过时。com.foo.Component1Interfacecom.foo.impl.Component1ImplProjectComponent 组件注册,已过时。com.foo.Component2ModuleComponent 组件注册,已过时。com.foo.Component3Action 组件注册扩展点,即定义当前插件某功能可扩展的点,便于被其他插件依赖,并扩展当前插件不完善的功能扩展,定义具体某类型扩展的实现,扩展其他插件或者 Plugin Platform 默认提供的扩展功能。

在上述代码中都有注释,大概搂了一遍各项配置的含义。下面,针对某几项核心、常用的配置进行更详细的说明:

插件 ID,唯一表示。用户在插件市场众多插件当中唯一确定你的插件。一旦插件 ID 定义好并启用后,后续不可再更改,否则会成为新的插件。

 

插件名称,显示的位置如下图:

 

插件功能说明,如上图中 插件名称下方的描述

插件更新日志描述,建议保留所有版本的更新说明。书写时,建议写上每个版本的版本号,以及内容。内容支持 html 标签,比喻ul,li

插件版本号,如:1.0

 

vendor 标签为作者主站网址和邮箱配置。便于用户有疑问时联系你。

 

actions 标签之间可以配置多个 action 标签。

 


最核心的标签。每一个 action 标签代表一个菜单项或工具栏中的一个按钮。在 action 标签中间,还可以配置 keyboard-shortcut 标签,用来设置快捷键。

 

action 的快捷键标签。

first-keystroke:首选快捷键

second-keystroke:备选快捷键

keymap:默认快捷键

 

至此,常用的核心配置项介绍完毕。

 

 


本文来自互联网用户投稿,文章观点仅代表作者本人,不代表本站立场,不承担相关法律责任。如若转载,请注明出处。 如若内容造成侵权/违法违规/事实不符,请点击【内容举报】进行投诉反馈!

相关文章

立即
投稿

微信公众账号

微信扫一扫加关注

返回
顶部