RBS

• Having RBS signatures provided, RubyMine uses them to determine types of Ruby elements. To view the element type, place the caret at the desired Ruby element and go to View | Type Info CtrlShift0P.

  

  Gif

RubyMine uses RBS signatures to display types of method parameters in the Parameter info popup. By default, RubyMine shows the popup automatically after you type an opening bracket in the editor, or select a method from the list of suggestions.

• To invoke the Parameter info popup explicitly, go to View | Parameter Info Ctrl0P.

  

• RubyMine warns you when you try to use types that don't agree with the types from RBS files.

  

  You can manage these warnings using the Mismatched type inspections. The inspections are available for:

  • Constant assignments

  • Assignments to instance and class variables (including instance variables in singleton classes/methods)

  • Parameter assignments in methods and blocks

  • Return values of methods and blocks

  • Arguments in methods and yield calls

You can use Quick Documentation to get information about RBS signatures in use.

1. Hover the mouse over the necessary symbol in the editor.

2. Place the caret at the symbol and press Ctrl0Q or select View | Quick Documentation from the main menu.

   Press Ctrl0Q again to open this documentation in the Documentation tool window.

3. Click in the popup to change the font size, display the quick documentation toolbar, or go to the source code.

note

To toggle the focus of the Quick Documentation popup and the Documentation Tool Window, press Ctrl0Q sequentially.

1. In the Project view Alt01, select the directory where you want to create a new RBS file.

2. Press AltInsert and select RBS File/Class from the popup.

   

   As another option, select File | New | RBS File/Class from the main menu.

3. Specify the filename and press Enter.

   tip

   You can use qualified names when creating a new RBS file. RubyMine will split them on the :: symbol and create the surrounding modules for all qualifiers.

• Select a Ruby declaration and go to Navigate | Type Signature to navigate to its type signature.

  

  Gif

• Select a type signature and go to Navigate | Associated Declaration to navigate to the associated Ruby declaration.

  

  Gif

1. Place the caret at the required element and press AltEnter.

2. Select the action to navigate to the required type signature or associated declaration from the list. Press Enter to apply the intention action.

   

   Gif

1. Place the caret at the required element and go to Navigate | Related Symbol CtrlAltHome.

2. Select the desired target from the popup if required.

   

   Gif

1. Press Ctrl twice.

2. Start typing steep init in the search field. Select the command from the list of suggestions and press Enter. RubyMine will generate a Steepfile for your project.

3. Open and edit the generated Steepfile. For example:

   target :lib do
     check "lib"
     signature "sig"
   
     library "set", "pathname"
   end

1. Press Ctrl twice.

2. Start typing steep check in the search field. Select the command from the list of suggestions and press Enter.

   RubyMine will display the command output in the Run tool window.

   

1. In the Settings dialog (CtrlAlt0S), go to Editor | Code Style | Ruby.

2. Configure the desired code style settings.

1. In the Settings dialog (CtrlAlt0S), go to Editor | Color Scheme | Ruby.

2. Select the color scheme, accept the highlighting settings inherited from the defaults or customize them as described in Configure colors and fonts.