grunt-cordova-config

Generates cordova config.xml file

Getting Started

This plugin requires Grunt.

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-cordova-config --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-cordova-config');

The "cordova_config" task

Overview

In your project's Gruntfile, add a section named cordova_config to the data object passed into grunt.initConfig().

grunt.initConfig({
  cordova_config: {
    my_target: {
        options : {
            id : 'com.example.hello',
            version : '1.0.0',
            // ...
        },
        dest : 'path/to/config.xml
      
    }
  },
})

Options

options.id

Type: String

Default value: com.example.hello

options.version

Type: String

Default value: 0.0.1

options.name

Type: String

Default value: HelloWorld

options.description

Type: String

Default value: A sample Apache Cordova application that responds to the deviceready event.

options.author.name

Type: String

Default value: Apache Cordova Team

options.author.email

Type: String

Default value: [email protected]

options.author.href

Type: String

Default value: http://cordova.io

options.content.src

Type: String

Default value: index.html

options.access.origin

Type: String

Default value: *

options.preferences

Type: Array

Example:

preferences: [
{
	name : 'fullscreen',
	value: true
},
{
	name : 'webviewbounce',
	value: false
},
...

Default value: []

options.features

Type: Array

Example:

features : {
  name : 'StatusBar',
  params: [
  	{
    	name  : 'ios-package',
    	value : 'CDVStatusBar',
    	onload: true
  	}
  ]
}

Default value: []

Usage Examples

Default Options

In this example, the default options are used to generate config.xml file. The result will be the same as after cordova create command

grunt.initConfig({
  cordova_config: {
    my_target : {
      dest: 'cordova-project/www/config.xml'
    }
  },
})

Custom Options

grunt.initConfig({
  cordova_config: {
    options: {
      id: 'com.example.application',
      name: 'app name',
      author : {
      	name : 'First Last',
        email : '[email protected]'
      },
      preferences: [
        {
          name : 'fullscreen',
          value: true
        },
        {
          name : 'webviewbounce',
          value: false
        },
        {
          name : 'UIWebViewBounce',
          value: false
        },
        {
          name : 'DisallowOverscroll',
          value: true
        },
        {
          name : 'BackupWebStorage',
          value: 'none'
        }
      ],
      features   : [
        {
          name  : 'StatusBar',
          params: [
              {
                  name  : 'ios-package',
                  value : 'CDVStatusBar',
                  onload: true
              }
          ]
        }
      ]
    },
    dest : 'cordova-project/www/config.xml'
  }
});

Contributing

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.

kerimdzhanov / grunt-cordova-config Goto Github PK