RubyMine is an IntelliJ Platform-based product. Plugin projects for RubyMine can be developed using IntelliJ IDEA.
RubyMine Plugin Setup Gradle Build ScriptDefine a dependency using rubymine(), see Versions link on top of this page for all available versions. See Local IntelliJ Platform IDE Instance for using a local installation.
A dependency on the bundled org.jetbrains.plugins.ruby plugin must be added using the bundledPlugin() helper.
Minimum build.gradle.kts setup:
repositories { mavenCentral() intellijPlatform { defaultRepositories() } } dependencies { intellijPlatform { rubymine("<versionNumber>") bundledPlugin("org.jetbrains.plugins.ruby") } }
The configuration of RubyMine plugin projects follows the methods described in Using the IntelliJ IDEA Product Attribute and Configuring the plugin.xml File.
The table below summarizes the Gradle IntelliJ Plugin (1.x) 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.
gradle-intellij-plugin Attribute
Attribute Value
IU for IntelliJ IDEA Ultimate.
Set to the same IU BRANCH.BUILD as the RubyMine target version, e.g. 192.7142.36.
org.jetbrains.plugins.ruby:2019.2.20191029 for the Ruby plugin.
See below for Ruby plugin version information.
Path 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 the Modules Specific to Functionality table, the <depends> tags must contain com.intellij.modules.ruby.
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.
RubyMine Test FrameworkTo use existing test base classes, add TestFrameworkType.Plugin.Ruby test-framework available from Plugin Test Frameworks.
Alternatively, specify com.jetbrains.intellij.idea:ruby-test-framework:$VERSION$ as testImplementation dependency explicitly (see IntelliJ Platform Artifacts Repositories).
When learning new APIs, it is helpful to have some representative projects for reference:
19 March 2025
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4