Run/Debug Configuration: NPM
In this dialog, create configurations for running npm and Yarn scripts locally. "Locally" in the current context means that IntelliJ IDEA itself starts Node.js installed on your computer, whereupon initiates script execution.
Learn more from npm and Yarn.
Before you start
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.
From this list, choose the npm CLI command to execute, by default
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
In this field, specify the command line arguments to execute a script with. Learn more from the npm official website.
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:
In this field. specify the package manager to use. If you choose the
| In this field, specify the environment variables for the Node.js executable file, if applicable. Click Browse to the right of the field and configure a list of variables in the Environment Variables dialog, that opens: |
The definitions of variables are displayed in the Environment variables read-only field with semicolons as separators. The acceptable variables are:
When you edit a run configuration (but not a run configuration template), you can specify the following options:
In this field, specify the name for the run/debug configuration. The name will help you identify the created configuration when you choose to edit it later, or when you invoke it, for example, from the Run popup Shift+Alt+F10.
Share through VCS
Select this checkbox to put the run/debug configuration under version control and make it available to other team members.
If the directory-based project format is used, the settings for a run/debug configuration are stored in a separate .xml file in the .idea\runConfigurations folder if the run/debug configuration is shared, or in the .idea\workspace.xml file otherwise.
If the file-based format is used, the settings are stored in the .ipr file for shared configurations, or in the .iws file otherwise.
Allow running in parallel
If this checkbox is selected, it is possible to launch a run configuration multiple times in parallel instead of rerunning it. Each runner will start in its own tab of the Run Tool Window or Debug Tool Window.
When disabled, every time a new instance of the run/debug configuration is launched, IntelliJ IDEA checks the presence of the other instances of the same run/debug configuration, and displays a confirmation dialog. If you click OK in the confirmation dialog, the first instance of the runner will be stopped, and the next one will take its place. This makes sense when launching two instances of run/debug configurations of the same type consumes too much of the CPU and memory resources..
The tree view of run/debug configurations has a toolbar that helps you manage configurations available in your project as well as adjust default configurations templates.
Create a run/debug configuration.
Delete the selected run/debug configuration. Note that you cannot delete default configurations.
Create a copy of the selected run/debug configuration. Note that you create copies of default configurations.
The button is displayed only when you select a temporary configuration. Click this button to save a temporary configuration as permanent.
View and edit the template (that is, the default run/debug configuration settings). The templates are displayed under the Templates node and used for newly created configurations.
Move the selected run/debug configuration up and down in the list.
The order of configurations in the list defines the order, in which the configurations appear when you choose a run/debug configuration.
Default templates of run/debug configurations are always sorted alphabetically.
Move into new folder / Create new folder. You can group run/debug configurations by placing them into folders.
To create a folder, select the configurations within a category, click , and specify the folder name. If only a category is in focus, an empty folder is created.
Then, to move a configuration into a folder, between the folders or out of a folder, use drag or and buttons.
To remove grouping, select a folder and click .
Click this button to sort configurations in the alphabetical order.
In this area you can specify tasks that must be performed before starting the selected run/debug configuration. The tasks are performed in the order they appear in the list.
Click this icon to add one of the following available tasks:
Click this icon to remove the selected task from the list.
Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
Click these icons to move the selected task one line up or down in the list. (The tasks are performed in the order that they appear in the list.)
Show this page
Select this checkbox to show the run/debug configuration settings prior to actually starting the run/debug configuration.
Activate tool window
Otherwise, if the checkbox is cleared, the tool window isn't shown. However, when the configuration is running, you can open the corresponding tool window for it yourself by pressing Alt+4 or Alt+5.