Previous | Next | See Also
Some features described here are available in Ultimate edition only.

To get access to this dialog box:

  1. Download and install the NodeJS framework.
  2. Make sure the Node.js plugin is installed and enabled.

    The plugin is not bundled with IntelliJ IDEA, but it is available from the JetBrains plugin repository. Once enabled, the plugin is available at the IDE level, that is, you can use it in all your IntelliJ IDEA projects.

In this dialog box, create configurations for running and debugging of nodeJS applications locally. "Locally" in the current context means that IntelliJ IDEA itself starts the NodeJS framework installed on your computer, whereupon initiates a running or debugging session.

This section provides descriptions of the configuration-specific items, as well as the toolbar and options that are common for all run/debug configurations.

ItemDescription
Path to Node In this field, specify the NodeJS installation home. Type the path to the NodeJS executable file manually, or click the Browse button browseButton.png 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:
--debug==<port for connect to debugger remotely> Specify this option to enable remote debugging of the application without re-starting the NodeJS server.
-v, --version Print the current version of NodeJS.
-e, --eval script Evaluate script.
--v8-options Print v8 command line options.
--vars Print various compiled-in variables.
--max-stack-size=val Set max v8 stack size (bytes).
Path to Node App JS file In this field, specify the full path to the NodeJS file to start running or debugging from.

If you are going to debug CoffeeScript, specify the path to the generated JavaScript file with source maps. The file can be generate4d externally or through transpilation using file watchers. For more details, see Transpiling CoffeeScript to JavaScript.

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.
Working directory In this field, specify the location of the files referenced from the starting NodeJS application file, for example, includes. If this file does not reference any other files, just leave the field empty. Choose the folder from the drop-down list, or type the path manually, or click the Browse button browseButton.png and select the location in the dialog box, that opens.
Environment variables In this field, specify the environment variables for the NodeJS executable file, if applicable. Click the Browse button browseButton.png to the right of the field and configure a list of variables in the Environment Variables dialog box, that opens:
  • To define a new variable, click the Add toolbar button add.png and specify the variable name and value.
  • To discard a variable definition, select it in the list and click the Delete toolbar button delete.png.
  • Click OK, when ready

The definitions of variables are displayed in the Environment variables read-only field with semicolons as separators. The acceptable variables are:

NODE_PATH A :-separated list of directories prefixed to the module search path.
NODE_MODULE_CONTEXTS Set to 1 to load modules in their own global contexts.
NODE_DISABLE_COLORS Set to 1 to disable colors in the REPL.
Run with CoffeeScript pluginIf this check box is selected, you can launch the CoffeeScript files directly, without previously transpiling them to JavaScript.
Path to coffee executableSpecify here the path to the executable file that launches the CoffeeScript transpiler.
CoffeeScript parametersSpecify here the parameters to be passed to CoffeeScript.

Toolbar

ItemShortcutDescription
add Insert Click this button to add new configuration to the list.
delete Delete Click this button to remove the selected configuration from the list.
copy Ctrl+D Click this button to create a copy of the selected configuration.
settings Edit defaultsClick this button to edit the default configuration templates. The defaults are used for the newly created configurations.
arrowUp or arrowDown Alt+Up or Alt+Down Use these buttons to move the selected configuration or group of configurations (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.

folder Use this button to create a new folder.

If one or more run/debug configurations have the focus, then the selected run/debug configurations 0 are automatically moved to the newly created folder. If only a category has the focus, then an empty folder is created.

Common options

ItemDescription
NameIn 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.
Temporary configurations limit Specify here the maximum number of temporary configurations to be stored and shown in the Select Run/Debug Configuration drop-down list.
Share Select this check box to make the run/debug configuration 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 and 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 for the ones that are not shared.

This check box is not available when editing the run/debug configuration defaults.

Single instance onlyIf this check box is selected, this run/debug configuration cannot be launched more than once.

Every time a new 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 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 make sense, when 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 launchIn this area, specify the actions to be performed prior to executing the current run/debug configuration.
ItemKeyboard shortcutDescription
addAlt+Insert Click this button to add one of the tasks to be executed prior to launching the application. The possible tasks are:
  • Run External tool: Add this task to have IntelliJ IDEA launch the specified third-party tool prior to running or debugging. To appoint a tool to launch, select it in the External Tools dialog box that opens.
  • Make: Add this task to compile the project automatically, prior to running or debugging. This option helps you ensure that all changes are included and compiled. If there are no changes, the program will just run.
  • Build Artifacts: Add this task to build the specified artifacts prior to running or debugging. To define the artifacts to be built, click the Browse button browse and select the desired artifact from the list of artifacts configured for the current module. To learn more about configuring artifacts, refer to Artifacts section.
  • Run Another Configuration: Add this task to choose one of the already defined temporary or permanent run/debug configurations.
  • Run Ant target:Add this task to build the specified Ant target prior to running or debugging. To define an Ant target, click Browse button browse and select the desired target from the list of existing targets. To learn more about Ant support, refer to Ant Support section.
  • Run Maven goal: Add this task to execute the specified Maven goal prior to running or debugging. To define a Maven goal to be executed, click Browse button browse and select the desired goal from the list. To learn more about Maven support, refer to Maven Support section.
deleteAlt+Delete Click this button to remove selected task from the list.
edit1Enter Click this button to open the selected task for editing.
arrowUp or arrowDownAlt+Up or Alt+Down Click these buttons to move the selected task one line up or down.

Note that Before launch actions are performed in the order they are specified in the run/debug configuration dialog.

Show this pageSelect this check box to always show the Edit Run/Debug Configuration dialog prior to launching the current run/debug configuration.
If this check box is not selected, run/debug configuration will be launched silently.

See Also

Concepts:

Procedures:

Reference:

Web Resources:

JavaScript Support: