RubyMine 2016.3 Help

Code Style. Ruby

File | Settings | Editor | Code Style | Ruby for Windows and Linux

RubyMine | Preferences | Editor | Code Style | Ruby for OS X


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

Tabs and Indents

ItemDescription
Use tab character
  • If this check box is selected, tab characters are used:
    • On pressing the Tab key
    • For indentation
    • For code reformatting
  • When the check box is cleared, RubyMine uses spaces instead of tabs.
Smart tabs
  • If this check box 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 check box 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 check box is available if the Use Tab Character check box 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 check box 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 check box is selected) to be inserted between the elements of an array, in expressions, method declarations and method calls.
Keep indents on empty linesIf this check box is selected, then RubyMine will keep indents on the empty lines as if they contained some code.
If this check box is not selected, RubyMine will delete the tab characters and spaces.
Use indents relative to expression startUse this check box to switch between the two possible indentation behaviors:
  • If this check box is not selected, the blocks of code will be formatted against the closest ancestor block that starts on a new line.
  • If this check box is selected, the blocks of code will be formatted in columns.

Other

ItemDescription
Keep 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.
Indent when casesIf this check box is selected, the when-else clauses are indented against case.
If this check box is not selected, the when-else clauses aligned against case.
Spaces around curly bracesIf this check box is selected, the opening curly brace is followed by a space, and the closing curly brace is preceded by a space.
Spaces around arrowsIf this check box is selected, => characters are surrounded with spaces.
Keep blank lines in declarationsSpecify the number of blank lines in declarations.
Keep blank lines around methodsSpecify the number of blank lines around methods to be retailed 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: 22 March 2017