RubyMine 6.3.0 Web Help

To get access to this dialog box:

  1. Make sure the Node.js plugin is installed and enabled.

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

  2. Download and install the NodeJS framework that contains the Node Package Manager(npm).

In this dialog box, create configurations for running and debugging of NodeJS applications locally. "Locally" in the current context means that RubyMine 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.

On this page:

Configuration Tab

Item Description
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-brk==<port for connect to debugger remotely>

Note

  • With the --debug-brk option, the execution of the application suspends right after launch. This option allows you to debug the code executed on start.
  • With the --debug option, the code that has to be executed on the application start is executed whereupon the application waits for a debugger to connect to it. This option is useful when you are not going to debug Node.js right now, but you want to debug it later.
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 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 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 plugin If this check box is selected, you can launch the CoffeeScript files directly, without previously transpiling them to JavaScript.
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, enable the Live Edit functionality during a Node.js debugging session. This functionality is provided through a JavaScript Debug run configuration, so technically you need to create two configurations: Node.js for initiating a debugging session and JavaScript Debug to have Live Edit at disposal.

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.

For more information, see Live Editing of HTML, CSS, and JavaScript.

Item Description
After launch 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.
  • To use the system default browser, choose Default.
  • To use a custom browser, choose it from the list. Note that Live Edit is fully supported only in Chrome.
  • To configure browsers, click the Browse button browseButton and adjust the settings in the Web Browsers dialog box that opens. For more information, see Configuring Browsers.
With JavaScript debugger Select this check box to enable the JavaScript debugger in the selected browser.

Toolbar

Item Shortcut Description
add Alt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+InsertCtrl+N or Alt+InsertAlt+InsertAlt+InsertCtrl+N or Ctrl+EnterCommand N or Control EnterControl N or Control EnterCommand N or Control EnterControl N or Control Enter Click this button to add new configuration to the list.
delete Alt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteMeta+DeleteCommand Delete or Command BackspaceCommand DeleteCommand Delete or Command BackspaceCommand Delete Click this button to remove the selected configuration from the list.
copy Ctrl+DCtrl+DCtrl+DCtrl+DMeta+DCtrl+DCtrl+D, Ctrl+Shift+Down or Ctrl+Shift+UpCtrl+DCtrl+Shift+DCommand DCommand DCommand DCommand D Click this button to create a copy of the selected configuration.
settings Edit defaults Click this button to edit the default configuration templates. The defaults are used for the newly created configurations.
arrowUp or arrowDown Alt+UpAlt+UpAlt+UpAlt+UpAlt+Up or Ctrl+Alt+AAlt+UpCtrl+Alt+UpCtrl+Shift+UpCtrl+UpControl UpControl UpControl Alt UpControl Up or Alt+DownAlt+DownAlt+DownAlt+DownAlt+Down or Ctrl+Alt+EAlt+DownCtrl+Alt+DownCtrl+Shift+DownCtrl+DownControl DownControl DownControl Alt DownControl 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 are automatically moved to the newly created folder. If only a category has the focus, then an empty folder is created.

Move run/debug configurations to a folder using drag-and-drop, or arrowUp arrowDown buttons.

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.
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.

The shared run/debug configurations are kept in separate xml files under .idea\runConfigurations folder, while the local run/debug configurations are kept in the .idea\workspace.xml.

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, RubyMine 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 launch Specify which tasks should be carried out before starting the run/debug configuration. The specified tasks are performed in the order that they appear in the list.
Item Keyboard shortcut Description
add Alt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+Insert or Ctrl+NAlt+InsertShift+Meta+N, Ctrl+N or Ctrl+EnterCommand N or Control EnterControl N or Control EnterCommand N or Control EnterControl N or Control Enter Click this icon to add a task to the list. Select the task to be added:
  • Run External tool. Select this option to run an application which is external to RubyMine. In the dialog that opens, select the application or applications that should be run. If the necessary application is not defined in RubyMine yet, add its definition. For more information, see Configuring Third-Party Tools and External Tools.
  • Generate CoffeeScript Source Maps. Select this option to have the source maps for your CoffeeScript sources generated. In the dialog that opens, specify where your CoffeeScript source files are located. For more information, see CoffeeScript Support.
  • Run Remote External tool: Add a remote SSH external tool. Refer to the section Remote SSH External Tools for details.
  • Run Rake task:Add a Rake task to be executed prior to running or debugging. To choose a Rake task, click the browse button browseButton, and select the desired task from the list of available tasks.

    Note that code completion is available here.

    runConfigRakeTask

    To learn more about Rake support, refer to Rake section.
  • Run JRuby compiler: choose this option to execute JRuby compiler with the specified target path, compiler process heap size, and command line parameters (if any).
delete Alt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteMeta+DeleteCommand Delete or Command BackspaceCommand DeleteCommand Delete or Command BackspaceCommand Delete Click this icon to remove the selected task from the list.
edit1 EnterEnterEnterEnterEnterEnterEnterEnterEnterEnterEnterEnterEnter Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
arrowUp Alt+UpAlt+UpAlt+UpAlt+UpAlt+Up or Ctrl+Alt+AAlt+UpCtrl+Alt+UpCtrl+Shift+UpCtrl+UpControl UpControl UpControl Alt UpControl Up Click this icon to move the selected task one line up in the list.
arrowDown Alt+DownAlt+DownAlt+DownAlt+DownAlt+Down or Ctrl+Alt+EAlt+DownCtrl+Alt+DownCtrl+Shift+DownCtrl+DownControl DownControl DownControl Alt DownControl Down Click this icon to move the selected task one line down in the list.
Show this page Select this check box to have the run/debug configuration settings shown prior to actually starting the run/debug configuration.

See Also

Concepts:

Procedures:

Reference:

Web Resources:

JavaScript Support: