RubyMine 7.0.1 Web Help

In this dialog box, create configurations for running and debugging JavaScript unit tests using the Mocha test framework.

On this page:

Getting Access to the Run/Debug Configuration: Mocha Dialog Box

  1. Install and enable the Node.js plugin.

    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. See Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins for details.

  2. Download and install the NodeJS framework that contains the Node Package Manager(npm).
  3. Using the Node Package Manager, install the Mocha test framework as described in Preparing to Use Mocha Test Framework.
  4. Install and enable the Mocha repository plugin.

    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. See Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins for details.

Mocha-Specific Configuration Settings

Item Description
Node.js interpreter In this field, specify the NodeJS installation home. Type the path to the NodeJS executable file manually, or click the browseButton.png 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.

Mocha node package In this field, specify the Mocha installation home /npm/node_modules/mocha. If you installed Mocha regularly through the Node Package Manager, RubyMine detects the Mocha installation home itself. Alternatively, type the path to executable file manually, or click the Browse button browseButton.png and select the location in the dialog box, that opens.
Working directory In this field, specify the working directory of the application. All references in test scripts 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
Test directory In this text box, specify the full path to the folder where the tests to run are stored.
User interface From this drop-down list, choose the interface according to which the tests in the test folder are written. RubyMine will recognize only tests that comply with the chosen interface. If during test execution RubyMine runs against a test of another interface, the test session will be canceled with an error. This means that all the tests in the specified test folder must be written according to the same interface and this interface must be chosen from the drop-down list.
Require module In this text box, specify the full path to the additional libraries under the Node modules node that you use in your tests through the require invocation, see http://visionmedia.github.io/mocha/#require-option for details. Specifying an additional library is helpful if it is used in numerous tests.

Toolbar

Item Shortcut Description
add Alt+InsertAlt+InsertAlt+InsertAlt+InsertAlt+InsertCtrl+N or Alt+InsertAlt+InsertAlt+InsertCtrl+N or Ctrl+Enter⌘ N or Control EnterControl N or Control Enter⌘ 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+Delete⌘+Delete⌘ Delete⌘ Delete⌘ Delete⌘ Delete Click this button to remove the selected configuration from the list.
copy Ctrl+DCtrl+DCtrl+DCtrl+D⌘+DCtrl+DCtrl+D, Ctrl+Shift+Down or Ctrl+Shift+UpCtrl+DCtrl+Shift+D⌘ D⌘ D⌘ D⌘ 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.

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+⌘+N, Ctrl+N or Ctrl+Enter⌘ N or Control EnterControl N or Control Enter⌘ 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.
  • 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.
  • 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+Delete⌘+Delete⌘ Delete⌘ Delete⌘ Delete⌘ 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

Procedures:

Web Resources: