Run/Debug Configuration: Spy-js for Node.js
In this dialog box, create configurations for tracing Node.js applications using the Spy-js tool.
On this page:
- Getting access to the Run/Debug Configuration: Spy-js for Node.js dialog
- Spy-js for Node.js-specific configuration settings
- Toolbar
- Common options
Getting access to the Run/Debug Configuration: Spy-js for Node.js dialog
- Download and install Node.js because it is used by the Spy-js trace server.
- Install and enable the Spy-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.
Spy-js for Node.js-specific configuration settings
Item | Description |
---|---|
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. With Spy-js, it is recommended to use Node.js version 0.10.24 or higher. To enable tracing ECMAScript 6 scripts, use Node.js version 0.11.13 or higher and specify |
Node parameters | In this text box, type the Node.js-specific command line options to be passed to the NodeJS executable file. For example, to enable tracing ECMAScript 6 scripts, specify --harmony as a Node parameter. Note that Node.js must be version 0.11.13 or higher. |
Working directory | In this field, specify the working directory of the application. All references in the starting Node.js 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. |
JavaScript file | In this field, specify the full path to the file to start running the application from. If you are going to trace CoffeeScript, specify the path to the generated JavaScript file. The file can be generated externally or through compilation using file watchers. For more details, seeCompiling CoffeeScript to JavaScript. |
Application parameters | In this text box, type the Node.js-specific arguments to be passed to the application start file through the process.argv array. |
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:
|
Configuration file | From this drop-down list, choose the file with the configuration settings to apply to the tracing session. A configuration file is a JavaScript file with the extension Type the path to the configuration file manually or click the Browse button and choose the location in the dialog box that opens. Once specified, a configuration file is added to the drop-down list so you can get if next time from the list instead of specifying the path. |
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.
|