RubyMine 7.0.0 Web Help

Use this dialog box to define run/debug configuration for a Ruby script.

The dialog box consists of the following tabs:

Click here for the description of the options that are common for all run/debug configurations.

Configuration tab

Item Description
Name In this text box, specify the name of the current run/debug configuration.
Ruby script Specify the fully qualified path to a Ruby script to be executed, or click browseButton.png, and and select the desired Ruby script in the dialog that opens.
Script arguments Type the optional arguments to be passed to the Ruby script.
Working directory Specify the current directory to be used by the running task. By default, the project directory is used as a working directory.
Environment variables Specify the list of environment variables as the name-value pairs, separated with semi-colons. Alternatively, click the ellipsis button to create variables and specify their values in the Environment Variables dialog box.
Ruby arguments Specify the arguments to be passed to the Ruby interpreter. 5.4+

Note that when JRuby is used as the project interpreter, the list of Ruby arguments can include Nailgun argument --ng.
So doing, when such a run/debug configuration is launched, RubyMine analyzes the running processes, and does one of the following, depending on the presence of the running Nailgun server:

  • If there is no running Nailgun server, or if there is a Nailgun server on a non-default port, or with a different gemset, then RubyMine suggests to specify the desired port number.
  • If a Nailgun server runs on the default port with the required gemset, RubyMine does nothing.
  • If a Nailgun server runs on a different port with the required gemset, then RubyMine suggests to specify the desired port number.
  • If a Nailgun server runs on the default port with a different gemset, then RubyMine deletes the --ng argument.

5.4.3+

Classpath property is added to Nailgun settings.

Ruby SDK Specify the desired Ruby interpreter. You can opt to choose the project default Ruby SDK, or select a different one from the drop-down list of configured Ruby SDKs.

Bundler tab

Item Description
Run the script in the context of the bundle If this check box is selected, the script in question will be executed as specified in the gemfile.

Code Coverage tab

Use this tab to configure code coverage monitoring options.

Item Description
add Click this button to define the scope of code coverage analysis. In the Add Pattern dialog box that opens, type the comma-delimited list of Ruby regular expressions, and specify whether the matching files should be included into or excluded from code coverage analysis.

The patterns defining files to be included into code coverage analysis, are marked with +; the ones to be excluded are marked with -.

Each pattern can be enabled or disabled. To do that, select or clear the check box next to a pattern. By default, all newly created patterns are enabled.

delete Click this button to delete the selected pattern from the list.
edit1 Click this button to change the selected code coverage pattern.
Do not use the optimized C runtime Select this check box to enable the option --no-rcovrt. Use this option with discretion, since it significantly slows down performance.
Enable coverage in test folders. If this check box is selected, the folders marked as test rootTest are included in the code coverage analysis.
6.0+

Nailgun tab

Item Description
Run new instance of the Nailgun server, or use already started one This check box is only available for JRuby used as the project interpreter.

When a run/debug configuration, with this check box selected, is launched, RubyMine analyzes the running processes, and does one of the following, depending on the presence of the running Nailgun server:

  • If there is no running Nailgun server, or if there is a Nailgun server on a non-default port, or with a different gemset, then RubyMine suggests to specify the desired port number.
  • If a Nailgun server runs on the default port with the required gemset, RubyMine does nothing.
  • If a Nailgun server runs on a different port with the required gemset, then RubyMine suggests to specify the desired port number.
  • If a Nailgun server runs on the default port with a different gemset, then RubyMine deletes the -ng argument.

If this check box is not selected, then the script is launched in a usual way, without Nailgun.

Logs tab

Use this tab to specify which log files generated while running or debugging should be displayed in the console, that is, on the dedicated tabs of the Run or Debug tool window.

Item Description
Is Active Select check boxes in this column to have the log entries displayed in the corresponding tabs in the Run tool window or Debug tool window.
Log File Entry The read-only fields in this column list the log files to show. The list can contain:
  • Full paths to specific files.
  • Aliases to substitute for full paths or patterns. These aliases are also displayed in the headers of the tabs where the corresponding log files are shown.

    If a log entry pattern defines more than one file, the tab header shows the name of the file instead of the log entry alias.

Skip Content Select this check box to have the previous content of the selected log skipped.
Save console output to file Select this check box to save the console output to the specified location. Type the path manually, or click the browse button and point to the desired location in the dialog that opens.
Show console when standard out changes Select this check box to activate output console and bring it forward, if associated process writes to Standard.out.
Show console when standard error changes Select this check box to activate output console and bring it forward, if associated process writes to Standard.err.
add Click this button to open the Edit Log Files Aliases dialog where you can select a new log entry and specify an alias for it.
edit1 Click this button to edit the properties of the selected log file entry in the Edit Log Files Aliases dialog.
delete Click this button to remove the selected log entry from the list.
browseButton.png Click this button to edit the select log file entry. The button is available only when an entry is selected.

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 a new configuration to the list.
delete Alt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteAlt+DeleteMeta+DeleteCommand DeleteCommand DeleteCommand DeleteCommand 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 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 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 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 arrowUp arrowDown buttons.

sortAlphabetically 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 .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 must be performed before applying the run/debug configuration. The specified tasks are performed in the order 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:
  • 5.0+ 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.
  • Run Another Configuration. Select this option to have another run/debug configuration executed. In the dialog that opens, select the configuration to be run.
  • 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.
  • 5.0+ 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 DeleteCommand DeleteCommand DeleteCommand 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:

Web Resources: