mihuajun / intellij-sdk-code-samples

Mirror of the IntelliJ SDK Docs Code Samples

IntelliJ Platform SDK Code Samples

Learn how to build plugins using IntelliJ Platform SDK for the JetBrains products by experimenting with our code samples. These samples show you how features work and help you jumpstart your plugins.

There is also IntelliJ Platform Plugin Template project available.

Target Platform

All Code Samples target the latest GA platform release. Previous releases are made available via tags.

Structure

Code Samples depend on the IntelliJ Platform SDK and Gradle as a build system.

The main plugin definition file is stored in the plugin.xml file, which is created according to the Plugin Configuration File documentation. It describes definitions of the actions, extensions, or listeners provided by the plugin.

Code Samples

In the following table, you may find all available samples provided in the separated directories as stand-alone projects available for running with the Gradle :runIde task.

Code Sample	Description
Action Basics	Action and Action Group patterns implementation, adds entries to the Tools menu.
Comparing References Inspection	Local Inspection Tool, adds entries to Preferences | Editor | Inspections | Java | Probable Bugs.
Conditional Operator Intention	Intention action, suggests converting a ternary operator into an if block and adds entry to Preferences | Editor | Intentions | SDK Intentions.
Editor Basics	Basic Editor APIs example with editor popup menu with extra actions.
Facet Basics	Custom Facet pattern, adds SDK Facet to the Project Structure | Project Settings | Facets menu.
Framework Basics	Basic SDK Demo Framework support added to the File | New | Project | IntelliJ Platform Plugin
Inspection Basics	Code Inspection entry added to the Preferences | Editor | Inspections | SDK | Example Tools.
Kotlin Demo	Kotlin example extending the Main Menu with a Greeting menu group.
Live Templates	Live templates for Markdown language, adds an entry to the Preferences | Editor | Live Templates dialog.
Max Opened Projects	Application services and listeners, shows warning dialog when more than 3 open projects are opened.
Module	SDK Demo Module module type added to the File | New | Project....
Product Specific - PyCharm Sample	Plugin project configuration for the PyCharm IDE.
Project Model	Interacts with the project model, adds menu items to Tools and Editor Context menus.
Project View Pane	Project View Pane listing only image files.
Project Wizard	Project Wizard example with demo steps.
PSI Demo	PSI Navigation features presentation.
Run Configuration	Run configuration implementation with factory, options and UI.
Settings	Custom settings panel, adds a settings panel to the Settings | Preferences panel under Tools.
Simple Language Plugin	Custom language support, defines a new Simple language with syntax highlighting, annotations, code completion, and other features.
Theme Basics	Sample UI Theme plugin with basic interface modifications.
Tool Window	Custom Tool Window example plugin.
Tree Structure Provider	Tree Structure Provider showing only plain text files.