Run/Debug Configuration: NW.js

Run | Edit Configurations | | 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 as described in Debugging a running Node.js application.

Before you start

Install NW.js. If you are going to debug your application, make sure you are using the SDK build of NW.js.
Install the Node.js plugin on the Settings/Preferences | Plugins page, tab Marketplace, as described in Installing plugins from JetBrains repository.

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 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	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`.
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 PyCharm stores run configuration settings in .idea/workspace.xml.

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.

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 PyCharm stores run configuration settings in .idea/workspace.xml.

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
	`Alt+Insert`	Create a run/debug configuration.
	`Alt+Delete`	Delete the selected run/debug configuration. Note that you cannot delete default configurations.
	`Ctrl+D`	Create a copy of the selected run/debug configuration. Note that you create copies of default configurations.
		The button is displayed only when you select a temporary configuration. Click this button to save a temporary configuration as permanent.
		View 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.
/	`Alt+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. You can group run/debug configurations by placing them into folders. To create a folder, select the configurations within a category, click , 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 and buttons. To remove grouping, select a folder and click .
		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.

Item	Shortcut	Description
	`Alt+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 PyCharm 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. 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 File Watchers: select this option to have PyCharm apply all the currently active File Watchers. 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. 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.
	`Alt+Delete`	Click this icon to remove the selected task from the list.
	`Enter`	Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
/	`Alt+Up`/ `Alt+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 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