RubyMine 2018.3 Help

Code Style. Ruby

File | Settings | Editor | Code Style | Ruby for Windows and Linux
RubyMine | Preferences | Editor | Code Style | Ruby for macOS
Ctrl+Alt+S icons general settings svg


Use this page to configure formatting options for Ruby files. View the result in the Preview pane on the right.

Tabs and Indents

Item

Description

Use tab character

  • If this checkbox is selected, tab characters are used:
    • On pressing the Tab key

    • For indentation

    • For code reformatting

  • When the checkbox is cleared, RubyMine uses spaces instead of tabs.

Smart tabs

  • If this checkbox is selected, the part of indentation defined by the nesting of code blocks, is made of the tabs and (if necessary) spaces, while the part of indentation defined by the alignment is made only of spaces.

  • If this checkbox is cleared, only tabs are used. This means that a group of spaces that fits the specified tab size is automatically replaced with a tab, which may result in breaking fine alignment.

The Smart Tabs checkbox is available if the Use Tab Character checkbox is selected.

Tab size

In this text box, specify the number of spaces included in a tab.

Indent

In this text box, specify the number of spaces (or tabs if the Use Tab Character checkbox is selected) to be inserted for each indent level.

Continuation indent

In this text box, specify the number of spaces (or tabs if the Use Tab Character checkbox is selected) to be inserted between the elements of an array, in expressions, method declarations and method calls.

Keep indents on empty lines

If this checkbox is selected, then RubyMine will keep indents on the empty lines as if they contained some code.
If this checkbox is cleared, RubyMine will delete the tab characters and spaces.

Use indents relative to expression start

Use this checkbox to switch between the two possible indentation behaviors:
  • If this checkbox is not selected, the blocks of code will be formatted against the closest ancestor block that starts on a new line.

  • If this checkbox is selected, the blocks of code will be formatted in columns.

Indent methods after access modifiers

Select the public, protected or private checkboxes to create an extra indentation after the corresponding access modifier.

Other

Item

Description

Keep existing line breaks

If this checkbox is selected, line breaks are honored when reviewing Ruby files in the editor.

Align multiline list items

If this checkbox is selected, the calls in sequential lines are aligned against :.

Align right parts of assignments or hashes

If this checkbox is selected, the assignments and hashes are aligned against values.

Spaces around curly braces in hashes

If this checkbox is selected, the opening curly brace in a hash is followed by a space, and the closing curly brace is preceded by a space.

Spaces around curly braces in blocks

If this checkbox is selected, the opening curly brace in a block is followed by a space, and the closing curly brace is preceded by a space.

Spaces around hash rockets

If this checkbox is selected, => characters are surrounded with spaces.

Spaces around range operators

If this checkbox is selected, the range characters ... are surrounded with spaces.

Spaces around assignment operators

If this checkbox is selected, the assignment operators are surrounded with spaces, even if they are multilined.

Spaces around relational operators

If this checkbox is selected, the relational operators (like ==, ~=) are surrounded with spaces.

Spaces around other operators

If this checkbox is selected, the operators (like +) are surrounded with spaces.

Keep blank lines in declarations

Specify the number of blank lines in declarations to be kept after reformatting.

Blank lines around methods

Specify the number of blank lines around methods to be kept after reformatting.

Code Generation

Item

Description

Add parentheses around method arguments

Set from...

Click this link to reveal the list of languages to be used as the base for the current language code style. So doing, only the settings that are applicable to the current language are taken. All the other settings are not affected.

This link appears in the upper-right corner of the language-specific code style page, when applicable.

Click Reset to discard changes and return to the initial set of code style settings.

Last modified: 6 December 2018