IntelliJ IDEA 2018.2 Help

Run/Debug Configuration: Grails

Grails run/debug configuration enables you to run and debug the Grails applications, tests and Web tests.

The dialog box consists of the following tabs:

Grails Tab

ItemDescription
ModuleSelect application, for which this run/debug configuration is created. By default, the name of the current module is suggested.
Command lineType a command to execute a particular target, for example, run-app, or app-engine.

Alternatively, you can execute target as described in the section Running Grails Targets.

VM OptionsSpecify the string to be passed to the VM for launching the application. This string may contain the options such as -mx, -verbose, etc.

When specifying JVM options, follow these rules:

  • Use spaces to separate individual options, for example, -client -ea -Xmx1024m.
  • 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}
Environment VariablesClick Browse browseButton.png to open the Environment Variables dialog box, where you can create variables and specify their values.
Add --classpath

If this checkbox is selected, it means that the user intends to include the dependency directly, by passing --classpath to the command line.

Launch browserBy default, this checkbox is not selected and IntelliJ IDEA uses http://localhost:8080/application_name as default address. Select this checkbox to enter a different address in the field.

Code Coverage tab

Use this tab to configure code coverage monitoring options.

ItemDescription
Choose coverage runner

Select the desired code coverage runner.

By default, IntelliJ IDEA uses its own coverage engine with the Sampling mode. You can also choose JaCoCo or Emma for calculating coverage.

SamplingSelect this option to measure code coverage with minimal slow-down.
TracingSelect this option to collect accurate branch coverage. This mode is available for the IntelliJ IDEA code coverage runner only.
Track per test coverage

Select this check box to detect lines covered by one test and all tests covering line. If this check box is selected, junit2x becomes available on the toolbar of the coverage statistic pop-up window.

Refer to the section Viewing Code Coverage Results.

Packages and classes to record code coverage dataClick icons toolbarDecorator addClass and icons toolbarDecorator addPackage buttons to specify classes and packages to be measured. You can also remove classes and packages from the list by selecting them in the list and clicking the icons general remove svg button.
Enable coverage in test folders.If this check box is selected, the folders marked as test root_Test.png are included in the code coverage analysis.

Maven Settings Tab

Use this tab to configure Maven settings for running and debugging your application. By default, the Use project settings checkbox is selected and IntelliJ IDEA uses the default settings specified in your project.

ItemDescription
Work offlineIf this option is checked, Maven works in the offline mode and uses only those resources that are available locally.

This option corresponds to the --offline command line option.

Use plugin registryCheck this option to enable referring to the Maven Plugin Registry.

This option corresponds to the --no-plugin-registry command line option.

Execute goals recursivelyIf this option is cleared, the build does not recur into the nested projects.

Clearing this option equals to --non-recursive command line option.

Print exception stack tracesIf this option is checked, exception stack traces are generated.

This option corresponds to the --errors command line option.

Always update snapshotsSelect this checkbox to always update snapshot dependencies.
Output levelSelect the desired level of the output log, which allows plugins to create messages at levels of debug, info, warn, and error, or disable output log.
Checksum policySelect the desired level of checksum matching while downloading artifacts. You can opt to fails downloading, when checksums do not match (--strict-checksums), or issue a warning (--lax-checksums).
Multiproject build fail policy Specify how to treat a failure in a multiproject build. You can choose to:
  • Fail the build at the very first failure, which corresponds to the command line option --fail-fast.
  • Fail the build at the end, which corresponds to the command line option --fail-at-end.
  • Ignore failures, which corresponds to the command line option --fail-never.
Plugin update policy Select plugin update policy from the drop-down list. You can opt to:
  • Check for updates, which corresponds to the command line option --check-plugin-updates.
  • Suppress checking for updates, which corresponds to the command line option --no-plugin-updates.
Threads (-T option)Use this field to set the -T option for parallel builds. This option is available for Maven 3 and later versions.
For more information, see parallel builds in Maven 3 feature.
Maven home directoryUse this drop-down list to select a bundled Maven version that is available (for Maven2, version 2.2.1 and for Maven3, version 3.0.5) or the result of resolved system variables such as MAVEN_HOME or MAVEN2_HOME. You can also specify your own Maven version that is installed on your machine. You can click browseButton and select the necessary directory in the dialog that opens.
User settings fileSpecify the file that contains user-specific configuration for Maven in the text field. If you need to specify another file, check the Override option, click the ellipsis button and select the desired file in the Select Maven Settings File dialog.
Local repositoryBy default, the field shows the path to the local directory under the user home that stores the downloads and contains the temporary build artifacts that you have not yet released. If you need to specify another directory, check the Override option, click the ellipsis button and select the desired path in the Select Maven Local Repository dialog.

Common options

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

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

ItemShortcutDescription
icons general add svgAlt+InsertCreate a run/debug configuration.
icons general remove svgAlt+Delete Delete the selected run/debug configuration. Note that you cannot delete default configurations.
icons actions copy svg Ctrl+D Create a copy of the selected run/debug configuration. Note that you create copies of default configurations.
icons general settings svg Edit Templates View and edit the default template for the selected run/debug configuration. The templates are used for newly created configurations.
icons actions moveUp svg/icons actions moveDown svgAlt+Up/Alt+Down

Move the selected run/debug configuration up and down in the list.

The order of configurations in the list defines the order, in which the configurations appear when you choose a run/debug configuration.

Default templates of run/debug configurations are always sorted alphabetically.

folder Move into new folder / Create new folder

You can group run/debug configurations by placing them into folders.

To create a folder, select the configurations within a category to be grouped, click folder, and specify the name for the folder. 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 icons actions moveUp svg and icons actions moveDown svg buttons.

To remove grouping, select a folder and click icons general remove svg.

icons objectBrowser sorted svg Sort configurations Click this button to sort configurations in alphabetical order.

Templates

When you select Templates in the tree view of the run configurations, you can adjust some settings that apply for all run debug configurations.

ItemDescription
Configurations available in Run Dashboard

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

Note that the dashboard will only display those configuration types for which you have created one ore more configurations.
So 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 terminationThe behavior of this checkbox depends on whether the Single instance only checkbox is selected for a particular run/debug configuration.
  • If this checkbox is selected, then, in case of a single instance, launching a new process (for example, by clicking run 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 here 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 should be carried out before starting the selected run/debug configuration. The specified tasks are performed in the order they appear in the list.

ItemShortcutDescription
icons general add svgAlt+Insert Click this icon to add one of the following available tasks:
  • 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.
  • 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 Another Configuration — select this option to execute another run/debug configuration. In the dialog that opens, select the configuration to be run.
  • 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.
  • Run npm Script — select this option to execute an npm script. In the NPM Script dialog box that opens, specify the npm run/debug configuration settings.
  • Compile TypeScript — elect this option 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.
  • Run Remote External tool — adds a remote SSH external tool.
  • 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
  • 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).
icons general remove svgAlt+Delete Click this icon to remove the selected task from the list.
icons actions edit svg Enter Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
icons actions moveUp svg/icons actions moveDown svgAlt+Up/Alt+DownClick these icons to move the selected task one line up or down in the list. (The tasks are performed in the order that they appear in the list.)
Show this pageSelect this checkbox to show the run/debug configuration settings prior to actually starting the run/debug configuration.
Activate tool window

If this checkbox is selected, which it is by default, the Run or the Debug tool window opens when you start the run/debug configuration.

Otherwise, the tool window isn't shown. However, when the configuration is running, you can open the corresponding tool window for it yourself by pressing Alt+4 or Alt+5.

Last modified: 18 June 2018

See Also

Language and Framework-Specific Guidelines: