IntelliJ Platform Plugin SDK Help

Plugin Content

Plugin distribution will be built using Gradle or Plugin DevKit.

The plugin distribution .jar file contains:

  • configuration file (META-INF/plugin.xml) (Plugin Configuration File)

  • classes implementing the plugin functionality

  • recommended: plugin logo file(s) (META-INF/pluginIcon*.svg) (Plugin Logo)

Targeting a plugin distribution to a specific OS is not possible (issue).

Plugin Without Dependencies

A plugin consisting of a single .jar file is placed in the /plugins directory.

<IDE directory>pluginssample.jar(Plugin distribution)comcompanySample.class(Classcom.company.Sample)...META-INFplugin.xml(Plugin Configuration File)pluginIcon.svg(Plugin Logo)pluginIcon_dark.svg(Plugin Logo, dark variant)

Plugin With Dependencies

The plugin .jar file is placed in the /lib folder under the plugin's "root" folder, together with all required bundled libraries.

All jars from the /lib folder are automatically added to the classpath (see also Plugin Class Loaders).

<IDE directory>pluginssampleliblib_foo.jar(Required bundled library #1)lib_bar.jar(Required bundled library #2)...sample.jar(Plugin distribution)comcompanySample.class(Classcom.company.Sample)...META-INFplugin.xml(Plugin Configuration File)pluginIcon.svg(Plugin Logo)pluginIcon_dark.svg(Plugin Logo, dark variant)
Last modified: 12 July 2024