WebStorm 2018.2 Help

Code Style. TypeScript

File | Settings | Editor | Code Style | TypeScript for Windows and Linux
WebStorm | Preferences | Editor | Code Style | TypeScript for macOS
Ctrl+Alt+S icons general settings svg


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

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, 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 text box, specify the number of spaces that fits in a tab.

Indent

In 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 indent

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

Indent all chained calls in a group

The checkbox is available only when the Indent chained methods checkbox is selected.

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

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.

Objects

From the drop-down 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, WebStorm 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.
ws_align_import_export_es6.png

With this option on, WebStorm 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.

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 braces

From 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 WebStorm analyzes the number of lines in the entire statement but not only its condition.

  • Always - when this checkbox is selected, WebStorm always inserts braces automatically.

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.

Minimum Blank Lines

In this area, configure whether to have or not to have extra empty lines after the blocks of import statements and around classes, fields, methods, or functions.
In the text box next to each option, specify the minimum number of extra blank lines to be left.

Punctuation

Use the drop-down lists in this tab to form directives in automatic insertion of terminating semicolons, single and double quotes, and trailing commas.

Semicolon to terminate statements

  • Use semicolon to terminate statements in new code

  • Use semicolon to terminate statements always

  • Don't use semicolon to terminate statements in new code

  • Don't use semicolon to terminate statements always

Quotes

  • Use double quotes in new code

  • Use double quotes always

  • Use single quotes in new code

  • Use single quotes always

Trailing comma

Use this drop-down list to configure whether you want to use trailing commas in objects, arrays, and for the parameters in method definitions and calls. The available options are:
  • Keep
  • Remove
  • Add when multiline

Code Generation

On this tab, configure the code style for generated code.

Use 'public' modifier

Use this checkbox 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 checkbox is selected, the public access modifier is automatically inserted in the generated code:

    class Test { public test():void { this.extracted(); } public extracted() { var x = 1; } }

  • If the checkbox is cleared, the public access modifier is omitted during code generation:

    class Test { public test():void { this.extracted(); } extracted() { var x = 1; } }

See TypeScript Language Handbook, chapter Private/Public Modifiers.

Naming conventions

In this area:
  • Configure or accept default prefixes that will be added automatically to the names of generated fields and properties.

  • Choose the style for the names of generated files. For example, when WebStorm suggests moving a class to a new automatically generated file the suggested name of this file is generated from the class name in accordance with the chosen style. Learn more from Keeping the names of classes and containing files in compliance

Comment Code

In this area, configure code style for generated comments.
  • Include types in JSDoc - select this checkbox to add types for @param, @return, and other tags automatically. Note that type information is extraneous for TypeScript as types are retrieved from the code itself. Accordingly, the checkbox is cleared by default.

  • Line comment at first column - select this checkbox to start line comments at the first column. When the checkbox is cleared, line comments are aligned in the code.

  • Add a space at comment start - when this checkbox is selected, a space will be inserted between a line comment character and the first character of a commented line.

Imports

Merge imports for members from the same module

  • When this checkbox is selected, imported symbols from the same module are listed in one import statement with a comma as separator. The members are listed in the order in which they are imported. To arrange them alphabetically, select the Sort imported members checkbox and run Code | Optimize Imports.

  • When this checkbox is cleared, for each imported symbol a separate import statement is generated.

Use paths relative to tsconfig.json

When this checkbox is selected, WebStorm calculates import paths using the tsconfig.json file as the root. When this checkbox is cleared, WebStorm calculates import paths relative to the project root.

For example, if your project is structured as follows:

ws ts import example

With the checkbox selected, WebStorm generates the following import statement:

import {ClassName} from 'directory_2/file_2'

If the checkbox is cleared, the following import statement is generated:

import {ClassName} from '../directory_2/file_2'

Use directory import (Node-style module resolution)

Use .js file extension in module name

When this checkbox is selected, WebStorm automatically adds the js extensions to the names of ES6 modules in import statements. This is important when you use ES6 modules in a browser that requires full file names (for example, in Chrome). WebStorm applies this setting both when it generates an import statement automatically, on code completion, or when you invoke import generation with Alt+Enter.

Do not import exactly from

In this field, specify the exact paths that WebStorm should skip during automatic import of a symbol. Instead, WebStorm will look for alternative paths to import the symbol.

This is particularly useful for modules that allow importing their submodules instead of the entire module. For example, to prefer imports like import {Observable} from 'rxjs/Observable' to a more general import {Observable} from 'rxjs', add rxjs to the list.

To manage the list of modules to skip:

  1. Click icons general expandComponent svg to the right of the field.

  2. In the Change modules dialog box that opens, click Add icon and specify the module name in the Add module dialog box. To remove a module from the list, select it and click icons general remove svg.

Sort imported members

  • When this checkbox is selected, WebStorm lists the imported members in merged import statements alphabetically. Note that the members are listed comma-separated in the order they are imported and re-sorted only when you run Code | Optimize Imports.

  • When this checkbox is cleared, the members in merged import statements are always listed comma-separated in the order they are imported.

Sort imports by modules

  • When this checkbox is selected, import statements are re-sorted alphabetically by the module names when you run Code | Optimize Imports.

  • When this checkbox is cleared, import statements are always shown in the order they are generated and this order is not changed after you run Code | Optimize Imports.

Arrangement

In this tab, define a set of rules to rearrange your TypeScript code according to your preferences.

Grouping Rules

Use this area to set the grouping rules.
  • Group property field with corresponding getter/setter

Matching rules

Use this area to define elements order as a list of rules, where every rule has a set of matches such as modifier or type.
  • icons general add svg - use this button to add a rule. The empty rule area opens.

  • icons general remove svg - use this button to remove the rule from the list.

  • icons actions edit svg - use this button to edit an existing rule. To see this button, navigate to the rule that you want to edit and click on the button. In pop-up window that opens, modify the rule fields.

  • icons actions previousOccurence svg icons actions nextOccurence svg - use these buttons to move the selected rule up or down.

Empty rule

Use this area to create a new matching rule or edit an existing one. You can select from the following filters:
  • Type - use this filter to choose constructors, methods, fields, or properties for your rule.
    Note that clicking a type keyword twice negates the condition.

  • Modifier - use this filter to select the types of modifiers for the rule.
    Note that clicking a modifier keyword twice negates the condition.

  • Name - use this field to specify entry names in the rule. This filter matches only entry names, such as field names, method names, class names, etc. The filter supports regular expressions and uses a standard syntax. The match is performed against the entire name.

  • Order - use this drop-down list to select the sorting order for the rule. This option is useful when more than one element uses the same matching rule. In this case, selecting Keep order will keep the same order as was set before the rearrangement and selecting Order by Name will sort the elements with the same matching rule by their names.

icon sort

This icon appears when you select Order by Name from the Order list. The icon indicates that the items in this rule are sorted alphabetically.

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: 2 October 2018

See Also

Reference:

Language and Framework-Specific Guidelines: