WebStorm 2023.3 Help

Code Style. CoffeeScript

Use this page to configure formatting options for CoffeeScript files. When you change these settings, the Preview pane shows how this will affect your code.

Tabs and Indents

Use tab character

  • If this checkbox is selected, tab characters are used:

    • On pressing the Tab key

    • For indentation

    • For reformatting code

  • If the checkbox is cleared, WebStorm 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 size

In this field, specify the number of spaces that fits in a tab.

Indent

In this field, specify the number of spaces to be inserted for each indent level.

Continuation indent

In this field, specify the number of spaces 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, WebStorm retains indents on empty lines as if they contained some code. If the checkbox is cleared, WebStorm 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 WebStorm to insert spaces automatically. Select the checkboxes next to the description 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 WebStorm will apply to various code constructs on reformatting the source code. Check the results in the Preview pane.

Hard wrap at

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 Hard wrap at field.

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

Visual guides

In this field, specify multiple right margins. You can leave a default value or enter the number of spaces for your margin. If you want to specify several margins, enter numbers separated by comma.

Keep when reformatting

Use the checkboxes to configure exceptions that WebStorm 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 that go 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

  • <character(s)> on next line - Select this checkbox to move the specified character or characters to the next line when the lines are wrapped.

  • New line after <character> - Select this checkbox to move the code after the specified character to a new line.

Blank Lines

Use this tab to define where and how many blank lines you want WebStorm 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

Item

Description

Align object properties

From 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 column

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

Last modified: 20 February 2024