RubyMine 2018.2 Help

Code completion

This section covers various techniques of context-aware code completion that allow you to speed up your coding process.

Basic completion: names and keywords

Basic code completion helps you complete the names of classes, methods, and keywords within the visibility scope. When you invoke code completion, RubyMine analyses the context and suggests the choices that are reachable from the current caret position (suggestions also include Live templates).

If basic code completion is applied to a part of a parameter or variable declaration, RubyMine suggests a list of possible names depending on the item type.

Invoking Basic code completion for the second time shows the list of all declared names.

Invoke basic completion

  1. Start typing a name.
  2. Press Ctrl+Space or choose Code | Completion | Basic from the main menu.
    Basic completion
  3. If_necessary, press Ctrl+Space for the second time (or press Ctrl+Alt+Space).

    This shows the list of all declared names.

    completion basic 2

Hippie completion: expanding words based on context

Hippie completion is a completion engine that analyses your text in the visible scope and generates suggestions from the current context. It helps you complete any word from any of the currently opened files.

Expand a string at caret to an existing word

  1. Type the initial string and do one of the following:
    • Press Alt+Slash or choose Code | Completion | Cyclic Expand Word to search for matching words before the caret.
    • Press Shift+Alt+Slash or choose Code | Completion | Cyclic Expand Word (Backward) to search for matching words after the caret and in other open files.
    The first suggested value appears, and the prototype is highlighted in the source code.
    completion hippie 1
  2. Accept the suggestion, or hold the Alt key and keep pressing / until the desired word is found.
    completion hippie 2

Postfix code completion

Postfix code completion helps you reduce backward caret jumps as you write code. It allows you to transform an already typed expression to a different one based on a postfix you type after the dot, the type of expression, and its context.

Transform a statement with a postfix

  1. Type an expression and then type a postfix after a dot, for example, .if:

    completion postfix 1
  2. (Optional step) If required, select an expression that will be used as a condition:

    completion postfix 2
  3. Press Enter:

    completion postfix 3

To disable certain postfix completion templates, in the Settings/Preferences dialog (Ctrl+Alt+S) select Editor | General | Postfix Completion. You can also choose which key you want to use to expand postfix templates: Tab, Space, or Enter.

You can edit the predefined postfix templates, for example to replace a long key with a shorter one, or to expand the list of expression types it's applicable to.

Completion of tags and attributes

RubyMine automatically completes the names and values of tags and attributes in many file types:

Complete tag names

  1. Press < and start typing the tag name. RubyMine displays the list of tag names appropriate in the current context.
    tags completion
    Use the ArrowUp and ArrowDown buttons to scroll through the list.
  2. Press Enter to accept a selection from the list. If your file is associated with a schema or a DTD, RubyMine automatically inserts the mandatory attributes according to it.

Import a taglib declaration

If you need to use tags declared in a tag library, you need to import this taglib before any custom tag from it can be used.

  1. Start typing a taglib prefix and press Alt+Insert.
  2. Select a taglib from the list and press Enter.
    import2

    RubyMine imports the selected taglib and adds the import statement automatically.

Insert a tag declared in a taglib

  1. Start typing a tag and press Ctrl+Alt+Space.
  2. Select a tag from the list. The uri of the taglib it belongs to is displayed in brackets.
    tagCompletionBefore
  3. Select the desired taglib and press Enter. RubyMine adds the declaration of the selected taglib:
    tagCompletionAfter

Configure code completion settings

Configure completion options

  1. In the Settings/Preferences dialog (Ctrl+Alt+S), select Editor | General | Code Completion.
  2. Do the following:
    • To automatically display the suggestions list, select the Show suggestions as you type checkbox. If the checkbox is cleared, you have to call code completion explicitly by pressing Ctrl+Space for basic completion or Ctrl+Shift+Space for smart completion.

      You can also choose to automatically insert suggestions when there's just one option: select the completion type under Automatically insert single suggestions for.

    • To sort suggestions in the alphabetical order, instead of sorting them by relevance, select the Sort suggestions alphabetically checkbox.

      You can also toggle these modes by clicking a icon or pi icon respectively in the lower-right corner of the suggestions list.

    • If you want case to be taken into account when suggesting completion options, select Match case and choose whether you want to match case for first letters only, or for all letters.
    • If you want the documentation popup to be displayed automatically for each item in the suggestions list as you scroll it, select the Show documentation popup in option. In the field to the right, specify the delay (in milliseconds), after which the pop-up window should appear.

Completion tips and tricks

Narrow down the suggestions list

You can narrow down the suggestions list by typing any part of a word (even characters from somewhere in the middle), or invoking code completion after a dot separator. RubyMine will show suggestions that include the characters you've entered in any positions.

This makes the use of wildcards unnecessary:

completion wildcard

In case of CamelCase or snake_case names, type the initial letters only. RubyMine automatically recognizes and matches the initial letters.

Accept a suggestion

You can accept a suggestion from the list in one of the following ways:

  • Press Enter or double-click a list item to insert it to the left of the caret.
  • Press Tab to replace the characters to the right from the caret.
  • Use Ctrl+Shift+Enter to make the current code construct syntactically correct (balance parentheses, add missing braces and semicolons, etc.)

You can also use specific keys to insert the selected completion suggestion: in the Settings/Preferences dialog (Ctrl+Alt+S) choose Editor | General | Code Completion and select the Insert selected suggestion by pressing space, dot or other context-dependent keys option. These keys depend on the language, your context, etc.

View reference

  • You can use the Quick Definition View by pressing Ctrl+Shift+I when you select an entry in the suggestions list:
    completion quick definition
  • You can use the Quick Information View by pressing Ctrl+Q when you select an entry in the suggestions list:
    completion quick information

View code hierarchy

You can view code hierarchy when you've selected an entry from the suggestions list:

  • Ctrl+H: view type hierarchy
  • Ctrl+Shift+H: view method hierarchy.

Troubleshooting

If code completion doesn't work, this may be due to one of the following reasons:

  • The Power Save Mode is on (File | Power Save Mode). Turning it on minimizes power consumption of your laptop by eliminating the background operations, including error highlighting, on-the-fly inspections, and code completion.
  • An SDK is not configured for your project.
  • Your file doesn't reside in a content root, so it doesn't get the required class definitions and resources needed for code completion.
  • A file containing classes and functions that you want to appear in completion suggestions list is marked as a plain text file.
  • External libraries that contain functions that you want to appear in completion suggestions list are not added as dependencies or global libraries.
Last modified: 31 August 2018

See Also