Running NPM Scripts
PyCharm provides interface for running npm scripts. npm scripts support involves:
package.jsonfiles, recognizing definitions of scripts.
- Building trees of scripts.
Navigation between a script in the tree and its definition in the
- Running scripts.
- Configuring the script execution mode and output.
On this page:
- Before You Start
- Building a Tree of Scripts
- Running npm Scripts from the Tree of Scripts
- Running Tasks According to a Run Configuration
- Running npm Scripts Automatically
Before You Start
- Download and install Node.js which contains npm.
- Install and enable the NodeJS plugin. The plugin is not bundled with PyCharm, but it can be installed from the JetBrains plugin repository as described in Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins.
package.jsonfile with the
scriptsproperty with the definitions of the scripts to run.
npm scripts are launched in two ways:
From a tree of scripts in the dedicated NPM Tool Window.
The tool window opens when you invoke npm by choosing Show npm Scripts
on the context menu of a
package.jsonin the Project tool window or of a
package.jsonopened in the editor.
- According to a dedicated run configuration, see Run/Debug Configuration: NPM.
The result of executing a script is displayed in the Run tool window. 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.
Building a Tree of Scripts
If the npm tool window is not opened yet, do one of the following:
Select the required
package.jsonfile in the Project tool window and choose Show npm Scripts on the context menu of the selection.
Open the required
package.jsonfile in the editor and choose Show npm Scripts on the context menu of the editor.
In either case, the npm tool window opens showing the scripts tree built according to the selected or opened
- Select the required
If the npm tool window is already opened, click on the toolbar and
choose the required
package.jsonfile from the list. PyCharm adds a new node and builds a scripts tree under it. The title of the node shows the path to the
package.jsonfile according to which the tree is built.
- To re-build a tree, switch to the required node and click on the toolbar.
Running npm Scripts from the Tree of Scripts
To run a script, 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.
To run the
defaulttask, select the root node in the tree and choose Run default on the context menu of the selection.
- To navigate to the definition of a script, select the required script in the tree and choose Jump to source on the context menu of the selection.
The task or target execution output will be displayed in the Run tool window. The name of the target is shown in the format
<task name>:<target name>. 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.
Running Tasks According to a Run Configuration
Besides using temporary run configurations that PyCharm creates automatically, you can create and launch your own npm run configurations. For details about run configurations, see Run/Debug Configuration and Creating and Editing Run/Debug Configurations.
To create an npm run configuration:
- Choose Edit Configuration from the pop-up menu. on the main menu. Alternatively, click Shift+Alt+F10 and select
- Click the Add New Configuration button on the toolbar and select npm from the pop-up list.
In the Run/Debug Configuration: NPM dialog box that opens, specify the name of the run configuration,
the npm command line command to execute, the scripts to run (use blank spaces as separators),
the location of the
package.jsonfile to retrieve the definitions of the scripts from, and the command line arguments to execute the script with.
Specify the location of the Node executable file and the NodeJS-specific options to be passed to this executable file, see Node parameters for details.
If applicable, specify the environment variables for the NodeJS executable file.
To run a script according to a run configuration, select the run configuration from the list on the main tool bar and then choose Run toolbar button . The output is displayed in the Run tool window.on the main menu or click the
Running npm Scripts Automatically
If you have some scripts that you run on a regular basis, you can add the corresponding run configurations to a list of startup tasks. The tasks will be executed automatically on the project start-up.
- Open the Settings / Preferences Dialog by choosing , and click Startup Tasks under Tools.
- On the Startup Tasks page that opens, click on the toolbar.
From the drop-down list, choose the required npm run configuration. The configuration is added to the list.
If no applicable configuration is available in the project, click and choose Edit Configurations. Then define a configuration with the required settings in the Run/Debug Configuration: NPM page that opens. When you save the new configuration it is automatically added to the list of startup tasks.