IntelliJ plugins “Where is the documentation”

There isn’t any* *There is a lot of documentation for very specific things

java.io.File

java.io.File VirtualFile

• IntelliJ’s representation of a file. • One for every file. • Exists during entire lifecycle of IntelliJ • When underlying file is deleted, VirtualFile
 remains but isValid() returns false. • VirtualFileListener • VirtualFileManager java.io.File VirtualFile

java.io.File VirtualFile Document

• Loaded in memory on request (cached). • Text level changes (deleteString, insertString) • The editor references a single document • DocumentListener java.io.File VirtualFile Document

java.io.File VirtualFile Document

• Standard AST - rule and terminal nodes. • The file is its own rule and is the
 root (FileASTNode) • Traversal done at runtime
 (findChildByType) java.io.File VirtualFile ASTNode Document

java.io.File VirtualFile ASTNode PsiFile/
 PsiElement Document

java.io.File VirtualFile ASTNode PsiFile/
 PsiElement Document

java.io.File VirtualFile ASTNode PsiFile/
 PsiElement Document

java.io.File VirtualFile ASTNode PsiFile/
 PsiElement Document

• Program Structure Interface • Similar to documents, weakly reference by VirtualFile • The architecture used for all IntelliJ features 
 (autocomplete, refactoring, find usages, etc.) • Maps one to one with ASTNodes (getNode()). • PsiTreeUtil java.io.File VirtualFile ASTNode PsiFile/
 PsiElement Document

• Parser Definitions are per-language • XML and Java already have ParserDefinitions
 (XMLParserDefinition and JavaParserDefinition) • Extend the class to implement for custom
 languages. • Provides implementations of a Lexer and Parser
 for the language to generate the ASTNode tree. • Provides methods to convert ASTNode to PsiElement java.io.File VirtualFile ASTNode PsiFile/
 PsiElement Document ParserDefinition

Application • Only ever one • Manages concurrency (runReadAction/runWriteAction) • Contains state for current IDEA instance (isEAP(),
 getStartTime()) • Contains state of your current thread (isReadAccessAllowed(), isWriteAccessAllowed())

Application Project • One instance per project (IntelliJ window) • Many Managers are per-project and require a project to
 be passed in.

Application Project Module • Many per project • Used to perform searches across dependencies

Application Project Module VirtualFile

Components • Components provide lifecycle callback for Applications, Projects
 and modules • A component is created per instance of Application/Project/Module • Optionally ask for the wrapped object in constructor.

(src/main/resources/META-INF/plugin.xml

Configuration File

Extension Points • Implement an extension point and IntelliJ will instantiate your class
 per application. • Typically defined per-language to avoid unnecessary execution. • Possible to create your own extension point so other plugins can
 extend your functionality.

No content

No content

No content

Documentation • In your editor, type “(ThingYouCareAbout)Manager” and attempt autocomplete. • Open source! kotlin, go, rust, sqldelight. • Look at their plugin.xml files for ideas. • Official intellij documentation 
 (www.jetbrains.org/intellij/sdk/docs/basics/types_of_plugins.html) • Jetbrains community forums. • AOSP

No content

No content

No content