GoLand 1.0 Help

Code Style. Groovy

File | Settings | Editor | Code Style | Groovy for Windows and Linux
GoLand | Preferences | Editor | Code Style | Groovy for macOS
N/A settings


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

Tabs and Indents

ItemDescription
Use tab character
  • If this checkbox is selected, tab characters are used:
    • On pressing the N/A key
    • For indentation
    • For code reformatting
  • When the checkbox is cleared, GoLand 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.
Keep indents on empty linesIf this checkbox is selected, then GoLand will keep indents on the empty lines as if they contained some code.
If this checkbox is not selected, GoLand will delete the tab characters and spaces.
Label indentIn this text box, specify the number of spaces (or tabs if the Use Tab Character checkbox is selected) to be inserted at the next line before a label statement.
Absolute label indentIf this checkbox is selected, label indentation is counted as an absolute number of spaces. Otherwise, label indentation is counted relative to previous indent levels.

Spaces

Use this tab to specify where you want spaces in your code. To have GoLand automatically insert a space at a location, select the checkbox next to this location in the list. The results are displayed in the Preview pane.

Wrapping and braces

In this tab, customize the code style options, which GoLand will apply on reformatting the source code. The left-hand pane contains the list of exceptions (Keep when reformatting), and placement and alignment options for the various code constructs (lists, statements, operations, annotations, etc.) The right-hand pane shows preview.

Alignment takes precedence over indentation options.

Right Margin (columns)

Use Right Margin field to specify a margin space required on the right side of an element. If you select Default option then a value of the right margin from the global settings is used.

Wrap on typing

Use Wrap on typing settings to specify how the edited text is fitted in the specified Right margin. You can select one the following options:

  • Default - in this case GoLand uses the Wrap on typing option that is specified in the global settings.
  • Yes - in this case GoLand uses the value specified in the Right Margin field.
  • No - in this case this option is switched off and a line can exceed the value specified in the right margin.

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. If your code contains lines that are shorter than a standard convention, you can convert them by disabling the Line breaks checkbox before you reformat the source code.

Wrapping options

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

ItemDescription
Wrapping styleFrom this drop-down list, select the desired wrapping style:
  • Do not wrap - when this option is selected, no special wrapping style is applied.

    With this option selected, the nested alignment and braces settings are ignored.

  • Wrap if long - select this option to have lines going beyond the right margin wrapped with proper indentation.
  • Wrap always - select this option to have all elements in lists wrapped so that there is one element per line with proper indentation.
  • Chop down if long - select this option to have elements in lists that go beyond the right margin wrapped so that there is one element per line with proper indentation.

Alignment options

ItemDescription
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 have the specified character or characters moved to the next line when the lines are wrapped.
'else' on new lineUse this checkbox to have the corresponding statements or characters moved to the next line.
New line after <character> Select this checkbox to have the code after the specified character moved 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.

Indent case branches If this checkbox is selected, the case statement is located at the corresponding indent level. Otherwise, case statement is placed at the same indent level with switch.

Braces placement options

ItemDescription
Braces placement style Use this drop-down list to specify the position of the opening brace in class declarations, method declarations, and other types of declarations. The available options are:
  • End of line - select this option to have the opening brace placed at the declaration line end.
  • Next line if wrapped - select this option to have the opening brace placed at the beginning of the line after the multiline declaration line.
  • Next line - select this option to have the opening brace placed at the beginning of the line after the declaration line.
  • Next line shifted - select this option to have the opening brace placed at the line after the declaration line being shifted to the corresponding indent level.
  • Next line each shifted - select this option to have the opening brace placed at the line after the declaration line being shifted to the corresponding indent level, and have the next line shifted 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:

    Blank lines

    Use this tab to define where and how many blank lines you want GoLand to retain and insert in your code after reformatting. For each type of location, specify the number of blank lines to be inserted. The results are displayed in the Preview pane.

    ItemDescription
    Keep Maximum Blank LinesIn this area, specify the number of blank lines to be kept after reformatting in the specified locations.
    Minimum Blank LinesIn the text boxes in this area, specify the number of blank lines to be present in the specified locations.

    Imports

    This table lists actions to be performed when imports are optimized.

    ItemDescription

    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.

    Last modified: 2 November 2017

    See Also

    Language and Framework-Specific Guidelines: