forked from jbernoudy/cordova-docs
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
27 changed files
with
439 additions
and
256 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,12 +10,16 @@ This repository contains a set of documents and tutorials for the **Visual Studi | |
| 1. [Using Gulp with your Cordova projects](./tutorial-gulp) | ||
| 1. [Using Gulp to Build Cordova Projects](./tutorial-gulp/gulp-ci.md) | ||
| 1. [Invoking Gulp Tasks During a Cordova Build and the VS Task Runner Explorer](./tutorial-gulp/gulp-task-runner-explorer.md) | ||
| 1. [Compiling TypeScript wit Gulp](./tutorial-gulp/gulp-typescript.md) | ||
| 1. [Building Cordova Apps in a Team / Continuous Integration Environment](./tutorial-team-build) | ||
| 1. [Getting Start with Cordova & TFS 2015 or Visual Studio Online](./tutorial-team-build/TFS2015.md) | ||
| 1. [Getting Start with Cordova & TFS 2013](./tutorial-team-build/TFS2013.md) | ||
| 1. [Getting Start with Cordova & Jenkins CI](./tutorial-team-build/Jenkins.md) | ||
| 1. [Compiling TypeScript with Gulp](./tutorial-gulp/gulp-typescript.md) | ||
| 1. [Building Cordova Apps in a Team / Continuous Integration (CI) Environment](./tutorial-team-build) | ||
| 1. [Getting Started with Cordova & TFS 2015 or Visual Studio Online](./tutorial-team-build/TFS2015.md) | ||
| 1. [Getting Started with Cordova & TFS 2013](./tutorial-team-build/TFS2013.md) | ||
| 1. [Getting Started with Cordova & Jenkins CI](./tutorial-team-build/Jenkins.md) | ||
| 1. [Package & Publish your Cordova Applications](./tutorial-package-publish) | ||
| 1. [Build and Simulate iOS in the Cloud](http://go.microsoft.com/fwlink/?LinkID=618476) (MSDN) | ||
| 1. [Build a Cordova app for iOS using Parallels](http://go.microsoft.com/fwlink/?LinkID=618477) (MSDN) | ||
| 1. [Run the Android Emulator on OSX when using Windows in Parallels](http://go.microsoft.com/fwlink/?LinkID=618478) (MSDN) | ||
| 1. [Convert a Cordova Project to a PhoneGap Project](http://go.microsoft.com/fwlink/?LinkID=618479) (MSDN) | ||
|
|
||
| <a name="tips"></a> | ||
| ## Tips & Workarounds | ||
|
|
@@ -46,7 +50,7 @@ Help us improve out docuementaiton by sending us a pull-request or opening a [Gi | |
| * [Download samples from our Cordova Samples repository](http://github.com/Microsoft/cordova-samples) | ||
| * [Follow us on Twitter](https://twitter.com/VSCordovaTools) | ||
| * [Visit our site http://aka.ms/cordova](http://aka.ms/cordova) | ||
| * [Read MSDN docs on using Visual Studo Tools for Apache Cordova](http://go.microsoft.com/fwlink/?LinkID=533794) | ||
| * [Read MSDN docs on using Visual Studio Tools for Apache Cordova](http://go.microsoft.com/fwlink/?LinkID=533794) | ||
| * [Ask for help on StackOverflow](http://stackoverflow.com/questions/tagged/visual-studio-cordova) | ||
| * [Email us your questions](mailto:/[email protected]) | ||
|
|
||
|
|
||
Submodule cordova-docs-private
added at
faf243
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -46,6 +46,6 @@ If this does not resolve the issue, you can upgrade to a 64-bit version of the J | |
| * [Download samples from our Cordova Samples repository](http://github.com/Microsoft/cordova-samples) | ||
| * [Follow us on Twitter](https://twitter.com/VSCordovaTools) | ||
| * [Visit our site http://aka.ms/cordova](http://aka.ms/cordova) | ||
| * [Read MSDN docs on using Visual Studo Tools for Apache Cordova](http://go.microsoft.com/fwlink/?LinkID=533794) | ||
| * [Read MSDN docs on using Visual Studio Tools for Apache Cordova](http://go.microsoft.com/fwlink/?LinkID=533794) | ||
| * [Ask for help on StackOverflow](http://stackoverflow.com/questions/tagged/visual-studio-cordova) | ||
| * [Email us your questions](mailto://[email protected]) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,6 +5,13 @@ This article covers [known issues](../Readme.md#knownissues) related to Visual S | |
| In general we recommend **using Cordova 5.1.1 or above** instead of 5.0.0 as there are a number of issues including a security hole with Cordova 5.0.0. | ||
|
|
||
| ##Apache Cordova 5.x.x General Issues | ||
| ---------- | ||
| **Old versions of Cordova plugins due to Cordova plugin ID changes:** A significant change occurred with Cordova 5.0.0+ that also altered the IDs of many core Cordova plugins. The Visual Studio 2015 config.xml designer uses the old IDs (ex: org.apache.cordova.camera not cordova-plugin-camera) because Cordova 4.3.1 and below cannot access plugins using these new IDs and the default template uses 4.3.1. | ||
|
|
||
| To install updated plugins, follow [this proceedure to install a npm sourced plugin](../tips-and-workarounds/general/README.md#plugin-npm). | ||
|
|
||
| *Note that these updated plugins were tested on Cordova 5.0.0 or later and therefore may or may not work on earlier versions of Cordova.* We advise against updating your plugins when using older versions of Cordova unless you are attempting to solve a specific problem. | ||
|
|
||
| ---------- | ||
| **Cannot access any network resources from Android app:** The Android platform contained within Cordova 5.0.0+ does not have a "whitelist" plugin installed by default and therefore blocks network access by default. There are now two whitelist plugins that can be installed: | ||
|
|
||
|
|
@@ -22,19 +29,17 @@ line or by adding this XML element to config.xml (see [this article for more det | |
| ~~~~~~~~~~~~~~~~~ | ||
| ---------- | ||
| **Ripple throws error when starting up Cordova:** Ripple does not function properly in Cordova 5.0.0 due to a newly introduced validation check. This problem was fixed in Cordova 5.1.1. | ||
| **Error when adding plugin using Git URI with Cordova 5.1.1:** Cordova 5.1.1 has a bug that can cause plugins installed from a Git repo to fail with the error **Error: EXDEV, cross-device link not permitted** if the project is on a different drive than your temp folder. | ||
| ---------- | ||
| **Missing Android SDK 22:** The Android platform in Cordova 5.0.0 requires Android SDK API Level 22 which is not pre-installed by Visual Studio. Install the SDK using the Android SDK manager. | ||
| See [tips and workarounds](../tips-and-workarounds/general/README.md#plugin-xml) for information on adding plugins not in the config designer from either the Cordova plugin repository or npm. If you must add a Git version of the plugin, either move your project to the same drive as your temp folder when installing or you can instead download a copy, unzip it, and add the plugin from the filesystem. | ||
| ##Apache Cordova 5.x.x and Visual Studio 2015 RC | ||
| ---------- | ||
| **Old versions of Cordova plugins due to Cordova plugin ID changes:** A significant change occurred with Cordova 5.0.0+ that also altered the IDs of many core Cordova plugins. The Visual Studio 2015 RC config.xml designer uses the old IDs (ex: org.apache.cordova.camera not cordova-plugin-camera) because Cordova 4.3.1 and below cannot access plugins using these new IDs and the default template uses 4.3.0. | ||
| **Missing Android SDK 22:** The Android platform in Cordova 5.0.0 requires Android SDK API Level 22 which may not be installed on your system. Install the SDK using the Android SDK manager. | ||
| To install updated plugins, follow [this proceedure to install a npm sourced plugin](../tips-and-workarounds/general/README.md#plugin-npm). | ||
| ---------- | ||
| **Ripple throws error when starting up Cordova 5.0.0:** Ripple does not function properly in Cordova 5.0.0 due to a newly introduced validation check. This problem was fixed in Cordova 5.1.1. | ||
| *Note that these updated plugins were tested on Cordova 5.0.0 or later and therefore may or may not work on earlier versions of Cordova.* We advise against updating your plugins when using older versions of Cordova unless you are attempting to solve a specific problem. | ||
| ##Apache Cordova 5.x.x and Visual Studio 2015 RC | ||
| ---------- | ||
| **Visual Studio 2015 RC uses Ant to build Android with Cordova 5.x.x:** Visual Studio 2015 RC uses Ant to build Android while the command line has switched to Gradle by default in version 5.0.0 of the CLI. When switching between Visual Studio and the command line with the version of Android in Cordova 5.0.0, you may want to specify that the platform should be built with Ant instead if you are running into unexpected issues. | ||
|
|
@@ -74,7 +79,7 @@ Finally, if you are still build errors, you may want to opt to remove and re-add | |
| * [Download samples from our Cordova Samples repository](http://github.com/Microsoft/cordova-samples) | ||
| * [Follow us on Twitter](https://twitter.com/VSCordovaTools) | ||
| * [Visit our site http://aka.ms/cordova](http://aka.ms/cordova) | ||
| * [Read MSDN docs on using Visual Studo Tools for Apache Cordova](http://go.microsoft.com/fwlink/?LinkID=533794) | ||
| * [Read MSDN docs on using Visual Studio Tools for Apache Cordova](http://go.microsoft.com/fwlink/?LinkID=533794) | ||
| * [Ask for help on StackOverflow](http://stackoverflow.com/questions/tagged/visual-studio-cordova) | ||
| * [Email us your questions](mailto://[email protected]) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -58,6 +58,6 @@ This article covers [known issues and limitations](../Readme.md#knownissues) rel | |
| * [Download samples from our Cordova Samples repository](http://github.com/Microsoft/cordova-samples) | ||
| * [Follow us on Twitter](https://twitter.com/VSCordovaTools) | ||
| * [Visit our site http://aka.ms/cordova](http://aka.ms/cordova) | ||
| * [Read MSDN docs on using Visual Studo Tools for Apache Cordova](http://go.microsoft.com/fwlink/?LinkID=533794) | ||
| * [Read MSDN docs on using Visual Studio Tools for Apache Cordova](http://go.microsoft.com/fwlink/?LinkID=533794) | ||
| * [Ask for help on StackOverflow](http://stackoverflow.com/questions/tagged/visual-studio-cordova) | ||
| * [Email us your questions](mailto://[email protected]) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,7 +16,7 @@ This article covers general [known issues](../Readme.md#knownissues) related to | |
| - plugins/remote_ios.json | ||
| - plugins/wp8.json. | ||
|
|
||
| Remove these files from source control if you are not checking in the "platforms" folder (reccomended). For local copies, you can either fetch a fresh copy from source control or remove the above files along with platforms found in the "platforms" folder to resolve the issue. See [tips and workarounds](../tips-and-workarounds/general/README.md#l#missingexclude) for additional details. | ||
| Remove these files from source control if you are not checking in the "platforms" folder (recommended). For local copies, you can either fetch a fresh copy from source control or remove the above files along with platforms found in the "platforms" folder to resolve the issue. See [tips and workarounds](../tips-and-workarounds/general/README.md#l#missingexclude) for additional details. | ||
|
|
||
| ---------- | ||
| **Plugin with variables not working:** Due to a Cordova issue with Cordova 4.3.0 and 4.3.1, you can run into problems with plugin variables in Cordova < 5.0.0. Plugin variable information is lost if you install the "plugin" before the "platform" which can happen depending on your workflow. They do, however, function in Cordova 5.1.1 which you can use with VS 2015. Follow these steps to use a plugin with variables: | ||
|
|
@@ -30,25 +30,55 @@ Remove these files from source control if you are not checking in the "platforms | |
| ---------- | ||
| **Slow first build or first plugin add:** The first build or plugin add for a given version of Cordova will be slower than subsequent builds as VS must first dynamically acquire Cordova. See the Output Window for more detail on progress. Further, the first remote iOS build will exhibit the same behavior as the agent downloads Cordova on your OSX machine. If you encounter a CordovaModuleLoadError with the first iOS build for a given Cordova version you can follow [these instructions](../tips-and-workarounds/ios/README.md#npm-cache) to resolve the problem. | ||
|
|
||
| ---------- | ||
| **Old versions of Cordova plugins due to Cordova plugin ID changes:** A significant change occurred with Cordova 5.0.0+ that also altered the IDs of many core Cordova plugins. The Visual Studio 2015 config.xml designer uses the old IDs (ex: org.apache.cordova.camera not cordova-plugin-camera) because Cordova 4.3.1 and below cannot access plugins using these new IDs and the default template uses 4.3.1. | ||
|
|
||
| To install updated plugins, follow [this proceedure to install a npm sourced plugin](../tips-and-workarounds/general/README.md#plugin-npm). | ||
|
|
||
| *Note that these updated plugins were tested on Cordova 5.0.0 or later and therefore may or may not work on earlier versions of Cordova.* We advise against updating your plugins when using older versions of Cordova unless you are attempting to solve a specific problem. | ||
|
|
||
| ---------- | ||
| **Git sourced plugins will not install:** Git sourced plugins will not install properly if you have not installed the [Git command line tools](http://www.git-scm.com/downloads) and have them in your system path. During installation of the Git tools, select the "Use Git from the Windows Command Prompt" option or add the "bin" folder from the Git install location to your path and restart VS. (Usually "C:\Program Files (x86)\Git\bin"). | ||
|
|
||
| ---------- | ||
| **Git sourced plugins will not install with Cordova 5.1.1 only:** Cordova 5.1.1 has a bug that can cause plugins installed from a Git repo to fail with the error "Error: EXDEV, cross-device link not permitted" if the project is on a different drive than your temp folder. | ||
|
|
||
| See [tips and workarounds](../tips-and-workarounds/general/README.md#plugin-xml) for information on adding plugins not in the config designer from either the Cordova plugin repository or npm. If you must add a Git version of the plugin, either move your project to the same drive as your temp folder when installing or you can instead download a copy, unzip it, and add the plugin from the filesystem. | ||
|
|
||
| ---------- | ||
| **TypeError: Request path contains unescaped characters:** When building or installing a plugin you may encounter this error if you are using a proxy with certain versions of Node.js and Cordova after a "npm http GET". This is a Cordova issue and the simplest workaround is to downgrade [Node.js 0.10.29](http://nodejs.org/dist/v0.10.29/). This will be resolved in a future version of Cordova. See [tips and workarounds](../tips-and-workarounds/general/README.md#cordovaproxy) for additional details. | ||
|
|
||
| ---------- | ||
| **Errors from npm related to permission problems:** If you installed Visual Studio or Node.js running as an administrator, you can run into problems where npm attempts to install npm packages under "C:\Program Files (x86)\node.js". You will typically see errors in the Output Window similar to this one: "npm ERR! error rolling back error : EPERM, unlink 'C:\Program Files (x86)\nodejs\vs-tac-cli.cmd'". To resolve this issue you can re-install Node.js or reconfigured npm using these commands from the command prompt and restarting Visual Studio: | ||
|
|
||
| ~~~~~~~~~~~~~~~~~~~~~~~ | ||
| npm config set prefix %APPDATA%\npm | ||
| npm config set cache %APPDATA%\npm-cache | ||
| ~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| ---------- | ||
| **Frequent ECONRESET errors from npm when using VPN or proxy:** Node.js can experience intermittent issues connecting to the npm repository via SSL with certain versions of Node.js and npm when connected to VPN or when a proxy is configured. You can resolve this issue by configuring npm to connect to the registry using straight HTTP instead using this command from the command prompt: | ||
|
|
||
| ~~~~~~~~~~~~~~~~~~~~~~~ | ||
| npm config set registry http://registry.npmjs.org | ||
| ~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| ---------- | ||
| **FATAL ERROR: CALL_AND_RETRY_LAST Allocation failed - process out of memory:** This error can occur if you are using a recent version of Node.js (ex: 0.12.4) due to a [known npm issue](https://github.com/npm/npm/issues/8019). The simplest solution is to downgrade to [Node.js 0.10.29](http://nodejs.org/dist/v0.10.29/). | ||
|
|
||
| ---------- | ||
| **Missing Intellisense:** | ||
| - No IntelliSense is provided for Cordova plugins in JavaScript files in Apache Cordova projects. As a workaround, developers can enable IntelliSense for Cordova plugins by explicitly adding “/// <reference group="Implicit (Multi-Device Apps)” />” to the JavaScript file. | ||
| - No IntelliSense is provided within JavaScript files for other JavaScript files included via a script tag in a referring HTML page. As a workaround, developers can enable IntelliSense for other referenced JavaScript files by explicitly adding “/// <reference path=”referencedFile.js” />” to the JavaScript file. | ||
| **Globally installed npm packages not available from command line:** If you have installed Visual Studio or Node.js with a different user than you are logging into Windows, you may need to update your path to access globally installed (npm install -g) npm packages from the command line. Specifically, ensure **%APPDATA%\npm** is either in your user or system PATH. By default the installation of Node.js will set the PATH as a user environment variable rather than system which is why you can encounter this behavior. | ||
|
|
||
| ---------- | ||
| **TypeScript code incorrectly identified as external, cannot read user configuration file:** When using TypeScript, there are known issues that will incorrectly identify project items as external code or will fail to read in a user configuration file. To avoid unexpected behavior when working with a Cordova TypeScript project, turn off Just My Code (Options > Debugger > General > uncheck Enable Just My Code). | ||
|
|
||
| ---------- | ||
| **Globally installed npm packages not available from command line:** If you have installed Visual Studio or Node.js with a different user than you are logging into Windows, you may need to update your path to access globally installed (npm install -g) npm packages from the command line. Specifically, ensure **%APPDATA%\npm** is either in your user or system PATH. By default the installation of Node.js will set the PATH as a user environment variable rather than system which is why you can encounter this behavior. | ||
| **TypeScript breakpoints stop at the wrong location when using Ripple:** This is a known issue that is being activley worked. This problem does not occur when using devices or emulators. | ||
|
|
||
| ---------- | ||
| **Missing Intellisense:** | ||
| - No IntelliSense is provided for Cordova plugins in JavaScript files in Apache Cordova projects. As a workaround, developers can enable IntelliSense for Cordova plugins by explicitly adding “/// <reference group="Implicit (Multi-Device Apps)” />” to the JavaScript file. | ||
| - No IntelliSense is provided within JavaScript files for other JavaScript files included via a script tag in a referring HTML page. As a workaround, developers can enable IntelliSense for other referenced JavaScript files by explicitly adding “/// <reference path=”referencedFile.js” />” to the JavaScript file. | ||
|
|
||
| ---------- | ||
| **"res" folder contents cannot be referenced from web content:** By design, the contents of the “res” folder cannot be accessed by web content as they are copied into platform-specific native project locations. | ||
|
|
@@ -62,6 +92,6 @@ Remove these files from source control if you are not checking in the "platforms | |
| * [Download samples from our Cordova Samples repository](http://github.com/Microsoft/cordova-samples) | ||
| * [Follow us on Twitter](https://twitter.com/VSCordovaTools) | ||
| * [Visit our site http://aka.ms/cordova](http://aka.ms/cordova) | ||
| * [Read MSDN docs on using Visual Studo Tools for Apache Cordova](http://go.microsoft.com/fwlink/?LinkID=533794) | ||
| * [Read MSDN docs on using Visual Studio Tools for Apache Cordova](http://go.microsoft.com/fwlink/?LinkID=533794) | ||
| * [Ask for help on StackOverflow](http://stackoverflow.com/questions/tagged/visual-studio-cordova) | ||
| * [Email us your questions](mailto://[email protected]) | ||
Oops, something went wrong.