IntelliJ IDEA 2016.3 Help

Run/Debug Configuration: Grails

This feature is supported in Ultimate edition only.

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:

This section provides descriptions of the configuration-specific items, as well as the toolbar and options that are common for all run/debug configurations.

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 the 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 the spaces in double quotes, for example, some" "arg or "some arg".
  • If an option includes double quotes (e.g. as part of the argument), escape the double quotes by means of the backslashes, for example, -Dmy.prop=\"quoted_value\".
Environment VariablesClick the Browse button browseButton.png to open the Environment Variables dialog box, where you can create variables and specify their values.
Add --classpath

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

Please note the following:

  • This check box is enabled, if a module has a dependency that was added directly from the Dependencies tab of the Project Structure dialog, without changing BuildConfig.groovy or plugins dependencies.
  • Read about adding module dependencies in the section Configuring Module Dependencies and Libraries.
Launch browserBy default, this check box is not selected and IntelliJ IDEA uses http://localhost:8080/application_name as default address. Select this check box to enter a different address in the field.

Code Coverage tab

Use this tab to configure code coverage monitoring options.

ItemDescription
Choose code 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 coverageSelect this check box to detect lines covered by one test and all tests covering line. If this check box is selected, /help/img/idea/2016.3/junitIcon.png becomes available on the toolbar of the coverage statistic pop-up window.

Refer to the section Viewing Code Coverage Results.

Merge data with previous resultsWhen you run your unit testing or application configuration several times, use this item to calculate statistics in the Project View, taking into account the statistics of each time you have run the configuration.
Packages and classes to record code coverage dataClick add-class and add-package 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 /help/img/idea/2016.3/delete.png button.
Enable coverage in test folders.If this check box is selected, the folders marked as test /help/img/idea/2016.3/rootTest.gif 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 check box is selected and IntelliJ IDEA uses the default settings specified in your project.

ItemDescription
Work offlineIf this option is checked, Maven works in 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 check box 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 /help/img/idea/2016.3/browseButton.png 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.

Toolbar

ItemShortcutDescription
/help/img/idea/2016.3/new.png Alt+Insert Click this button to add a new configuration to the list.
/help/img/idea/2016.3/delete.png Alt+Delete Click this button to remove the selected configuration from the list.
/help/img/idea/2016.3/copy.gif Ctrl+D Click this button to create a copy of the selected configuration.
/help/img/idea/2016.3/settings.png Edit defaultsClick this button to edit the default configuration templates. The defaults are used for newly created configurations.
/help/img/idea/2016.3/arrowUp.png or /help/img/idea/2016.3/arrowDown.png 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.

folder 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 /help/img/idea/2016.3/arrowUp.png /help/img/idea/2016.3/arrowDown.png buttons.

/help/img/idea/2016.3/sortAlphabetically.png Sort configurations Click this button to sort configurations in alphabetical order.

Common options

ItemDescription
NameIn 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 onlyIf 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 launchSpecify which tasks must be performed before applying the run/debug configuration. The specified tasks are performed in the order they appear in the list.
ItemKeyboard shortcutDescription
/help/img/idea/2016.3/new.png 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.
  • 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 grunt-cli package.

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

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

  • Compile TypeScript. Select 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 check box to configure the behaviour of the compiler in case any errors are detected:
    • 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.
/help/img/idea/2016.3/delete.png Alt+Delete Click this icon to remove the selected task from the list.
/help/img/idea/2016.3/editFlexLibraryNew.png Enter Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
/help/img/idea/2016.3/arrowUp.png Alt+Up Click this icon to move the selected task one line up in the list.
/help/img/idea/2016.3/arrowDown.png 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 windowSelect 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.

See Also

Language and Framework-Specific Guidelines:

Last modified: 7 December 2016