AppCode 2019.1 Help

Run/Debug Configuration: Gradle

Configuration tab

Item

Description

Gradle Project

Use this field to specify the location of your Gradle project. You can either enter it manually or click the Browse  browse icon and point to the desired location in the dialog that opens.
You can also click Gradle registered projectsicons actions module icon to select an available Gradle module from the list of registered Gradle modules in your existing AppCode project. The list has a tree structure that might be useful if you have a Gradle multi-module project.

Tasks

Use this field to specify external tasks for your Gradle project. Use spaces to separate one task from another.

VM Options

Use this field to specify VM options for your Gradle project.

If you need more room to type, click icons general expandComponent svg next to the field to access the VM options dialog where the text entry area is larger.

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}

Logs tab

Use this tab to specify which log files generated while running or debugging should be displayed in the console, that is, on the dedicated tabs of the Run or Debug tool window.

Item

Description

Is Active

Select checkboxes in this column to have the log entries displayed in the corresponding tabs in the Run tool window or Debug tool window.

Log File Entry

The read-only fields in this column list the log files to show. The list can contain:

  • Full paths to specific files.

  • Aliases to substitute for full paths or patterns. These aliases are also displayed in the headers of the tabs where the corresponding log files are shown.

    If a log entry pattern defines more than one file, the tab header shows the name of the file instead of the log entry alias.

Skip Content

Select this checkbox to have the previous content of the selected log skipped.

Save console output to file

Select this checkbox to save the console output to the specified location. Type the path manually, or click the browse button and point to the desired location in the dialog that opens.

Show console when a message is printed to standard output stream

Select this checkbox to activate the output console and bring it forward if an associated process writes to Standard.out.

Show console when a message is printed to standard error stream

Select this checkbox to activate the output console and bring it forward if an associated process writes to Standard.err.

the Add button

Click this button to open the Edit Log Files Aliases dialog where you can select a new log entry and specify an alias for it.

the Edit button

Click this button to edit the properties of the selected log file entry in the Edit Log Files Aliases dialog.

the Delete button

Click this button to remove the selected log entry from the list.

browseButton.png

Click this button to edit the select log file entry. The button is available only when an entry is selected.

Gradle Debug

Use this tab to manually disable breakpoints in Gradle scripts.

Item

Description

Enable Gradle script debugging

Clear this option to disable breakpoints in the Gradle scripts.

Common options

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

Item

Description

Name

In this field, 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 (⌃⌥R).

Share

Select this checkbox to make the run/debug configuration available to other team members.

The shared run/debug configurations are kept in separate xml files under .idea \runConfigurations folder, while the local run/debug configurations are kept in the .idea\workspace.xml.

Allow running in parallel

When disabled, every time a new run/debug configuration is launched, AppCode 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 checkbox is selected, it is possible to launch as many instances of the run/debug configuration as required. So doing, each runner will start in its own tab of the Run Tool Window or Debug Tool Window.

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.

Item

Shortcut

Description

icons general add svg⌘N

Create a run/debug configuration.

icons general remove svg⌘⌦

Delete the selected run/debug configuration. Note that you cannot delete default configurations.

Copy

⌘D

Create a copy of the selected run/debug configuration. Note that you create copies of default configurations.

Edi Templates

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 svg

⌃↑/⌃↓

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-and-drop or Move Up and Move Down buttons.

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

Sort configurations

Sort configurations

Click this button to sort configurations in the alphabetical order.

Before Launch options

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

Item

Shortcut

Description

icons general add svg⌘N

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

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

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

icons general remove svg⌘⌦

Click this icon to remove the selected task from the list.

Edit

Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.

icons actions moveUp svg/icons actions moveDown svg

⌃↑/⌃↓

Click 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 page

Select 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 isn't shown. However, when the configuration is running, you can open the corresponding tool window for it yourself by pressing ⌘4 or ⌘5.

Last modified: 18 April 2019