WebStorm 2018.3 Help

Auto Import

In JavaScript and TypeScript files, WebStorm automatically adds import statements for modules, classes, components, and any other symbols that can be exported, as well as for XML namespaces. Learn more from Auto import in JavaScript, Auto import in TypeScript and Importing an XML namespace.

Add import statements on code completion

WebStorm adds import statements when you complete exported JavaScript or TypeScript symbols.

You can disable auto import on completion and use quick-fixes instead:

  1. In the Settings/Preferences dialog (Ctrl+Alt+S), click General under editor, and then click Auto Import. The Auto Import page opens.

  2. Use the checkboxes in the TypeScript/JavaScript area to enable or disable import generation on code completion.

Use a quick-fix

For JavaScript symbols from your project dependencies, WebStorm has a quick-fix for adding import statements when they are missing or when auto import is disabled.

WebStorm marks the symbol as unresolved and shows a tooltip:

ws_es6_autoimport_off_tooltip.png
On pressing Alt+Enter, WebStorm displays the suggested quick-fix:
ws_es6_autoimport_off.png
If there's more than one possible source of import, WebStorm shows a list of suggestions:
ws_js_import_quick_fix_multiple_choices.png

Add import statements using the import popup

In TypeScript, WebStorm shows you an import popup. To accept the suggestion, press Alt+Enter:

ws_import_pop_up.png

Optimize imports

WebStorm helps you remove unused imports and organize import statements in the current file, in all files in a directory, or in the entire project at once.

Optimize imports in a file

  • Open the file in the editor or select it in the Project tool window and press Ctrl+Alt+O.

Optimize imports when reformatting a file

You can tell WebStorm to optimize imports in a file every time it is reformatted.

  • Open the file in the editor, press Ctrl+Shift+Alt+L, and make sure the Optimize imports checkbox is selected in the Reformat File dialog that opens. After that every time you press Ctrl+Alt+L in this project, WebStorm will optimize its imports automatically.

Optimize imports in a folder

  • Select the folder in the Project tool window, press Ctrl+Alt+O, and click Run in the Optimize Imports dialog that opens.

Optimize imports only in modified code

If your project is under version control, you can optimize imports only in the updated code. You can also instruct WebStorm to optimize imports in modified files before committing them to VCS.

  • In the Project tool window, select a folder, and press Ctrl+Alt+O. In the Optimize imports dialog, select the Process only VCS changed files and click Run.

  • In the Commit Changes Dialog (Ctrl+K), select the Optimize imports checkbox.

Configure the style of import statements

  1. In the Settings/Preferences dialog (Ctrl+Alt+S), click Code Style under Editor, and then click JavaScript or TypeScript.

  2. Use the controls on the Imports tab to customize the appearance of import statements.

Last modified: 9 January 2019