RubyMine
 
2022.2
Shortcuts: Windows
Get RubyMine
You are viewing the documentation for an earlier version of RubyMine.
  1. Framework-specific guidelines
  2. Sorbet

Sorbet

Last modified: 09 August 2022

Add the 'sorbet' and 'sorbet-runtime' gems to your Gemfile and install them to your project SDK

RubyMine recognizes Sorbet type signatures stored in .rbi files. RubyMine can utilize them to determine types of Ruby objects and check if method arguments or return values match their signatures.

View the type info

  • To view the object type, place the caret at the desired Ruby object and go to View | Type Info Ctrl+Shift+P.

    Viewing type info

Check the types match

  • RubyMine warns you when you try to use method arguments or return values with the types that don't agree with the corresponding Sorbet signatures. You can manage these warnings using the Mismatched argument type and Mismatched return type inspections.

    Incompatible types inspection

Navigate between Ruby and RBI files

RubyMine enables you to navigate from a Ruby declaration to its type signature, and vice versa.

Go to the type signature

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

    https://resources.jetbrains.com/help/img/idea/2022.2/rm_navigate_to_rbi.png
    Gif

Go to the associated Ruby declaration

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

    https://resources.jetbrains.com/help/img/idea/2022.2/rm_navigate_from_rbi_to_rb.png
    Gif

tip

These actions come without default shortcuts. If you use them frequently, consider assigning your own shortcuts.

  1. In the Settings/Preferences dialog (Ctrl+Alt+S), select Keymap.

  2. Find the Go to Type Signature or Associated Declaration action using the search field. Double-click the action to set a shortcut for it.