AppCode 2019.2 Help

Run/Debug Configuration: NW.js

Run | Edit Configurations | Add New Configuration | NW.js


In this dialog, create configurations for running NW.js applications and debugging their main processes. To debug background and additional main processes, use the Attach to Node.js/Chrome run/debug configuration.

Before you start

  1. Install NW.js. If you are going to debug your application, make sure you are using the SDK build of NW.js.

  2. Install the NodeJS plugin on the Plugins page as described in Manage plugins.

NW.js-specific configuration settings

Item

Description

NW.js app

In this field, specify the application to launch. You can select an entire directory that contains a package.json file or the same directory packed into an archive with the .nw extension.

NW.js arguments

In this field, specify the arguments to be passed to NW.js. If necessary, click Expand and type the arguments in the textual editor that opens.

Working directory

In this field, specify the working directory of the application. By default, the Working directory field shows the project root folder. To change this predefined setting, specify the path to the desired folder or choose a previously used folder from the list.

Environment variables

In this field, specify the environment variables for the executable file, if applicable.

NW.js interpreter

Specify the path to the NW.js executable file.

Common

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 through VCS

Select this checkbox to put the run/debug configuration under version control and make it 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 .

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

the Add button⌘N

Create a run/debug configuration.

the Remove button⌘⌦

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.

Save configuration

The button is displayed only when you select a temporary configuration. Click this button to save a temporary configuration as permanent.

Edit Templates

View and edit the template (that is, the default settings) for the selected run/debug configuration. The templates are displayed under the Templates node and used for newly created configurations.

Method up/Method 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 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

the Add button⌘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 Manage 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 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 npm Script: select this option to execute an npm script.

    In the NPM Script dialog 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.

the Remove button⌘⌦

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.

Method up/Method down

⌃↑/⌃↓

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: 10 October 2019