About This Guide
This guide is split into several parts, similar to a textbook. Each one builds on the content of the previous section, but it is not necessary to read the guide in order. The Key Topics page aims to link to the pages that are necessary to be able to understand the architecture and get started building plugins.
All source links and reference lists target IntelliJ Platform 2023.1.2.
Part I — Plugins
Describes how to create a plugin that can extend the IntelliJ Platform. Includes details on how to set up the project, register extension points, target specific versions of the IntelliJ Platform, and how to package, deploy, and test your plugins.
Part II — Base Platform
Describes the foundational layer of the architecture, which provides many features and utilities, such as the component model, the user interface, documents and editors, the virtual file system, settings, threading, and background tasks. The Base Platform layer mainly comprises the functionality of the IntelliJ Platform that does not target language features or parsing.
Part III — Project Model
Documents the Project Model, which represents the files and configuration of the currently loaded project, as well as the build system used to build the project.
Part IV — PSI
The Program Structure Interface (PSI) builds the syntactic and semantic models for lots of different file types. This section describes how to work with the PSI, navigating and manipulating the syntax trees, and also looks at the powerful references system, which allows a syntax tree node to reference an item in the semantic model. It also details how PSI creates and uses indexes.
Part V — Features
Describes how to extend and interact with various features that use the PSI layer, such as code completion, navigation, Alt+Enter items, intentions, refactorings, and more. See also the section on Custom Languages below for language-specific features that are only applicable when adding support for a new language.
Part VI — Testing
Describes the available infrastructure for writing automated tests covering the functionality of plugins.
Part VII — Custom Languages
Plugins frequently extend support for existing languages, such as adding inspections to Java files. This section describes how to add support to the IntelliJ Platform for a new language that isn't supported by default, creating parsers, syntactic and semantic models, and all the features that build on top.
Part VIII — Product Specific
A lot of the functionalities in the IntelliJ Platform are language and product agnostic. For example, code inspections work the same in Java as they do in Ruby; it is just the syntax trees and semantic information that is different. This section describes product-specific features, such as specific project model differences and how to target them in a plugin.
Part IX — Custom IDEs
Documents how to use the IntelliJ Platform to create a new, custom IDE, rather than plugins to an existing product, e.g., WebStorm, or Android Studio.
Part X — Themes
Describes how to create a theme for IntelliJ Platform-based IDEs. Includes details on how to set up the theme project, customize, build, and publish it on JetBrains Marketplace.
Appendix I — Resources
Links to useful resources, a Glossary, Extension Point and Listener List, tips on how to Explore the IntelliJ Platform API and Learning Resources.
Appendix II — API and Compatibility
Information on Verifying Plugin Compatibility and list of backwards-incompatible API changes as well as notable changes and new features in each major release of the IntelliJ Platform.
Appendix III — Tooling
Reference and usage guides for commonly used tools like the Gradle IntelliJ Plugin.