JetBrains SDK 中文开发文档¶
这是一个面向中文开发者的 JetBrains IntelliJ Platform Plugin SDK 入门与实践文档。它不是 JetBrains 官方文档的逐字翻译,而是基于官方 SDK 文档重新整理的中文指南,重点帮助你完成一个 IntelliJ 平台插件从创建、运行、扩展、测试到发布的完整路径。
适用范围:IntelliJ IDEA、PyCharm、WebStorm、CLion、GoLand、Rider 等基于 IntelliJ Platform 的 IDE 插件开发。
阅读路线¶
- 平台与插件开发概览
- 创建与运行插件项目
- plugin.xml 配置文件
- Action:菜单、工具栏与快捷入口
- Service:插件中的长期服务对象
- PSI:代码结构模型
- 代码补全、检查与 Quick Fix
- 线程模型、读写动作与后台任务
- 插件测试
- 构建、签名与发布
- 开发检查清单
- Tool Window、设置页与持久化
- 自定义语言支持
- VFS、索引与 Dumb Mode
- 产品兼容、模块与插件依赖
- 扩展点、监听器与动态插件
- 开发实例、调试与兼容性验证
- UI、通知与用户体验
- 运行配置与 Execution API
- Project Model、Workspace Model 与 External System
- 自定义语言实现进阶
- 导航、引用、查找用法与重构
- 调试器与 XDebugger 扩展
- VFS、索引、Gists 与性能实战
- 产品专属 API 与多 IDE 支持
- Remote Development 与 Split Mode
- Marketplace、Logo、签名与发布运营
- 版本迁移、破坏性变更与内部 API
- Gradle 2.x 构建、多模块与发布流水线
- 测试体系、Fixture 与 CI 门禁
- 官方模板、工程结构与 GitHub Actions
- 付费插件、许可校验与商业化
- 调试协议适配与远程调试进阶
- 产品 API 深水区:Java、Kotlin、JavaScript、Python 与 Database
- Marketplace 商业化进阶:审核、隐私、Vendor 与合规
- XDebugger 源码导读:从 API 到 Java 调试器实现
- 官方目录级审计
- Code Insight 细节专题:Inlay、Documentation、Intentions 与 Templates
- UI Guidelines 组件落地专题
- 集成测试专题:Starter、Driver 与 UI 自动化
- Theme 插件开发专题
- 协程、读动作与后台任务进阶
- 平台集成专题:JCEF、Terminal、VCS 与 Trusted Projects
- Workspace Model 深水区
- 官网主题覆盖对照表
快速开始¶
./gradlew runIde
./gradlew buildPlugin
./gradlew verifyPlugin
新插件优先使用 IntelliJ Platform Gradle Plugin 2.x,并将 Gradle 依赖、plugin.xml 依赖和目标 IDE 版本放在同一套兼容性策略下维护。
本项目会持续用 官网主题覆盖对照表 跟踪中文文档与官方 SDK 文档的对应关系。