IntelliJ IDEA 2021.1 Help

Run/Debug Configuration: Grails

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

The dialog consists of the following tabs:

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 Run 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 the Browse button 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.

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 checkbox to detect lines covered by one test and all tests covering line. If this checkbox is selected, Track per test coverage becomes available on the toolbar of the coverage statistic popup.

Refer to the section Set coverage in run configurations.

Packages and classes to record code coverage dataClick the Add button and select the Add Class button Add Class or the Add Package button Add Package 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 remove the package button.
Enable coverage in test folders.If this checkbox is selected, the folders marked as test root_Test.png are included in the code coverage analysis.

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 policySpecify 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 policySelect 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 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 the Browse button  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

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

Item

Description

Name

Specify a name for the run/debug configuration to quickly identify it when editing or running the configuration, for example, from the Run popup Alt+Shift+F10.

Allow parallel run

Select to allow running multiple instances of this run configuration in parallel.

By default, it is disabled, and when you start this configuration while another instance is still running, IntelliJ IDEA suggests to stop the running instance and start another one. This is helpful when a run/debug configuration consumes a lot of resources and there is no good reason to run multiple instances.

Store as project file

Save the file with the run configuration settings to share it with other team members. The default location is .idea/runConfigurations. However, if you do not want to share the .idea directory, you can save the configuration to any other directory within the project.

By default, it is disabled, and IntelliJ IDEA stores run configuration settings in .idea/workspace.xml.

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
the Add buttonAlt+InsertCreate a run/debug configuration.
the Remove buttonAlt+DeleteDelete the selected run/debug configuration. Note that you cannot delete default configurations.
CopyCtrl+DCreate a copy of the selected run/debug configuration. Note that you create copies of default configurations.
Save configurationThe button is displayed only when you select a temporary configuration. Click this button to save a temporary configuration as permanent.
Edit TemplatesView and edit the template (that is, the default run/debug configuration settings). The templates are displayed under the Templates node and used for newly created configurations.
Method up/ Method downAlt+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.

Move into new folder / Create new 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, click Folder, and specify the 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 or Move Up and Move Down buttons.

To remove grouping, select a folder and click Remove Configuration.

Sort configurations Click this button to sort configurations in the alphabetical order.

Before Launch

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

ItemShortcutDescription
the Add buttonAlt+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 External 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.

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

  • Launch Web Browser: select this option to have a browser started. In the dialog that opens, select the type of the browser and provide the start URL. Also, specify if you want the browser be launched with JavaScript debugger.

  • 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 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 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 that opens, specify the npm run/debug configuration settings.
  • 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.

  • 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 the Browse button, and select the desired task from the list of available tasks.

    Note that code completion is available here.

    Code completion for the Rake tasks

  • 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).

the Remove buttonAlt+DeleteClick this icon to remove the selected task from the list.
EditEnterClick this icon to edit the selected task. Make the necessary changes in the dialog that opens.
Method up/ Method downAlt+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

By default this checkbox is selected and the Run or the Debug tool window opens when you start the run/debug configuration.

Otherwise, if the checkbox is cleared, the tool window is hidden. 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: 08 March 2021