microsoft/vscode-cordova

microsoft/vscode-cordova

Description: A Visual Studio Code extension providing intellisense, debug, and build support for Cordova and Ionic projects.

Language: TypeScript

License: NOASSERTION

Stars: 300

Forks: 73

Open issues: 4

Created: 2016-01-08T18:11:41Z

Pushed: 2026-06-11T05:47:39Z

Default branch: master

Fork: no

Archived: no

README:

Cordova Tools Extension


Debug your code, find commands in the Command Palette, and use IntelliSense to browse objects, functions, and parameters in plugin APIs. This extension works with any Cordova-based project.


Table of Contents

• [Cordova Tools Extension](#cordova-tools-extension)
• [Package extension locally](#package-extension-locally)
• [Install cordova development and debugging environment](#install-cordova-development-and-debugging-environment)
• [Choose the Cordova debugging environment](#choose-the-cordova-debugging-environment)
• [Debug your Cordova-based project](#debug-your-cordova-based-project)
• [Using Cordova commands in the Command Palette](#using-cordova-commands-in-the-command-palette)
• [Support for Ionic](#support-for-ionic)
• [Support for Electron](#support-for-electron)
• [Using IntelliSense with Plugin APIs](#using-intellisense-with-plugin-apis)
• [Using IntelliSense with injected Ionic and Angular services](#using-intellisense-with-injected-ionic-and-angular-services)
• [How to disable telemetry reporting](#how-to-disable-telemetry-reporting)
• [Known Issues](#known-issues)

Package extension locally

You can not only download Cordova Tools in the marketplace, but can also package your extension .vsix installation file by yourself locally. Following this documentation to package and install your Cordova Tools to get the latest updates.

Install cordova development and debugging environment

1. Install cordova development environment following this 2. If you're planning on targeting iOS devices,

• Set up your machine by following instructions at iOS Platform Guide from Apache Cordova
• Install HomeBrew on your Mac.
• Open a Terminal and run brew install ideviceinstaller ios-webkit-debug-proxy

3. If you're planning on targeting Android devices, set up your machine by following instructions at Android Platform Guide from Apache Cordova 4. If you're planning to targeting Electron app, install Electron using npm install electron. 5. Add a platform to your cordova project using command cordova platform add android, currently supported platforms are android, ios, electron.

Choose the Cordova debugging environment

Click the Run and Debug icon in the Activity Bar on the side of VS Code, then click create a launch.json file, select Cordova as debugger and then pick debug configurations.




The launch configuration file appears. It contains some default configurations such as what is shown below.


You can modify these configurations or add new ones to the list. Just don't add a Windows configuration as it is not supported yet.

You can use other fields in these configurations as well. Here's the complete list:

| Name | Description | Defaults | | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | port | The port number that the debugger uses to connect to a device or emulator. Type: number | 9222 | | platform | The target platform to run for (either ios, android, browser or serve; other platforms are not currently supported). Type: string | n/a | | target | Target to run on. Possible values: emulator, device, `,. For simulation in the browser, you can use chrome, edge. If the value is emulator the quick pick window will be expanded with the names of the available Android virtual devices (for iOS virtual targets the list of available system versions of the target will be shown first, and after that another quick pick window will be expanded with the list of iOS simulators names with the selected version of the system), then the target value in launch.json will be changed to the AVD name/iOS Simulator udid of the selected virtual device. If you have only one virtual device available, it will be selected automatically. _Note: If you're using Android emulator targets, please, make sure the emulator utility is added to PATH._ **Type:** string | emulator | | trace | Trace may be set to true to print diagnostic logs of the extension to the console and write diagnostic logs of the Javascript debugger to the disk. **Type:** boolean | true | | sourceMaps | Set this field to true` if you want the debugger to use javascript sourcemaps (if they exist)....