"Wraps a web application as a hybrid app with Apache Cordova CLI 3.x"
More information about the new Apache Cordova 3.x Command-line Interface
This plugin requires Grunt ~0.4.1
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-cordovacli --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-cordovacli');
Run this task with the grunt cordovacli command.
In your project's Gruntfile, add a section named cordovacli to the data object passed into grunt.initConfig().
cordovacli: {
options: {
path: 'myHybridAppFolder'
},
cordova: {
options: {
command: ['create','platform','plugin','build'],
platforms: ['ios','android'],
plugins: ['device','dialogs'],
path: 'myHybridAppFolder',
id: 'io.cordova.hellocordova',
name: 'HelloCordova'
}
},
create: {
options: {
command: 'create',
id: 'com.myHybridApp',
name: 'myHybridApp'
}
},
add_platforms: {
options: {
command: 'platform',
action: 'add',
platforms: ['ios', 'android']
}
},
add_plugins: {
options: {
command: 'plugin',
action: 'add',
plugins: [
'battery-status',
'camera',
'console',
'contacts',
'device',
'device-motion',
'device-orientation',
'dialogs',
'file',
'geolocation',
'globalization',
'inappbrowser',
'media',
'media-capture',
'network-information',
'splashscreen',
'vibration'
]
}
},
build_ios: {
options: {
command: 'build',
platforms: ['ios']
}
},
build_android: {
options: {
command: 'build',
platforms: ['android']
}
},
emulate_android: {
options: {
command: 'emulate',
platforms: ['android'],
args: ['--target','Nexus5']
}
}
}
Type: String or Array
Valid values for String: 'create' 'platform' 'plugin' 'build' 'emulate' 'prepare' 'compile' 'run' 'serve'
Specify the cordova command when using String
Valid values for Array: 'create' 'platform' 'plugin' 'prepare' 'compile' 'build'
Specify a full cycle or series of cordova commands when is an Array
Type: String
Default value: 'io.cordova.hellocordova'
Use with Command: 'create'
Specify the ID (reverse-domain-style package name) for the Cordova App
Type: String
Default value: 'HelloCordova'
Use with Command: 'create'
Specify the Name for the Cordova App
Type: String
Default value: 'HelloCordova'
Specify the path to the Cordova project directory
Type: String
Valid value: 'add' 'rm' 'remove'
Required for Commands: 'platform'
Specify the action to perform
Type: String 'Array'
Valid value: 'ios' 'android' 'blackberry10' 'wp7' 'wp8'
Required for Commands: 'platform'
Not Applicable for Commands: 'plugin'
Optional for other commands
Specify the platform type
Type: String 'Array'
Shortcut values for Apache Cordova plugins:
'battery-status'
'camera'
'console'
'contacts'
'device'
'device-motion'
'device-orientation'
'dialogs'
'file'
'geolocation'
'globalization'
'inappbrowser'
'media'
'media-capture'
'network-information'
'splashscreen'
'vibration'
Use with Commands: 'plugin'
Specify the plugin to add to the Cordova project It can be specify in 4 forms:
- Shortcut (i.e. 'camera' it will be downloaded form plugins.cordova.io)
- ID (i.e. org.apache.cordova.device it will be downloaded from plugins.cordova.io)
- Git Url (i.e. https://git-wip-us.apache.org/repos/asf/cordova-plugin-file.git)
- Directory Path (~/userid/cordova/plugins/plugin1)
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.