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

When you complete a ES6 symbol or a CommonJS module, WebStorm either decides on the style of the import statement itself or displays a popup where you can choose the style you need. Learn more from Auto-import in JavaScript.

Add import statements on code completion

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

Add ES6 imports on code completion

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

  1. In the Settings/Preferences dialog Ctrl+Alt+S, go to Editor | General | Auto Import.

  2. On the Auto Import page that opens, 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 with the suggested quick-fix:

ws_es6_autoimport_off_tooltip.png

Alternatively, press Alt+Enter:

ws_es6_autoimport_off.png

If there's more than one possible source of import, WebStorm shows a list of suggestions:

Autoimport with quick-fix: multiple choices

If you don't want to see Missing import statement warnings, disable the inspection in the current file or in the entire project, see Disabling and enabling inspections for details.

Disable Missing import statement inspection

Alternatively, change highlighting level for the file: hover the mouse over the widget in top-right corner of the editor and select None or Syntax from the Highlight list.

Hide Missing import statement warning

Add import statements using the auto-import tooltip

In TypeScript, WebStorm shows you an auto-import tooltip. To accept the suggestion, press Alt+Enter.

Add import statements using the auto-import tooltip

To disable the popup, hover the mouse over the inspection widget in the top-right corner of the editor, click More, and clear the Show Auto-Import Tooltip option.

Disable auto-import tooltip

Learn more from Auto-import in TypeScript.

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 all imports

  1. Select a file or a directory in the Project tool window (View | Tool Windows | Project).

  2. Do any of the following:

    • From the main menu, select Code | Optimize Imports (or press Ctrl+Alt+O).

    • From the context menu, select Optimize Imports.

  3. (If you've selected a directory) Choose whether you want to optimize imports in all files in the directory, or only in locally modified files (if your project is under version control), and click Run.

Optimize imports in a single 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+Alt+Shift+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 before committing changes to your VCS

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.

Automatically optimize imports on save

You can configure the IDE to optimize imports in modified files automatically when your changes are saved.

  1. In the Settings/Preferences dialog Ctrl+Alt+S, select Tools | Actions on Save.

  2. Enable the Optimize imports option and apply the changes.

Configure the style of import statements

  1. To configure the style for JavaScript or TypeScript imports, open the Settings/Preferences dialog Ctrl+Alt+S, go to Editor | Code Style | JavaScript or to Editor | Code Style | TypeScript, and use the controls on the Imports tab to customize the appearance of import statements. See JavaScript code style: Imports and TypeScript code style: Imports for details.

  2. In the CSS, SCSS, and Less context, WebStorm by default uses double quotes for generated string literals in import statements and URLs. To use single quotes, Open the Settings/Preferences dialog Ctrl+Alt+S, go to Editor | Code Style | Style Sheets | <your Style Sheet language>, open the Other tab, and select Single from the Quote marks list.

    To apply the chosen style to the entire file after reformatting, select the Enforce on format checkbox below the list.

Last modified: 13 October 2021