WebStorm 2016.3 Help

NPM Tool Window

Context menu of a package.json - Show npm Scripts
View | Tool Windows | npm
- the tool window can be accessed this way only after you have opened it using the Show npm Scripts command.

On this page:

Accessing the npm Tool Window

The tool window is available only when:

  1. The Node.js runtime environment is installed on your computer.
  2. The NodeJS plugin is enabled. The plugin is bundled with WebStorm and activated by default. If the plugin is not activated, enable it on the Plugins page of the Settings / Preferences Dialog as described in Enabling and Disabling Plugins.
  3. At least one package.json file is available in the current project.

The tool window opens when you invoke npm by choosing Show npm Scripts on the context menu of a package.json in the Project tool window or of a package.json opened in the editor. Use the tool window to run npm scripts.

As soon as you invoke npm, it starts building a tree of scripts defined within the scripts property of the package.json file on which it was invoked. If you have several package.json files in your project, you can build a separate script tree for each of them and run scripts without abandoning the previously built trees. Each tree is shown under a separate node.

Building a Tree of npm Scripts

To build a tree of scripts, do one of the following:

  • Select the required package.json file in the Project tool window and choose Show npm Scripts on the context menu of the selection.
  • Open the required package.json file in the editor and choose Show npm Scripts on the context menu of the editor.
  • If the npm tool window is already opened, click add_black.png on the toolbar and choose the required package.json file from the list. WebStorm adds a new node and builds a scripts tree under it. The title of the node shows the path to the package.json file according to which the tree is built.
  • To re-build a tree, switch to the required node and click icon_reload_grunt.png on the toolbar.

By default, the scripts in a tree a listed in the order in which they are defined in package.json (option Definition order). To have them listed in the alphabetic order, click the viewMode.png toolbar button, then choose Sort by on the menu, and then choose Name.

Running npm Scripts

To run a script from the tree, do one of the following:

  • Double click the required script in the tree.
  • Select the required script and choose Run <script name> on the context menu of the selection.
  • Select the required script and press Enter.

The tool window shows the npm script output, reports the errors occurred, lists the packages or plugins that have not been found, etc. The name of the last executed script is displayed on the title bar of the tool window.

To run several scripts, use the multiselect mode: hold Shift (for adjacent items) or Ctrl (for non-adjacent items) keys and select the required scripts, then choose Run on the context menu of the selection.

Toolbar

ItemTooltipDescription
add_black Add package.json Click this button to have a tree of scripts for another package.json file built. Choose the required package.json file from the pop-up list. WebStorm adds a new node and builds a tree of scripts under it it.
minusSign.png Remove package.json Click this button to remove the tree of scripts under the selected node.
icon_reload_grunt.png Reload scripts Click this button to have the tree of scripts under the selected node re-built. You may need a tree re-built after updating the corresponding package.json file because npm does not apply changes to trees on the fly.
icon_collapse_all_on_title_bar.png Collapse all Click this button to hide all the scripts trees and have only package.json nodes displayed.
viewMode.png Click this button to configure the current view and to change the viewing modes of the tool window, see Viewing Modes for details. Note that most of the menu items are options that you can turn on or off. An option which is on has a check mark to the left of its name. The npm-specific options are:
  • npm Settings: choose this menu item to open the npm Settings dialog and re-configure the current settings for npm and for the Node interpreter, see Running NPM Scripts.
  • Sort by: choose this menu item to configure the order in which scripts are shown in trees. By default, the scripts in a tree a listed in the order in which they are defined in package.json (option Definition order). To have them listed in the alphabetic order, click the viewMode.png toolbar button, then choose Sort by on the menu, and then choose Name.
hideSide.png Hide Click this button to hide the tool window. To have it displayed again, choose View | Tool Windows | Grunt on the main menu. The tool window appears again showing all the previously built trees of tasks.

Context Menu of a Tree

ItemDescription
npm Settings Choose this menu item to open the npm Settings dialog box and view or edit the Node.js configuration
Jump to Source Choose this menu item to open the package.json file for which the current tree is built.
Reload scripts Choose this menu item to have the tree of scripts under the selected node re-built.
Copy Path Choose this menu item to save the path to the package.json file according to which the current tree was built to the clipboard.
Remove package.json Choose this menu item to remove the tree of scripts under the selected node.

Context Menu of a Script

ItemDescription
Run <script name> Choose this menu item to run the selected script.
Edit <script name> settings Choose this menu item to open the Run/Debug Configuration dialog box and edit the predefined settings for the selected script.
Jump to Source Choose this menu item to open the package.json file for which the current tree is built and navigate to the definition of the selected script.

See Also

Last modified: 1 December 2016