_SUMMARY.md

Summary

• Introduction
• The IntelliJ Platform
  • Contributing to the IntelliJ Platform
  • IntelliJ Coding Guidelines
• About this Guide
  • Key Topics
  • Contributing
• Getting Help
• Recently Updated

Part I - Plugins

• Introduction
  • Types of Plugins
• Getting Started
  • Using Gradle
    • Getting Started with Gradle
    • Publishing Your Plugin
  • Using DevKit
    • Setting Up a Development Environment
    • Creating a Plugin Project
    • Creating an Action
    • Running and Debugging a Plugin
    • Deploying a Plugin
    • Publishing a Plugin
• Custom Plugin Repositories
• Plugin Structure
  • Plugin Content
  • Plugin Class Loaders
  • Plugin Components
  • Plugin Extensions and Extension Points
  • Plugin Actions
  • Plugin Services
  • Plugin Configuration File
  • Plugin Icon
  • Plugin Dependencies
• Kotlin for Plugin Developers
• IDE Development Instances
• Plugin Development FAQ

Part II - Base Platform

• Fundamentals
  • Component Model
  • Disposers
  • Threading
    • Background Tasks
  • Messaging Infrastructure
  • Queries and Query Executors
• User Interface Components
  • Tool Windows
  • Dialogs
  • Popups
  • Notifications
  • File and Class Choosers
  • Editor Components
  • List and Tree Controls
  • Miscellaneous Swing Components
  • Icons and Images
  • Color Scheme Management
• Actions
  • Actions Tutorial
    • 1. Registering an Action
    • 2. Grouping Actions
• Settings
  • Persisting State of Components
  • Editing Settings
• Files
  • Virtual File System
  • Virtual Files
• Documents
• Editors
  • Editor Basics
    • 1. Working With Text
    • 2. Editor Coordinates System. Positions And Offsets
    • 3. Handling Editor Events
  • Multiple Carets
• Run Configurations
  • Run Configuration Management
  • Execution
  • Run Configurations Tutorial
• Version Control Systems
  • Diff
  • Local History
• Tasks and Contexts
• Localization Guide
• Diagrams

Part III - Project Model

• Introduction
• Project
  • Project Wizard
  • Project Wizard Tutorial
    • Adding New Steps to Project Wizard
    • Supporting Module Types
  • Frameworks
• Module
• SDK
• Library
• Facet
• External system integration

Part IV - PSI

• What is the PSI?
• PSI Files
• File View Providers
• PSI Elements
• Navigating the PSI
• References
• Modifying the PSI
• PSI Cookbook
• Indexing and PSI Stubs
  • File-based indexes
  • Stub indexes
• Element Patterns
• Unified AST
• XML DOM API

Part V - Features

• Navigation
  • Go To Symbol
• Editing
  • Code Completion
  • Templates
    • Live Templates
      • 1. Adding Live Template Support
    • File Templates
    • Surround Templates
  • QuickDoc
  • Intentions
• Analysing
  • Annotator
  • Inspections
    • Profiles
    • Scopes
    • Suppressing Highlights
    • Structural Search
• Refactoring
• Project View
  • Modifying Project View Structure
• Unit Testing
• Build System
  • External Builder API and Plugins

Part VI - Testing

• Testing Plugins
  • Tests and Fixtures
  • Light and Heavy Tests
  • Test Project and Testdata Directories
  • Writing Tests
  • Testing Highlighting

Part VII - Custom Languages

• Custom Language Support
  • Registering File Type
  • Implementing Lexer
  • Implementing Parser and PSI
  • Syntax Highlighting and Error Highlighting
  • References and Resolve
  • Code Completion
  • Find Usages
  • Rename Refactoring
  • Safe Delete Refactoring
  • Code Formatter
  • Code Inspections and Intentions
  • Structure View
  • Surround With
  • Go to Class and Go to Symbol
  • Documentation
  • Additional Minor Features
  • To do Explorer
  • Parameter Info
  • Parameter Hints
• Custom Language Support Tutorial
  • 1. Prerequisites
  • 2. Language and File Type
  • 3. Grammar and Parser
  • 4. Lexer and Parser Definition
  • 5. Syntax Highlighter and Color Settings Page
  • 6. PSI Helpers and Utilities
  • 7. Annotator
  • 8. Line Marker Provider
  • 9. Completion Contributor
  • 10. Reference Contributor
  • 11. Find Usages Provider
  • 12. Folding Builder
  • 13. Go To Symbol Contributor
  • 14. Structure View Factory
  • 15. Formatter
  • 16. Code Style Settings
  • 17. Commenter
  • 18. Quick Fix
• Testing a Custom Language Plugin
  • 1. Tests Prerequisites
  • 2. Parsing Test
  • 3. Completion Test
  • 4. Annotator Test
  • 5. Formatter Test
  • 6. Rename Test
  • 7. Folding Test
  • 8. Find Usages Test
  • 9. Commenter Test
  • 10. Reference Test
• Injected Languages
• Build System
• Compiler
• Debugger

Part VIII - Product Specific

• Compatibility with Multiple Products
• Build Number Ranges
• IntelliJ IDEA
  • Tomcat Integration
  • Spring API
• PhpStorm
  • Setting-up the Environment
  • PHP Open API
  • Existing Third Party Plugins
• PyCharm
• DataGrip
• Android Studio
• Rider

Part IX - Custom IDEs

• Build Your Own IDE
• Licensing

Part X - Plugin Repository

• Introduction
• API Reference
  • Plugin Upload
  • Plugins List
  • Plugin Details
  • Plugin Update Download
  • Maven Interface
  • Plugin Developers List
• Plugin Recommendations
• Custom Release Channels

Appendix I - Resources

• Useful Links

Appendix II - Breaking API Changes

• Breaking API Changes
  • 2019.*
  • 2018.*
  • 2017.*
  • 2016.*