This documentation section will help you get started with developing plugins for the Consulo.

There are three supported workflows available for building plugins. The recommended workflow for new projects is to use GitHub Template or to use Maven to create everything from scratch. The old Plugin DevKit workflow still supports existing projects.

The Maven workflow offers several advantages:

• Representations of source sets, modules, and projects are portable,
• Projects of any size or complexity usually require scripts for build management, which Maven handles natively,
• Training, documentation, and community help for general Maven topics are widely available.

Specific to development of Consulo plugins with Maven:

• Changing plugin targets is more comfortable because it is all done in pom.xml:
  • Switching the version of the target Consulo (IDE),
  • Changing the target Consulo-based IDE.
• Maven is fully integrated with Continuous Integration systems, so it is easy to customize and extend the build and publishing processes.

Using GitHub Template

• Developing plugins using GitHub Template

Using Maven

• Developing plugins using Maven
  • Getting Started with Maven
  • Configuring Maven Projects
  • Publishing Plugins with Maven

Using DevKit

• Developing plugins using DevKit
  • Setting Up a Development Environment
  • Creating a Plugin Project
  • Creating Actions
  • Running and Debugging a Plugin
  • Deploying a Plugin
  • Publishing a Plugin