AppCode 3.3 Help

Run/Debug Configuration: Grunt.js

In this dialog box, create configurations for running Grunt.js tasks.

On this page:

Getting Access to the Run/Debug Configuration: Grunt Dialog Box

  1. Install and enable the Node.js plugin.

    The plugin is not bundled with AppCode, but it can be installed from the JetBrains plugin repository as described in Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins.

    The plugin is not bundled with AppCode, but it can be installed from the JetBrains plugin repository as described in Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins.

  2. Download and install the NodeJS runtime environment that contains the Node Package Manager(npm).
  3. Install Grunt as described in Installing Grunt.

Grunt-Specific Configuration Settings

ItemDescription
Gruntfile In this field, specify the location of the Gruntfile.js file to retrieve the definitions of the tasks from. Select the path from the drop-down list or click the browseButton button and choose the file from the dialog box that opens.
Tasks In this field, specify the tasks to run. Do one of the following:
  • To run one task, select it from the drop-down list.
  • To run several tasks, type their names in the text box using blank spaces as separators.
Force execution Select this check box to have Grunt ignore warnings and continue executing the launched task until the task is completed successfully or an error occurs, If the check box is cleared, the task execution is stopped by the first reported warning.
Verbose mode Select this check box to have the verbose mode applied and thus have a full detailed log of a task execution displayed.
Node Interpreter In this field, specify the NodeJS installation home. Type the path to the NodeJS executable file manually, or click the browseButton.png button and select the location in the dialog box, that opens.
Node Options In this text box, type the NodeJS-specific command line options to be passed to the NodeJS executable file. See Node Parameters for details.
Grunt-cli Package In this field, specify the path to the globally installed Grunt-cli package installed globally See Installing Grunt.js for details.
Environment Variables In this field, specify the environment variables for the NodeJS executable file, if applicable. Click the Browse button browseButton.png to the right of the field and configure a list of variables in the Environment Variables dialog box, that opens:
  • To define a new variable, click the Add toolbar button add.png and specify the variable name and value.
  • To discard a variable definition, select it in the list and click the Delete toolbar button delete.png.
  • Click OK, when ready

The definitions of variables are displayed in the Environment variables read-only field with semicolons as separators. The acceptable variables are:

NODE_PATH A :-separated list of directories prefixed to the module search path.
NODE_MODULE_CONTEXTS Set to 1 to load modules in their own global contexts.
NODE_DISABLE_COLORS Set to 1 to disable colors in the REPL.

Toolbar

ItemShortcutDescription
add ⌘N Click this button to add a new configuration to the list.
delete ⌘⌦ Click this button to remove the selected configuration from the list.
copy ⌘D Click this button to create a copy of the selected configuration.
settings Edit defaultsClick this button to edit the default configuration templates. The defaults are used for newly created configurations.
arrowUp or arrowDown ⌃↑ or ⌃↓ 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 arrowUp arrowDown buttons.

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

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.

This check box is not available when editing the run/debug configuration defaults.

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
add ⌘N 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 AppCode. In the dialog that opens, select the application or applications that should be run. If the necessary application is not defined in AppCode yet, add its definition. For more information, see Configuring Third-Party Tools and External Tools.
  • 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 File Watchers. Select this option to have AppCode apply all the currently active file watchers, see Using File Watchers for details.
delete ⌘⌦ Click this icon to remove the selected task from the list.
edit1 Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
arrowUp ⌃↑ Click this icon to move the selected task one line up in the list.
arrowDown ⌃↓ 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

Last modified: 10 February 2016