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 PhpStorm itself starts the NodeJS framework installed on your computer, whereupon initiates a running or debugging session.
On this page:
Getting Access to the Run/Debug Configuration: NodeJS Dialog Box
Install and enable the Node.js plugin.
The plugin is not bundled with PhpStorm, but it is available from the PhpStorm plugin repository. Once enabled, the plugin is available at the IDE level, that is, you can use it in all your PhpStorm projects. See Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins for details.
- Download and install the NodeJS framework 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.
|Node Parameters||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, includes,
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 starting NodeJS application 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:
The definitions of variables are displayed in the Environment variables read-only field with semicolons as separators. The acceptable variables are:
|Path to coffee executable||Specify here the path to the executable file that launches the CoffeeScript transpiler.|
|CoffeeScript parameters||Specify here the parameters to be passed to CoffeeScript.|
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, PhpStorm 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.
However, activating Live Edit in this tab lets you invoke Live Edit without creating a separate configuration, during a debugging session launched through the Node.js 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.
|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.
|Move into new folder / Create new folder||Use this button to create a new folder.
If one or more run/debug configurations are in focus, the selected run/debug configurations are automatically moved to the newly created folder. If only a category is in focus, an empty folder is created.
Move run/debug configurations to a folder using drag-and-drop, or the buttons.
|Sort configurations||Click this button to sort configurations in alphabetical order.|
|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.
|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.