IntelliJ 平台 SDK 代码示例
通过实验我们的代码示例,学习如何使用 IntelliJ 平台 SDK 为 JetBrains 产品 构建插件。这些示例向您展示了各种功能的工作原理,并帮助您快速开始开发插件。
[!提示] 要开始一个新的插件项目,可以考虑使用 IntelliJ 平台插件模板,它提供了一个纯粹的样板模板,使创建新插件项目变得更加容易。
这些代码示例也可以在 IntelliJ SDK 代码示例 镜像仓库中找到。
要了解更多信息,请浏览可用的扩展点,使用 IntelliJ 平台浏览器 探索开源插件中的扩展点用法,并学习如何探索 IntelliJ 平台 API。
目标平台
所有代码示例都针对最新的正式发布平台版本。 之前的版本可通过 标签 获取。
结构
代码示例依赖于 IntelliJ 平台 SDK 和 Gradle 作为构建系统。
主要的插件定义文件存储在 plugin.xml
文件中,该文件根据 插件配置文件文档 创建。它描述了插件提供的动作、扩展或监听器的定义。
代码示例
请查看 代码示例 主题,了解如何导入和运行代码示例。
在下表中,您可以找到所有可用的示例,这些示例在单独的目录中作为独立项目提供,可以使用 Gradle 的 runIde
任务运行。
代码示例 | 描述 |
---|---|
动作基础 | 动作和动作组模式的实现,向工具菜单添加条目。 |
比较引用检查 | 本地检查工具,向 设置 | 编辑器 | 检查 | Java | 可能的 Bug 添加条目。 |
条件运算符意图 | 意图动作,建议将三元运算符转换为 if 块,并向 设置 | 编辑器 | 意图 | SDK 意图 添加条目。 |
编辑器基础 | 基本编辑器 API 示例,带有额外动作的编辑器弹出菜单。 |
框架基础 | 在 文件 | 新建 | 项目 | Java 向导中添加基本的 SDK 演示框架 支持。 |
Kotlin 演示 | Kotlin 示例,在 主菜单 中扩展 问候 菜单组。 |
实时模板 | Markdown 语言的实时模板,向 设置 | 编辑器 | 实时模板 对话框添加条目。 |
最大打开项目数 | 应用程序服务和监听器,当打开超过 3 个项目时显示警告对话框。 |
模块 | 在 文件 | 新建 | 项目... 向导中添加 SDK 演示模块 模块类型。 |
特定产品 - PyCharm 示例 | PyCharm IDE 的插件项目配置。 |
项目模型 | 与项目模型交互,向 工具 和 编辑器上下文 菜单添加菜单项。 |
项目视图面板 | 仅列出图像文件的项目视图面板。 |
项目向导 | 带有演示步骤的项目向导示例。 |
PSI 演示 | PSI 导航功能演示。 |
运行配置 | 带有工厂、选项和 UI 的运行配置实现。 |
设置 | 自定义设置面板,在 设置 面板的 工具 下添加设置面板。 |
简单语言插件 | 自定义语言支持,定义一个新的 简单语言,具有语法高亮、注释、代码补全和其他功能。 |
主题基础 | 带有基本界面修改的示例 主题 插件。 |
工具窗口 | 自定义工具窗口示例插件。 |
树结构提供程序 | 仅显示纯文本文件的树结构提供程序。 |