gulp-cordova-builder v0.0.1
gulp-cordova-builder
Gulp wrapper for Apache cordova command line interface
Installation
Install cordova and gulp-cordova-builder with npm:
$ npm install --save cordova
$ npm install --save gulp-cordova-builder
Usage
Usage example:
var gulp = require('gulp');
var cordova = require('gulp-cordova-builder');
gulp.task("default", function() {
return gulp.src("mySrc")
.pipe(cordova.create({
dist: 'dist',
name: "myProject",
namespace: "fr.test",
xmlConfig: "myConfig.xml"
}))
.pipe(cordova.addPlatform("browser"))
.pipe(cordova.addPlugin("cordova-plugin-media"))
.pipe(cordova.build("browser"));
});
The gulp sources must be the directory of your sources. It will be copied into the 'www' folder generated by cordova.
API
Create
Initialize a new cordova folder with the command cordova create
and add source files into the generated folder.
cordova.create({
name: 'projectName', // Name of your application
namespace: 'org.test', // Namespace of your application
xmlConfig: 'config.xml', // Optionnal: path of the config.xml file for cordova configuration
dist: 'dist' // Optionnal: path where the cordova directory will be generated
})
The cordova command will be executed only if the application folder doesn't exist yet. Sources and xmlConfig file are always copied into the cordova folder.
Add plugin
Add a plugin to your application using the command cordova plugin add
.
cordova.addPlugin("pluginName")
If the directory 'plugins/' already exists in the cordova folder, the command won't be run.
Add platform
Add a platform to compile using the command cordova platform add
.
cordova.addPlatform('platformName')
If the directory 'platforms/' already exists in the cordova folder, the command won't be run.
Build
Run cordova build
command.
cordova.build() // Build for all registered platform
cordova.build("platform") // Build only for the given platform name
cordova.build({
platform: "platform",
buildConfig: "build.json" // Optionnal: a config file for the cordova build
})
For more information about builds, see the Cordova documentation.
Contributing
Feel free to make a pull request. Take care to add unit tests (npm test
).
Tests need to have cordova installed in node modules.
Licence
MIT © SERIN Kévin
7 years ago