Code Style. YAML

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

GoLand | Preferences | Editor | Code Style | YAML for macOS Ctrl+Alt+S

Use this section to configure formatting options for YAML files. When you change these settings, results of a change are displayed in the Preview pane.

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, GoLand 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. The Smart Tabs checkbox is available if the Use tab character checkbox is selected.
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, GoLand retains indents on empty lines as if they contained some code. If the checkbox is cleared, GoLand deletes the tab characters and spaces on empty lines.
Indent sequence value	If selected, YAML sequence values are indented relative to the parent key item.

Wrapping and braces

In this tab, customize the exceptions, brace placement and alignment options that GoLand 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 GoLand will make when reformatting the source code. For example, by default, the Line breaks checkbox is selected.By default, the Line breaks checkbox is selected. GoLand in this case will ignore line breaks when reformatting the source code. 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 multiline	If 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 line	Select this checkbox to move the specified character or characters to the next line when the lines are wrapped.
'else' on new line	Use 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 treatment	If 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.
Objects	From the list, choose how to align objects: 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.
Variable declarations	Choose 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.
ES6 import/export	Align 'from' clauses: When this checkbox is selected, GoLand aligns `import` and `export` statements in ECMAScript 6 code automatically making your code easier to read and maintain. Compare the appearance of a code fragment with alignment and without it in the Preview pane. With this option on, GoLand will align the new code on the fly. Existing `import` and `export` statements will be aligned after you reformat the code by pressing `Ctrl+Alt+L`, see the Reformat Source Code section for details.

Align values in maps

Use this list to specify how GoLand should align key-value pairs. The available options are:

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.

Braces placement options

Braces placement style

Use this 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 braces

From this 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 GoLand analyzes the number of lines in the entire statement but not only its condition.
if (true) return false;
GoLand will insert braces automatically:

if (true) { return false; }
Always: when this checkbox is selected, GoLand always inserts braces automatically.

Sequence value

Use these options to specify formatting for the YAML sequence values:

Sequence on new line: if selected, each new sequence inside a nested sequences block is put on a separate line:

- - - nested sequences block

Otherwise, nested sequences will be kept on a single line:

- - - nested sequences block
Block mapping on new line: if selected, block mappings inside a sequence are put on a separate line:

- key: value

Otherwise, they are kept on a single line:

- key: value
Automatically insert hyphen on enter: if selected, GoLand will automatically hyphenate the next sequence value when you press Enter.

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: 08 May 2020