IntelliJ IDEA 2018.2 Help

Run/Debug Configuration: Scala

Configuration tab

Item

Description

Main class

In this text box, specify the fully qualified name of the class to be executed (passed to the JRE). Type the class name manually or click Browse to open the Choose Main Class dialog box, where you can find the desired class by name or search through the project.

VM options

In this text box, specify the string to be passed to the VM for launching an application, for example, -mx, -verbose, and so on.

If necessary, click and type the desired string in the VM Options dialog.

If an option includes spaces, enclose the spaces or the argument that contains spaces in double quotes, for example, some" "arg or "some arg".

If an option includes double quotes (as part of the argument), escape the double quotes using backslashes, for example, -Dmy.prop=\"quoted_value\".

You can pass environment variable values to custom Java properties. For example, if you define a variable MY_ENV_VAR, you can pass it to the foo property as follows:

-Dfoo=${MY_ENV_VAR}

The -classpath option specified in this field overrides the classpath of the module.

Program arguments

In this text box, type a list of arguments to be passed to the program in the format you would use in the command line. If necessary, click the button and type the desired arguments in the Program Parameters dialog box.

In this text box, specify the current directory to be used by the running application. This directory is the starting point for all relative input and output paths. By default, the field contains the directory where the project file resides. To specify another directory, click the Browse button select the directory in the dialog that opens.

Click the icon to view the list of available path variables that you can use as a path to your working directory.

The list of the path variables may vary depending on the enabled plugins.

Environment variables

Click Browse to open the Environment Variables dialog box, where you can create variables and specify their values.

Note that you can copy-paste the contents of the Environment variables field without having to open the Environment Variables dialog box.

Use classpath of module

Select the module whose classpath should be used to run the application.

Include dependencies with 'Provided' scope

Enable this option to add dependencies with the Provided scope to the runtime classpath.

Shorten command line

Select a method that will be used to shorten the command line if the classpath gets too long or you have many VM arguments that exceed your OS command line length limitation:

none: IntelliJ IDEA will not shorten a long classpath. If the command line exceeds the OS limitation, IntelliJ IDEA will be unable to run your application and will display a message suggesting you to specify the shortening method.

JAR manifest: IntelliJ IDEA will pass a long classpath via a temporary classpath.jar. The original classpath is defined in the manifest file as a class-path attribute in classpath.jar. Note that you will be able to preview the full command line if it was shortened using this method, not just the classpath of the temporary classpath.jar.

classpath.file: IntelliJ IDEA will write a long classpath into a text file.

User-local default: this legacy option is set automatically for projects created before IntelliJ IDEA version 2017.3. IntelliJ IDEA will configure this setting depending on the properties set in the ide/workspace.xml and idea.config.path/options/options.xml files.

JRE

By default, the newest JDK from the module dependencies is used to run the application. If you want to specify an alternative JDK or JRE here, select it from the drop-down list.

Common options

When you edit a run configuration (but not a run configuration template), you can specify the following options for it:

Item

Description

Name

In this text box, specify the name for the run/debug configuration. The name will help you identify the created configuration when you choose to edit it later, or when you invoke it, for example. from the Run popup (Shift+Alt+F10).

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.

Toolbar

The tree view of run/debug configurations has a toolbar that helps you manage configurations available in your project as well as adjust default configurations templates.

To create a folder, select the configurations within a category, click , and specify folder name. If only a category is in focus, an empty folder is created.

Then, to move a configuration into a folder, between the folders or out of a folder, use drag-and-drop or and buttons.

To remove grouping, select a folder and click .

Sort configurations

Click this button to sort configurations in the alphabetical order.

Templates

Under the Templates node in the tree view of run configurations, you can select a run configuration template and edit its default settings. This will not affect the configurations that are already created, but will be used as defaults when creating new configurations of the corresponding type.

When you select the Templates node itself, you will be able to adjust general settings that apply to all run/debug configurations:

Item

Description

Configurations available in Run Dashboard

In this section you can create a list of run configurations available in the Run Dashboard — a tool window that helps you execute and manage multiple run/debug configurations.

Note that the dashboard will only display the configuration types for which you have created one ore more configurations. Thus, if you add a configuration type for which no configurations exist in the project, this type will not be displayed on the dashboard until you create a configuration of this type.

Confirm rerun with process termination

The behavior of this checkbox depends on whether the Single instance only option is selected for a particular run/debug configuration.

If this checkbox is selected, in case of a single instance, launching a new process (for example, by clicking on the main toolbar) while another process is still running, results in showing a dialog box prompting to terminate the current process before launching a new one.

If this checkbox is not selected (or in case of multiple instances), IntelliJ IDEA starts the new process silently.

Temporary configurations limit

Specify the maximum number of temporary configurations to be stored and shown in the Select Run/Debug Configuration drop-down list.

Before Launch options

In this area you can specify tasks that must be be performed before starting the selected run/debug configuration. The tasks are performed in the order they appear in the list.

Item

Shortcut

Description

Alt+Insert

Click this icon to add one of the following available tasks:

Run External tool: select to run an external application. In the dialog that opens, select one or multiple applications you want to run. If it is not defined in IntelliJ IDEA yet, add its definition. For more information, see Configuring Third-Party Tools and External Tools.

Run Another Configuration: select to execute another run/debug configuration. In the dialog that opens, select the configuration to be run.

If an error occurs during compilation, IntelliJ IDEA won't attempt to start the run/debug configuration.

Build, no error check: the same as the Build option, but IntelliJ IDEA will try to start the run/debug configuration irrespective of the compilation results.

Build Artifacts: select this option to build an artifact or artifacts. In the dialog that opens, select the artifact or artifacts that should be built.

Run Ant target: select this option to run an Ant target. In the dialog that opens, select the target to be run.

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 grunt-cli package.

Run Gulp task: select this option to run a Gulp 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 gulp package.

Run Maven Goal: select this option to run a Maven goal. In the dialog that opens, select the goal to be run.

Compile TypeScript: select to run the built-in TypeScript compiler and thus make sure that all the changes you made to your TypeScript code are reflected in the generated JavaScript files. In the TypeScript Compile Settings dialog that opens, select or clear the Check errors checkbox to configure the behaviour of the compiler in case any errors are detected:

If the Check errors checkbox is selected, the compiler will show all the errors and the run configuration will not start.

If the Check errors checkbox 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 generate the source maps for your CoffeeScript sources. In the dialog that opens, specify where your CoffeeScript source files are located.