Run/Debug Configuration: PhoneGap/Cordova

This feature is supported in the Professional edition only.

Use this dialog box to create configurations for running and debugging applications developed through integration with the help of PhoneGap, Apache Cordova, and Ionic frameworks and intended for running on various mobile platforms, including Android.

On this page:

Getting access to the Run/Debug Configuration: PhoneGap/Cordova dialog
PhoneGap/Cordova/Ionic-specific configuration settings
Toolbar
Common options

Getting access to the Run/Debug Configuration: PhoneGap/Cordova dialog

Make sure the PhoneGap/Cordova plugin is enabled. The plugin is not bundled with PyCharm, but it can be installed from the JetBrains plugin repository as described in Installing, Updating and Uninstalling Repository Plugins and Enabling and Disabling Plugins.

PhoneGap/Cordova/Ionic-specific configuration settings

Item	Description
PhoneGap/Cordova Executable Path	In this field, specify the location of the executable file `phonegap.cmd`, `cordova.cmd`, or `ionic.cml` (see Installing PhoneGap/Cordova/Ionic).
PhoneGap/Cordova Working Directory	In this field, specify the folder under which the PhoneGap/Cordova/Ionic application files to run are stored.
Command	From this drop-down list, choose the command to run. The contents of the drop-down list, depend on the actually used framework, namely, on the executable file specified in the PhoneGap/Cordova Executable Path field. The available options are: For PhoneGap: emulate run prepare serve remote build remote run See https://www.npmjs.org/package/phonegap for a list of PhoneGap-specific commands with descriptions. For Cordova: emulate run prepare serve See https://www.npmjs.org/package/cordova for a list of Cordova-specific commands with descriptions. For Ionic: emulate run prepare serve See https://www.npmjs.org/package/ionic for a list of Ionic-specific commands with descriptions.
Platform	From this drop-down list, choose the platform for running on which the application is intended. The available options are: Android ios To emulate this platform, you need to install the ios-sim command line tool globally. You can do it through the Node Package Manager (npm), see Installing and Removing External Software Using Node Package Manager or by running the `sudo npm install ios-sim -g` command, depending on your oeprating system. amazon-fireos firefoxos blackberry10 ubuntu wp8 windows8 browser Learn more about targeted platforms at http://docs.phonegap.com/en/edge/guide_platforms_index.md.html#Platform%20Guides and http://cordova.apache.org/docs/en/4.0.0/guide_cli_index.md.html#The%20Command-Line%20Interface.
Specify Target	Select this check box to appoint an Android physical or virtual device to run the application on and select the required device from the drop-down list. The list shows all the virtual and physical devices that are currently configured on our machine. See http://docs.phonegap.com/en/edge/guide_platforms_android_index.md.html#Android%20Platform%20Guide for details. If PyCharm displays the following error message: Cannot detect ios-sim in path, make sure you have installed the `ios-sim`, see Before you start.

Toolbar

Item	Shortcut	Description
	`Alt+Insert`	Click this button to add a new configuration to the list.
	`Alt+Delete`	Click this button to remove the selected configuration from the list.
	`Ctrl+D`	Click this button to create a copy of the selected configuration.
	Edit defaults	Click this button to edit the default configuration templates. The defaults are used for newly created configurations.
or	`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.
	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 buttons.
	Sort configurations	Click this button to sort configurations in alphabetical order.

Common options

Item Description

Name In 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.

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.

Single instance only

If this check box is selected, this run/debug configuration cannot be launched more than once.

Every time a new run/debug configuration is launched, PyCharm 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 launch

Specify which tasks must be performed before applying the run/debug configuration. The specified tasks are performed in the order they appear in the list.

Item	Keyboard shortcut	Description
	`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 PyCharm. In the dialog that opens, select the application or applications that should be run. If the necessary application is not defined in PyCharm 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 PyCharm apply all the currently active file watchers, see Using File Watchers for details. 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 Remote External tool: Add a remote SSH external tool. Refer to the section Remote SSH External Tools for details. Upload files to Remote Host. Select this option to have the application files automatically uploaded to the server according to the default server access configuration. For more information, see Configuring Synchronization with a Web Server and Uploading and Downloading Files.
	`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`	Click this icon to move the selected task one line up in the list.
	`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 window		Select 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.

Procedures:

Using PhoneGap/Cordova

Reference:

PhoneGap/Cordova

Last modified: 26 July 2017

PyCharm 2017.1 Help