RubyMine 2017.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 /help/img/idea/2017.3/settings.png


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

On this page:

Tabs and Indents

ItemDescription
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 sizeIn this text box, specify the number of spaces included in a tab.
IndentIn 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 indentIn 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 linesIf this checkbox is selected, then RubyMine will keep indents on the empty lines as if they contained some code.
If this checkbox is not selected, RubyMine will delete the tab characters and spaces.
Use indents relative to expression startUse 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 modifiersSelect the public, protected or private check boxes to create an extra indentation after the corresponding access modifier.

Other

ItemDescription
Keep existing line breaksIf this check box is selected, line breaks are honored when reviewing Ruby files in the editor.
Align multiline list itemsIf this check box is selected, the calls in sequential lines are aligned against :.
Align right parts of assignments or hashesIf this check box is selected, the assignments and hashes are aligned against values.
Spaces around curly braces in hashesIf this check box 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 blocksIf this check box 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 rocketsIf this check box is selected, => characters are surrounded with spaces.
Spaces around range operatorsIf this check box is selected, the range characters ... are surrounded with spaces.
Spaces around assignment operatorsIf this check box is selected, the assignment operators are surrounded with spaces, even if they are multilined.
Spaces around relational operatorsIf this check box is selected, the relational operators (like ==, ~=) are surrounded with spaces.
Spaces around other operatorsIf this check box is selected, the operators (like +) are surrounded with spaces.
Keep blank lines in declarationsSpecify the number of blank lines in declarations to be kept after reformatting.
Blank lines around methodsSpecify the number of blank lines around methods to be kept after reformatting.

Code Generation

ItemDescription
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.

See Also

Last modified: 15 September 2017