Run/Debug Configuration: Node JS
In this dialog box, create configurations for running and debugging of NodeJS applications locally. "Locally" in the current context means that WebStorm itself starts the NodeJS runtime environment installed on your computer, whereupon initiates a running or debugging session.
On this page:
- Getting access to the Run/Debug Configuration: NodeJS dialog
- Configuration tab
- Browser / Live Edit tab
- V8 Profiling tab
- Common options
Getting access to the Run/Debug Configuration: NodeJS dialog
- Make sure the Node.js 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.
- Download and install the NodeJS runtime environment that contains the Node Package Manager(npm).
In this field,
specify the NodeJS installation home. Type the path to the NodeJS executable file manually,
or click the button
and select the location in the dialog box, that opens.
If you have appointed one of the installations as default, the field displays the path to its executable file.
In this text box, type the NodeJS-specific command line options to be passed to the NodeJS executable file. The acceptable options are:
In this field,
specify the working directory of the application.
All references in the starting NodeJS application file, for example, imports,
will be resolved relative to this folder, unless such references use full paths.
By default, the field shows the project root folder. To change this predefined setting, choose the desired folder from the drop-down list, or type the path manually, or click the Browse button and select the location in the dialog box, that opens.
In this field, specify the full path to the file to start running or debugging the application from.
|Application Parameters||In this text box, type the NodeJS-specific arguments to be passed to the application start file through the process.argv array.|
In this field, specify the environment variables for the NodeJS 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:
Browser / Live Edit tab
In this tab,
configure the behaviour of the browser and enable debugging the client-side code of the application. This functionality is provided through a
technically, WebStorm creates separate run configurations for the server-side and the client-side code,
but you specify all your settings in one dedicated NodeJS run configuration.
|Open Browser||In the text box in this area, specify the URL address to open the application at. If you select the After Launch check box, the browser will open this page automatically after the application starts. Alternatively you can view the same result by opening the page with this URL address in the browser of your choice manually.|
Select this check box
to have a browser started automatically after a debugging session is launched. Specify the browser to use in the drop-down list next to the check box.
V8 Profiling tab
|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.|
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, WebStorm 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.