gulp-cordova documentation

gulp-cordova is not a single library that takes care of everything, it is a bundle of multiple libraries that each leverage a different task in the chain of creating cordova projects.

Like many others, these libraries are build with code over configuration kept in mind.

Important

This entire project is still in beta. I'm working hard to deliver more plugins and to make the existing plugins bugfree. If something isn't working, please create a new issue in the appropriate plugin project. I will accept pull requests as well.

Table of contents

• Create a cordova project
• Add a plugin
• Set preferences
• Set version
• Set project description
• Set author
• Add an icon
• Add a splashscreen
• Build a project
  • Android
  • BlackBerry 10

Plugins

These plugins are currently available.

More plugins will follow in the near future.

General

1. gulp-cordova-create
   • Create a cordova project.

Configuration

These plugins can be used to change the configuration of the cordova project.

1. gulp-cordova-plugin
   • Add a plugin to your cordova project.
     
2. gulp-cordova-plugin-remove
   • Removes a plugin from the cordova project.
     
3. gulp-cordova-preference
   • Set the preferences of your cordova project.
     
4. gulp-cordova-access
   • Sets the access origins of the cordova project.
     
5. gulp-cordova-version
   • Sets the version of the cordova project in the config.xml file.
     
6. gulp-cordova-description
   • Sets the description of the cordova project in the config.xml file.
     
7. gulp-cordova-author
   • Sets the author of the cordova project in the config.xml file.
     
8. gulp-cordova-icon
   • Generates all the icons for your Cordova build automatically.
9. gulp-cordova-xml
   • Adds raw xml tags to your config.xml file.
     

Building

These build plugins can be used to build the cordova project for certain platforms.

1. gulp-cordova-build-android
   • Build the cordova project for the Android platform.
2. gulp-cordova-build-bb10
   • Build the cordova project for the BlackBerry 10 platform.
3. gulp-cordova-build-ios
   • Build the cordova project for the iOS platform.

Author

• @SamVerschueren [[email protected]]