Plugin Configuration File

id

A unique identifier of the plugin. It should be a fully qualified name similar to Java packages and must not collide with the ID of existing plugins. The ID is a technical value used to identify the plugin in the IDE and JetBrains Marketplace. Please use characters, numbers, and '.'/'-'/'_' symbols only and keep it reasonably short.

Required

no; ignored in an additional config file
It is highly recommended to set in plugin.xml file.
The element can be skipped in the source plugin.xml file if the Gradle plugin patchPluginXml task (2.x, 1.x) is enabled and configured.

Default value

Value of the <name> element.

Example

<id>com.company.framework</id>

name

The user-visible plugin display name (Title Case).

Required

yes; ignored in an additional config file

Example

<name>My Framework Support</name>

version

The plugin version displayed in the Plugins settings dialog and on the JetBrains Marketplace plugin page. Plugins uploaded to the JetBrains Marketplace must follow semantic versioning.

Required

yes; ignored in an additional config file
The element can be skipped in the source plugin.xml file if the Gradle plugin patchPluginXml task (2.x, 1.x) is enabled and configured.

Example

<version>1.3.18</version>

product-descriptor

Paid or Freemium plugin descriptor.

Required

only for paid or freemium plugins; ignored in an additional config file
Do not add <product-descriptor> element in a free plugin.

Attributes

• code (required)
  The plugin product code used in the JetBrains Sales System. The code must be agreed with JetBrains in advance and follow the requirements.

• release-date (required)
  Date of the major version release in the YYYYMMDD format.

• release-version (required)
  A major version in a special number format.

• optional (optional)
  The boolean value determining whether the plugin is a Freemium plugin.
  Default value: false.

• eap (optional)
  

  Specifies the boolean value determining whether the plugin is an EAP release.
  Default value: false.

idea-version

The plugin's range of compatible IntelliJ-based IDE versions.

Required

yes; ignored in an additional config file
The element can be skipped in the source plugin.xml file if the Gradle plugin patchPluginXml task (2.x, 1.x) is enabled and configured.

Attributes

• since-build (required)
  The lowest IDE version compatible with the plugin.

• until-build (optional)
  

  The highest IDE version compatible with the plugin. Undefined value declares compatibility with all the IDEs since the version specified by the since-build (also with the future builds that may cause incompatibility errors).

Examples

• Compatibility with a specific build number (2021.3.3) and higher versions:

  <idea-version since-build="213.7172.25"/>

• Compatibility with versions from any of 213 branches to any of 221 branches:

  <idea-version since-build="213" until-build="221.*"/>

vendor

The vendor name or organization ID (if created) in the Plugins settings dialog and on the JetBrains Marketplace plugin page.

Required

yes; ignored in an additional config file

Attributes

• url (optional)
  The URL to the vendor's homepage. Supports https:// and http:// scheme links.

• email (optional)
  

  The vendor's email address.

Examples

• Personal vendor with an email address provided:

  <vendor email="joe@example.com">Joe Doe</vendor>

• Organizational vendor with a website URL and email address provided:

  <vendor url="https://mycompany.example.com" email="contact@example.com"> My Company </vendor>

description

The plugin description displayed on the JetBrains Marketplace plugin page and in the Plugins settings dialog.

Simple HTML elements, like text formatting, paragraphs, lists, etc., are allowed and must be wrapped into <![CDATA[... ]]> section.

Required

yes; ignored in an additional config file
The element can be skipped in the source plugin.xml file if the Gradle plugin patchPluginXml task (2.x, 1.x) is enabled and configured.

Example

<description><![CDATA[ Provides support for My Framework. The support includes: <ul> <li>code completion</li> <li>references</li> </ul> For more information visit the <a href="https://example.com">project site</a>. ]]></description>

change-notes

A short summary of new features, bugfixes, and changes provided with the latest plugin version. Change notes are displayed on the JetBrains Marketplace plugin page and in the Plugins settings dialog.

Simple HTML elements, like text formatting, paragraphs, lists, etc., are allowed and must be wrapped into <![CDATA[... ]]> section.

Required

no; ignored in an additional config file
The element can be skipped in the source plugin.xml file if the Gradle plugin patchPluginXml task (2.x, 1.x) is enabled and configured.

Example

<change-notes><![CDATA[ <h2>New Features</h2> <ul> <li>Feature 1</li> <li>Feature 2</li> </ul> <h2>Bug Fixes</h2> <ul> <li>Fixed issue 1</li> <li>Fixed issue 2</li> </ul> ]]></change-notes>

depends

Specifies a dependency on another plugin or a module of an IntelliJ Platform-based product. A single <idea-plugin> element can contain multiple <depends> elements.

Required

no; in most cases dependency on the platform module is needed

Attributes

• optional (optional)
  Boolean value defining whether the dependency is optional to load the plugin in the IDE. If the dependency plugin is not installed in the current IDE, and optional is:

  • true - the plugin will be loaded

  • false (default) - the plugin will not be loaded

• config-file (required when optional is true)
  

  Relative path to an additional configuration file, loaded only if the dependency plugin is installed in the current IDE.

Examples

• Required plugin dependency:

  <depends>com.example.dependencypluginid</depends>

• Required dependency on the IntelliJ IDEA Java Module:

  <depends>com.intellij.modules.java</depends>

• Optional plugin dependency:

  <depends optional="true"> com.example.dependencypluginid </depends>

• Required module dependency with additional configuration:

  <depends config-file="myPluginId-withJava.xml"> com.intellij.modules.java </depends>

• Optional module dependency with additional configuration:

  <depends optional="true" config-file="myPluginId-withKotlin.xml"> org.jetbrains.kotlin </depends>

incompatible-with

Declares incompatibility with a provided module.

Required

no; ignored in an additional config file

Example

<incompatible-with> com.intellij.modules.appcode.ide </incompatible-with>

extensions

Defines the plugin extensions.

Required

no

Attributes

• defaultExtensionNs (optional)
  

  Default extensions namespace. It allows skipping the common prefix in fully qualified extension point names. Usually, the com.intellij namespace is used when the plugin implements IntelliJ Platform extensions.

Children

The children elements are registrations of the extension points defined by <extensionPoint> elements. Extension elements names follow the EPs names defined by name or qualifiedName attributes.

Examples

• Extensions' declaration with the default namespace:

<extensions defaultExtensionNs="com.intellij"> <applicationService serviceImplementation="com.example.Service"/> </extensions>

• Extensions' declaration using the fully qualified extension name:

<extensions> <com.example.vcs.myExtension implementation="com.example.MyExtension"/> </extensions>

extensionPoints

Extension points defined by the plugin.

Required

no

Children

• <extensionPoint>

resource-bundle

A resource bundle to be used with message key attributes in extension declarations and for action and group localization. A single <idea-plugin> element can contain multiple <resource-bundle> elements.

Required

no

Example

To load the content of messages/Bundle.properties bundle, declare:

<resource-bundle>messages.Bundle</resource-bundle>

actions

Defines the plugin actions.

Required

no

Attributes

• resource-bundle (optional; available since 2020.1)
  

  Defines the dedicated actions resource bundle. See Localizing Actions and Groups for more details.

Children

• <action>

• <group>

• <reference>

Example

<actions resource-bundle="messages.ActionsBundle"> <!-- Actions/Groups defined here will use keys from the ActionsBundle.properties bundle. --> </actions>

applicationListeners

Defines the application-level listeners.

Required

no

Children

• <listener>

projectListeners

Defines the project-level listeners.

Required

no

Children

• <listener>