Run/Debug Configuration: Mocha

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
Mocha-Specific Configuration Settings
Toolbar
Common options

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

Install and enable the Node.js plugin. The plugin is not bundled with PyCharm, but it can be installed from the JetBrains plugin repository as described in Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins. The plugin is not bundled with PyCharm, but it can be installed from the JetBrains plugin repository as described in Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins.
Download and install the NodeJS runtime environment that contains the Node Package Manager(npm).
Using the Node Package Manager, install the Mocha test framework as described in Preparing to Use Mocha Test Framework.

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 button and select the location in the dialog box, that opens.
Node options	In this text box, type the NodeJS-specific command line options to be passed to the NodeJS executable file. See Node Parameters for details.
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 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 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 and specify the variable name and value. To discard a variable definition, select it in the list and click the Delete toolbar button . 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.
Mocha package	In this field, specify the Mocha installation home `/npm/node_modules/mocha`. If you installed Mocha regularly through the Node Package Manager, PyCharm detects the Mocha installation home itself. Alternatively, type the path to executable file manually, or click the Browse button and select the location in the dialog box, that opens.
User interface	From this drop-down list, choose the interface according to which the tests in the test folder are written. PyCharm will recognize only tests that comply with the chosen interface. If during test execution PyCharm 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.
Tests	In this area, specify the tests to be executed. The available options are: All in directory: choose this option to run all the tests from files stored in a folder. In the Test directory field, specify the folder with the tests. To have PyCharm look for tests in the subfolders under the specified directory, select the Include subdirectories check box. File pattern: choose this option to have PyCharm look for tests in all the files with the names that match a certain mask and specify the mask in the Test file pattern field. Test file: choose this option to run only the tests from one file and specify the path to this file in the Test file field. Suite: choose this option to run individual suites from a test file. In the Test file field, specify the file where the required suites are defined. Click the Suite name field and configure a list of suites to run. To add a suite to the list, click and type the name of the required suite. To remove a suite, select it in the list and click Test: choose this option to run individual tests from a test file. In the Test file field, specify the file where the required tests are defined. Click the Test name field and configure a list of tests to run. To add a test to the list, click and type the name of the required test. To remove a test, select it in the list and click

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

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

Item	Keyboard shortcut	Description
	`Alt+Insert`	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 PyCharm. In the dialog that opens, select the application or applications that should be run. If the necessary application is not defined in PyCharm 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 run. This option is available only if you have already at least one run/debug configuration in the current project. Run File Watchers. Select this option to have PyCharm apply all the currently active file watchers, see Using File Watchers for details. 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.
	`Alt+Delete`	Click this icon to remove the selected task from the list.
	`Enter`	Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
	`Alt+Up`	Click this icon to move the selected task one line up in the list.
	`Alt+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.
Active tool window		Select this option if you want the Run/Debug tool windows to be activated automatically when you run/debug your application. This option is enabled by default.

Procedures:

Last modified: 20 April 2016

PyCharm 2016.1 Help