CLion 2016.2 Help

Code Style. TypeScript

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

CLion | Preferences | Editor | Code Style | TypeScript for OS X


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

On this page:

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, CLion uses spaces instead of tabs.
Smart tabs
  • If this check box is selected, CLion inserts tabs for indentation and reformatting. CLion inserts tabs in the beginning of each line until a symbol other than the tab is inserted. After that when you press the tab key, CLion will enter 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 cleared, then CLion will keep indents on the empty lines as if they have contained some code.
If this check box is not selected, CLion will delete the tabulation characters.
Indent chained methods Use this check box to configure indentation of chained method calls.

Spaces

Use this tab to specify where you want spaces in your code. To have CLion automatically insert a space at a location, select the check box 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 CLion 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 CLion uses the Wrap on typing option that is specified in the global settings.
  • Yes - in this case CLion 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 check boxes to configure exceptions that CLion will make when reformatting the source code. For example, by default, the Line breaks check box is selected. If your code contains lines that are shorter than a standard convention, you can convert them by disabling the Line breaks check box before you reformat the source code.

Alignment options

ItemDescription
Align when multiline If this check box 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.
Align parenthesised when multiline If this check box is selected, a parenthesised code construct starts at the column of the opening parenthesis each next line. Otherwise, the position of a code construct is determined by the current indentation level.
<character(s)> on next lineSelect this check box to have the specified character or characters moved to the next line when the lines are wrapped.
'else' on new lineUse this check box to have the corresponding statements or characters moved to the next line.
New line after <character> Select this check box to have the code after the specified character moved to a new line.
Special else if treatmentIf this check box 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 check box 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, function 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:
  • Do not force - select this option to suppress introducing braces automatically.
  • When multiline - select this option to have braces introduced automatically, if a statement occupies more than one line. Note that CLion analyzes the number of lines in the entire statement but not only its condition. For example, if the code is
    int foo (int Days) { if ((Days % 10) == 3) return 1; else return 0; }
    CLion will insert braces automatically:
    int foo (int Days) { if ((Days % 10) == 3) { return 1; } else { return 0; } }
  • Always - select this check box to have braces always introduced automatically.

Blank lines

Use this tab to define where and how many blank lines you want CLion 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.
In codeUse this field to set the number of the blank lines.

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.
Use semicolon to terminate statementsSelect this check box to have statements terminated with a semicolon.
Generated Code In this area, configure the code style in import statements, see Creating Imports, section Importing TypeScript Symbols.
  • String literal type: from this drop-down list, choose the type of quotes to be used in import statements. The available options are Single quotes and Double quotes.
Use 'public' modifier Use this check box to have the public access modifier inserted or omitted in the generated code. For example, during generation of a public method from the following:
class Test { public test():void { var x = 1; } }
  • If the check box is selected, the public access modifier is automatically inserted in the generated code:
    class Test { public test():void { this.extracted(); } extracted(){ var x = 1; } }
  • If the check box is cleared, the public access modifier is omitted during code generation:
    class Test { public test():void { this.extracted(); } public extracted(){ var x = 1; } }
See TypeScript Language Handbook, chapter Private/Public Modifiers .

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.

Click Reset to discard changes and return to the initial set of code style settings.

See Also

Reference:

Language and Framework-Specific Guidelines:

Last modified: 20 July 2016