RBS

RBS type signatures

RubyMine supports RBS type signatures and uses them to infer the type of Ruby elements. This helps you to experience the better code insight when developing your code in Ruby.

If you have RBS files in your project, RubyMine provides:

• Better method name completion

  RubyMine displays methods from appropriate classes at the beginning of the list, when invoking code completion.

  

• Improved navigation actions

  When you invoke the 'Go to declaration' action, RubyMine navigates you to the exact declaration instead of providing a list of declarations to choose from.

  

  Gif

• Search for usages of the corresponding declaration

  With RBS types, RubyMine can find the correct declaration of a Ruby element. When you invoke the 'Find usages' action, RubyMine instantly finds usages of the corresponding declaration instead of giving you a list of declarations to choose from.

  

  Gif

• Consistent rename refactorings

  RubyMine finds all usages of a particular Ruby element that you are renaming. After invoking the 'Find usages' action, there will be fewer references marked as 'Untyped (potential) usages'.

  

Installation

note

The rbs gem comes bundled with Ruby 3.0.0 (and later).

If you use earlier versions of Ruby, add the following line to your Gemfile:

gem 'rbs'

The rbs gem provides a set of built-in type signatures for the standard libraries out-of-the-box. When you use rbs in your project, RubyMine displays its sources in external libraries.

Create an RBS file

Configure code style settings

RubyMine applies the same code style settings for both Ruby and RBS. To customize code style settings for RBS:

Configure syntax highlighting

RubyMine uses the Ruby color scheme to highlight the syntax in RBS files.

You can configure RBS-aware syntax highlighting according to your preferences and habits.