RubyMine Plugin Development

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 Gradle build script 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 Gradle build script for PhpStorm, see Configuring Gradle Build Script Using the IntelliJ IDEA Product Attribute.

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

tip

See RubyMine Extension Point and Listener List for the complete list.

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:

• Ruby-Doc-Adder

• Ruby Dynamic Code Insight

• Railways