Run/Debug Configuration: NPM
In this dialog box, create configurations for running npm scripts locally. "Locally" in the current context means that PhpStorm itself starts the Node.js runtime environment installed on your computer, whereupon initiates script execution.
On this page:
Getting access to the Run/Debug Configuration: NPM dialog
- Install and enable the Node.js plugin. The plugin is not bundled with PhpStorm, but it can be installed from the JetBrains plugin repository as described in Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins.
- Download and install the Node.js runtime environment that contains the Node Package Manager(npm).
Configuration tab
Item | Description | ||||
---|---|---|---|---|---|
Name | In this text box, specify the name of the run/debug configuration. | ||||
Share | Select this check box to make the run/debug configuration available to other team members. The shared run/debug configurations are kept in separate xml files under This check box is not available when editing the run/debug configuration defaults. | ||||
package.json | In this field, specify the package.json file to run the scripts from. Choose the file from the drop-down list which shows all the package.json files detected in the current project or click and choose the required package.json in the dialog box that opens. | ||||
Command | From this drop-down list, choose the npm CLI command to execute, by default run-script is selected. Learn more at npm documentation, under the section CLI Commands. | ||||
Scripts | From this drop-down list, choose the script to which the chosen command will be applied. The list contains all the scripts defined within the scripts property in the Package.json file. | ||||
Arguments | In this field, specify the command line arguments to execute a script with. Learn more at Arguments. | ||||
Node Interpreter | In this field, specify the Node.js interpreter to use. Choose one of the configured interpreters or click and configure a new one as described in Configuring Node.js Interpreters. If you have appointed one of the installations as default, the field displays the path to its executable file. | ||||
Node Options | In this text box, type the Node.js-specific command line options to be passed to the Node.js executable file. The acceptable options are:
| ||||
Environment Variables | In this field, specify the environment variables for the Node.js executable file, if applicable. Click the Browse button to the right of the field and configure a list of variables in the Environment Variables dialog box, that opens:
The definitions of variables are displayed in the Environment variables read-only field with semicolons as separators. The acceptable variables are:
|
Toolbar
Item | Shortcut | Description |
---|---|---|
Alt+Insert | Click this button to add a new configuration to the list. | |
Alt+Delete | Click this button to remove the selected configuration from the list. | |
Ctrl+D | Click this button to create a copy of the selected configuration. | |
Edit defaults | Click this button to edit the default configuration templates. The defaults are used for newly created configurations. | |
or | Alt+Up or Alt+Down | Use these buttons to move the selected configuration or folder up and down in the list. The order of configurations or folders in the list defines the order in which configurations appear in the Run/Debug drop-down list on the main toolbar. |
Sort configurations | Click this button to sort configurations in alphabetical order. |
Common options
Item | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | In this text box, specify the name of the current run/debug configuration. This field does not appear for the default run/debug configurations. | ||||||||||||||||||||||||
Defaults | This node in the left-hand pane of the dialog box contains the default run/debug configuration settings. Select the desired configuration to change its default settings in the right-hand pane. The defaults are applied to all newly created run/debug configurations. | ||||||||||||||||||||||||
Share | Select this check box to make the run/debug configuration available to other team members. The shared run/debug configurations are kept in separate xml files under This check box is not available when editing the run/debug configuration defaults. | ||||||||||||||||||||||||
Single instance only | If this check box is selected, this run/debug configuration cannot be launched more than once. Every time a new run/debug configuration is launched, PhpStorm checks the presence of the other instances of the same run/debug configuration, and displays a confirmation dialog box. If you click OK in the confirmation dialog box, the first instance of the runner will be stopped, and the next one will take its place. This makes sense when the usage of certain resources can cause conflicts, or when launching two run/debug configurations of the same type consumes too much of the CPU and memory resources. If this check box is not selected, it is possible to launch as many instances of the runner as required. So doing, each runner will start in its own tab of the Run tool window. | ||||||||||||||||||||||||
Before launch | Specify which tasks must be performed before applying the run/debug configuration. The specified tasks are performed in the order they appear in the list.
|