IntelliJ Platform Plugin SDK Help

RubyMine Plugin Development

Introduction

RubyMine is an IntelliJ Platform-based product. Plugin projects for RubyMine can be developed using IntelliJ IDEA with the gradle-intellij-plugin.

Configuring Plugin Projects Targeting RubyMine

The configuration of RubyMine plugin projects follows the methods described in Configuring Plugin Projects using the IntelliJ IDEA Product Attribute, and Configuring the plugin.xml File.

The table below summarizes the gradle-intellij-plugin attributes to set in the build.gradle file for a RubyMine plugin project. Click on an entry in the table's Attribute column to go to the documentation about that attribute. To see how these attributes appear in a similar build.gradle file for PhpStorm, see Configuring build.gradle using the IntelliJ IDEA Product Attribute.

gradle-intellij-plugin AttributeAttribute Value
intellij.typeIU for IntelliJ IDEA Ultimate.
intellij.versionSet to the same IU BRANCH.BUILD as the RubyMine target version, e.g. 192.7142.36.
intellij.pluginsorg.jetbrains.plugins.ruby:2019.2.20191029 for the Ruby plugin.
See below for Ruby plugin version information.
runIde.ideDirPath to locally installed target version of RubyMine. For example, on macOS:
/Users/$USERNAME$/Library/Application Support/JetBrains/Toolbox/apps/RubyMine/ch-0/192.7142.37/RubyMine.app/Contents.

The required org.jetbrains.plugins.ruby plugin isn't compatible with IntelliJ IDEA Community edition but is compatible with IntelliJ IDEA Ultimate (IU) edition. Product compatibility is determined from the Ruby plugin version page. The Ruby plugin isn't bundled with IU, so the Ruby plugin version must be explicitly declared to support the target RubyMine (and IU) BRANCH.BUILD version. The correct Ruby plugin version is also determined from the Ruby plugin version page.

The dependency on the Ruby plugin APIs must be declared in the plugin.xml file. As described in Modules Specific to Functionality table, the <depends> elements must contain com.intellij.modules.ruby. The dependency declaration is illustrated in the plugin.xml snippet below:

<!-- Requires the Ruby plugin --> <depends>com.intellij.modules.ruby</depends>

Available RubyMine APIs

Use the Exploring APIs as a Consumer process to identify the library ruby.jar. Test your plugin with any version of RubyMine you intend to support.

Open Source Plugins for RubyMine

When learning new APIs, it is helpful to have some representative projects for reference:

Last modified: 17 August 2021