Run/Debug Configuration: Mocha
This feature is supported in the Ultimate edition only.
On this page:
Getting access to the Run/Debug Configuration: Mocha dialog
- Install and enable the Node.js plugin. The plugin is not bundled with IntelliJ IDEA, 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).
Mocha-specific configuration settings
| 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. |
If you have appointed one of the installations as default, the field displays the path to its executable file.
| 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:
:-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, IntelliJ IDEA 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. IntelliJ IDEA will recognize only tests that comply with the chosen interface. If during test execution IntelliJ IDEA 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 IntelliJ IDEA look for tests in the subfolders under the specified directory, select the Include subdirectories check box.
- File pattern: choose this option to have IntelliJ IDEA 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
|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. |
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, or 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 otherwise.
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, 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 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. |
| || 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 IntelliJ IDEA. In the dialog that opens, select the application or applications that should be run. If the necessary application is not defined in IntelliJ IDEA yet, add its definition. For more information, see Configuring Third-Party Tools and External Tools.
- Make. Select this option to have the project or module compiled. The Make Module command will be carried out if a particular module is specified in the run/debug configuration, and the Make Project command otherwise.
If an error occurs during the compilation, IntelliJ IDEA won't attempt to start the run/debug configuration.
- Make, no error check. The same as the Make option but IntelliJ IDEA will try to start the run/debug configuration irrespective of the compilation result.
- Build Artifacts. Select this option to have an artifact or artifacts built. In the dialog that opens, select the artifact or artifacts that should be built.
See also, Working with Artifacts.
- 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 Ant target. Select this option to have an Ant target run. In the dialog that opens, select the target to be run. For more information, see Ant.
- Run Grunt task. Select this option to run a Grunt task. In the Grunt task dialog box that opens, specify the
Gruntfile.js where the required task is defined, select the task to execute, and specify the arguments to pass to the Grunt tool.
Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the
- Run Gulp task. Select this option to run a Grunt task. In the Gulp task dialog box that opens, specify the
Gulpfile.js where the required task is defined, select the task to execute, and specify the arguments to pass to the Gulp tool.
Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the
- Run npm Script. Select this check box to execute an npm script. In the NPM Script dialog box that opens, specify the
package.json file where the required script is defined, select the script to execute, choose the command to apply to it, and specify the arguments to execute the script with.
Specify the location of the Node.js interpreter and the parameters to pass to it.
- If the Check errors check box is selected, the compiler will show all the errors and the run configuration will not start.
- If the Check errors check box is cleared, the compiler will show all the detected errors but the run configuration still will be launched.
- 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 Maven Goal. Select this option to have a Maven goal run. In the dialog that opens, select the goal to be run.
For more information, see Maven.
- Run Remote External tool: Add a remote SSH external tool. Refer to the section Remote SSH External Tools for details.
- Upload files to Remote Host. Select this option to have the application files automatically uploaded to the server according to the default server access configuration. For more information, see Configuring Synchronization with a Web Server and Uploading and Downloading Files.
| || 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.|
Last modified: 18 July 2017