JetBrains IDE插件开发及发布

JetBrains 插件市场

Developers Page | JetBrains Marketplace

Discover JetBrains Marketplace | JetBrains Marketplace Documentation

环境准备
安装 IntelliJ IDEA（社区版或旗舰版），确保版本与目标 IDE（如 WebStorm、PyCharm 等）兼容。通过 IntelliJ IDEA 的插件开发模板创建新项目，选择 Gradle 或 DevKit（推荐 Gradle 作为构建工具）。

项目结构

• src/main/resources/META-INF/plugin.xml：插件核心配置文件，定义插件名称、版本、依赖等。
• src/main/java 或 src/main/kotlin：主要代码目录，支持 Java 或 Kotlin 开发。
• build.gradle.kts 或 build.gradle：Gradle 构建脚本，声明依赖和打包配置。

核心开发步骤

1. 定义插件入口
   在 plugin.xml 中配置扩展点（如 applicationService 或 projectService），注册自定义组件。

   <extensions defaultExtensionNs="com.intellij"><applicationService serviceInterface="com.example.MyService" serviceImplementation="com.example.MyServiceImpl"/>
   </extensions>
   

2. 实现功能逻辑
   通过 IntelliJ Platform SDK 提供的 API 访问 IDE 功能（如编辑器操作、文件系统）。例如，创建一个动作（Action）：

   class MyAction : AnAction() {override fun actionPerformed(e: AnActionEvent) {e.project?.showMessage("Hello from plugin!")}
   }
   

3. 调试插件
   使用 Gradle 任务 runIde 启动沙盒环境测试插件。通过 Run/Debug Configurations 配置自定义 IDE 实例。

---

JetBrains 插件发布

准备工作

1. 注册 JetBrains 账号并申请发布权限（JetBrains Marketplace）。
2. 在 plugin.xml 中填写完整的元数据（描述、版本号、兼容性范围）。

打包插件

• Gradle 方式：执行 buildPlugin 任务生成 .zip 文件（位于 /build/distributions）。
• 手动方式：通过菜单 Build > Prepare Plugin Module for Deployment 生成 .jar 文件。

发布流程

1. 登录 JetBrains Marketplace，进入 Upload Plugin 页面。
2. 上传插件包并填写更新日志、定价模型（免费或付费）。
3. 提交后等待审核（通常需 1-3 个工作日）。

更新插件
修改 plugin.xml 中的版本号，重新打包并上传。Marketplace 会自动提示用户更新。

---

注意事项

• 兼容性：在 plugin.xml 中指定支持的 IDE 版本范围（如 <idea-version since-build="203" until-build="223.*"/>）。
• 依赖管理：通过 Gradle 声明第三方库依赖，避免冲突。
• 文档：提供清晰的用户指南和代码注释以提升审核通过率。

参考官方文档：IntelliJ Platform Plugin SDK 获取最新 API 和最佳实践。