Add plugins to your cordova project.
$ npm install --save-dev gulp-cordova-plugin
The following example will add three plugins to the cordova project. The plugin.google.maps
plugin expects two extra
variables.
const gulp = require('gulp');
const create = require('gulp-cordova-create');
const plugin = require('gulp-cordova-plugin');
gulp.task('build', () => {
return gulp.src('dist')
.pipe(create())
.pipe(plugin('org.apache.cordova.dialogs'))
.pipe(plugin('org.apache.cordova.camera'))
.pipe(plugin('plugin.google.maps', {variables: {'API_KEY_FOR_ANDROID': 'xxx', 'API_KEY_FOR_IOS': 'xxx'}}));
});
It's also possible to use a specific version of a plugin.
const gulp = require('gulp');
const create = require('gulp-cordova-create');
const plugin = require('gulp-cordova-plugin');
gulp.task('build', () => {
return gulp.src('dist')
.pipe(create())
.pipe(plugin('org.apache.cordova.dialogs', '1.0.0'))
.pipe(plugin('org.apache.cordova.camera', 'latest'))
.pipe(plugin('plugin.google.maps', {version: '2.3.0', variables: {'API_KEY_FOR_ANDROID': 'xxx', 'API_KEY_FOR_IOS': 'xxx'}}));
});
You can also pass an array of plugins instead of one plugin at a time.
const gulp = require('gulp');
const create = require('gulp-cordova-create');
const plugin = require('gulp-cordova-plugin');
gulp.task('build', function() {
return gulp.src('dist')
.pipe(create())
.pipe(plugin([
'org.apache.cordova.dialogs',
'org.apache.cordova.camera'
]));
});
This method is faster because it adds the plugins in parallel instead of in series. The downside on the other hand is that you can't provide an options object for a plugin and thus it is not possible to provide extra variables.
You can change the version by adding @x.y.z
at the end of the name.
const gulp = require('gulp');
const create = require('gulp-cordova-create');
const plugin = require('gulp-cordova-plugin');
gulp.task('build', function() {
return gulp.src('dist')
.pipe(create())
.pipe(plugin([
'org.apache.cordova.dialogs@1.0.0',
'org.apache.cordova.camera'
]));
});
A third way of adding plugins is by passing an object with the name of the plugin as key and a version or options object as value.
const gulp = require('gulp');
const create = require('gulp-cordova-create');
const plugin = require('gulp-cordova-plugin');
gulp.task('build', function() {
return gulp.src('dist')
.pipe(create())
.pipe(plugin({
'org.apache.cordova.dialogs': '1.0.0',
'org.apache.cordova.camera': 'latest',
'plugin.google.maps': {version: '2.3.0', variables: {'API_KEY_FOR_ANDROID': 'xxx', 'API_KEY_FOR_IOS': 'xxx'}}
}));
});
This approach is fast because it adds the plugins in parallel and the benefit is that you can pass in an options object.
Required
Type: string
The plugin that should be added to the project.
Type: object|string
Extra options for the plugin that should be added or the version number of the plugin.
Required
Type: string[]
A list of plugins that should be added to the project.
Required
Type: object
The key of the object is the name of the plugin and the value is either the version number or an options object.
See gulp-cordova
for the full list of available packages.
MIT © Sam Verschueren