intellij-sdk-code-samples/_SUMMARY.md

Summary

• Introduction
• The IntelliJ Platform
• About this Guide
  • Key Topics
  • Contributing
• Getting Help
• Recently Updated

Part I - Plugins

• Introduction
  • Types of Plugins
• Getting Started
  • Setting Up a Development Environment
  • Check Out And Build Community Edition
  • Creating a Plugin Project
  • Build Number Ranges
  • Creating an Action
  • Running and Debugging a Plugin
  • Deploying a Plugin
  • Publishing a Plugin
  • Plugin Structure
    • Plugin Content
    • Plugin Class Loaders
    • Plugin Components
    • Plugin Extensions and Extension Points
    • Plugin Actions
    • Plugin Services
    • Plugin Configuration File
    • Plugin Dependencies
• Project Structure
  • Action System
  • Persisting State of Components
  • PSI Cookbook
  • Virtual File System
• Testing Plugins
  • Tests and Fixtures
  • Light and Heavy Tests
  • Test Project and Testdata Directories
  • Writing Tests
  • Testing Highlighting
• Versioning and Compatibility
  • Breaking API Changes
• Required Technologies
  • Kotlin
  • Gradle
  • Primer for the non-JVM Developer
• Troubleshooting
• Plugin Development FAQ

Part II - Architecture

• Introduction
• Base Platform
  • Components
  • Extension Points
• Project Model
• PSI
  • PSI Files
  • File View Providers
  • PSI Elements
• Features
• Products
• Contributing to the IntelliJ Platform
  • IntelliJ Coding Guidelines

Part III - Base Platform

• Fundamentals
  • Component Model
  • Threading
    • Background Tasks
  • Messaging Infrastructure
• 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
• Settings
• Files
  • Virtual Files
  • Scratch Files
• Documents
• Editors
  • Multiple Carets
• Run Configurations
  • Run Configuration Management
  • Execution
• Version Control Systems
  • Diff
  • Local History
• Indexing
• Tasks and Contexts
• Localization Guide
• Diagrams
• Database Tools

Part IV - Project Model

• Introduction
• Project
  • Project Wizard
  • Frameworks
• Module
• SDK
• Library
• Facet
• Build System
  • External Builder API and Plugins
  • External system integration

Part V - PSI

• What is the PSI?
• PSI Elements
• Navigating the PSI
• Modifying the PSI
• Indexing and PSI Stubs
  • File-based indexes
  • Stub indexes
• References
• Unified AST
• XML DOM API

Part VI - Features

• Navigation
  • Go To Symbol
• Editing
  • Code Completion
  • Templates
    • Live Templates
    • File Templates
    • Surround Templates
  • QuickDoc
  • Intentions
• Analysing
  • Annotator
  • Inspections
    • Profiles
    • Scopes
    • Suppressing Highlights
    • Structural Search
• Refactoring
• Unit Testing

Part VII - Product Specific

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

Part VIII - 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
• Injected Languages
• Project Model
• Build System
• Compiler
• Debugger

Part IX - Custom IDEs

• Build Your Own IDE
• Licensing

Part X - Plugin Repository API

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

Appendix I - Tutorials

• Tutorials
• Gradle Support
  • 1. Prerequisites
  • 2. Deployment
• Custom Language Support
  • 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
• Writing Tests For Plugins
  • 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
• Action System
  • 1. Working With Custom Actions
  • 2. Grouping Actions
• Editor Basics
  • 1. Working With Text
  • 2. Editor Coordinates System. Positions And Offsets
  • 3. Handling Editor Events
• Project Wizard
  • Adding New Steps to Project Wizard
  • Supporting Module Types
• Code Inspections
• Code Intentions
• Live Templates
  • 1. Adding Live Template Support\
• Run Configurations
• Supporting Frameworks
• Tree Structure View
• Kotlin for Plugin Developers

Appendix II - Resources

• Introduction
• IntelliJ Community Edition on GitHub
• IntelliJ Plugins
• IntelliJ Scala Plugin
• Gradle IntelliJ Plugin
• IntelliJ SDK Documentation
• IntelliJ Plugin Verifier
• IntelliJ Plugin Developers Gitter
• Community SDK Forum
• Kotlin Reference