RubyMine 2017.3 Help

Code Style. CoffeeScript

File | Settings | Editor | Code Style | CoffeeScript for Windows and Linux
RubyMine | Preferences | Editor | Code Style | CoffeeScript for macOS
Ctrl+Alt+S /help/img/idea/2017.3/settings.png


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

On this page:

Tabs and Indents

Use tab character
  • If this checkbox is selected, tab characters are used for indentation and for code reformatting.
  • When the checkbox is cleared, RubyMine uses spaces instead of tabs.
Smart tabs An indentation consists of two parts. One part results from nesting code blocks and the other part is determined by alignment.
  • If this checkbox is selected, the part that results from nesting contains both tabs and spaces (if necessary), while the part defined by alignment consists only of spaces.
  • If this checkbox is cleared, only tabs are used. This means that after reformatting a group of spaces that fits the specified tab size is automatically replaced with a tab, which may result in breaking fine alignment.
Tab sizeIn this text box, specify the number of spaces that fits 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, RubyMine retains indents on empty lines as if they contained some code. If the checkbox is cleared, RubyMine deletes the tab characters and spaces on empty lines.
Indent chained methods In declarations of functions, the second and further methods in a chain are displayed on a separate line.
  • When the checkbox is selected, the second and further methods in a chain are aligned with the first call.
  • When the checkbox is cleared, the second and further methods in a chain are aligned with the object on which they are invoked.

Spaces

Use this tab to specify where you want RubyMine to insert spaces automatically. Select the checkboxes next to the decription of relevant locations and check the results in the Preview pane.

Wrapping and braces

In this tab, customize the exceptions, brace placement and alignment options that RubyMine will apply to various code constructs on reformatting the source code. Check the results in the Preview pane.

Right Margin (columns)
In this field, specify the number of spaces required to the right of an element. If you accept the Default option then the value from the global settings is used.

Wrap on typing
In this field, specify how the edited text is fitted in the specified Right margin.

  • Default - choose this option to use the Wrap on typing value from the global settings.
  • Yes - choose this option to use the value from the Right Margin field.
  • No - if you choose this option a line can exceed the value specified in the right margin.

Keep when reformatting
Use the checkboxes to configure exceptions that RubyMine will make when reformatting the source code. For example, by default, the Line breaks checkbox is selected. If your code contains lines that are shorter than a standard convention, you can convert them by disabling the Line breaks checkbox before reformatting.

Wrapping options
A wrapping style applies to various code constructs, specified in the left-hand pane (for example, method call arguments, or assignment statements).

Do not wrap When this option is selected, no special wrapping style is applied, the nested alignment and braces settings are ignored.
Wrap if long Select this option to wrap lines going beyond the right margin with proper indentation.
Wrap always Select this option to wrap all elements in lists so that there is one element per line with proper indentation.
Chop down if long Select this option to wrap elements in lists that go beyond the right margin so that there is one element per line with proper indentation.

Alignment options

Align when multilineIf this checkbox is selected, a code construct starts at the same column on each next line. Otherwise, the position of a code construct is determined by the current indentation level.
<character(s)> on next lineSelect this checkbox to move the specified character or characters to the next line when the lines are wrapped.
'else' on new lineUse this checkbox to move the corresponding statements or characters to the next line.
New line after <character> Select this checkbox to move the code after the specified character to a new line.
Special else if treatmentIf this checkbox is selected, else if statements are located in the same line.

Otherwise, else if statements are moved to the next line to the corresponding indent level.

Variable declarationsChoose one of the following options to configure alignment for equality signs:
  • Do not align - the equality signs are not aligned.
  • Align when multiline - the equality signs in multiline var statements are aligned by inserting additional spaces.
  • Align when grouped - the equality signs in multiple var statements are aligned by inserting additional spaces.

Braces placement options

Braces placement style Use this drop-down list to specify the position of the opening brace in class declarations, method declarations, function declarations, and other types of declarations. The available options are:
  • End of line - select this option to place the opening brace at the declaration line end.
  • Next line if wrapped - select this option to place the opening brace at the beginning of the line after the multiline declaration line.
  • Next line - select this option to place the opening brace at the beginning of the line after the declaration line.
  • Next line shifted - select this option to place the opening brace at the line after the declaration line being shifted to the corresponding indent level.
  • Next line each shifted - select this option to place the opening brace at the line after the declaration line being shifted to the corresponding indent level, and shift the next line to the next indent level as well.
Force bracesFrom this drop-down list, choose the braces introduction method for if, for, while, and do () while statements. The available options are:
  • Do not force - select this option to suppress introducing braces automatically.
  • When multiline - select this option to insert braces automatically if a statement occupies more than one line. Note that RubyMine analyzes the number of lines in the entire statement but not only its condition.
  • Always - when this checkbox is selected, RubyMine always inserts braces automatically.

Blank Lines

Use this tab to define where and how many blank lines you want RubyMine to retain and insert in your code after reformatting. The results are displayed in the Preview pane.

Keep Maximum Blank Lines In this area, specify the number of extra blank lines to be kept after reformatting.

Other

ItemDescription
Align object propertiesFrom the drop-down list, select the type of objects' alignment:
  • Do not align: the attributes in sequential lines will be not aligned.
  • On colon: the attributes in sequential lines will be aligned against the colon.
  • On value: the attributes in sequential lines will be aligned against the value.
Line comments at first columnSelect this checkbox to place a line comment in the first column.

Set from

The link appears in the upper-right corner of the page, when applicable. Click this link and choose the language to be used as the base for the current language code style.
To return to the initial set of code style settings and discard the changes, click Reset.

See Also

Reference:

Language and Framework-Specific Guidelines:

Last modified: 15 September 2017