grunt-bower-event
v0.4.0
Published
Now Grunt is talking your Bower language, listening for answers.
Downloads
8
Readme
grunt-bower-event
Now Grunt is talking your Bower language, listening for answers.
Getting Started
This plugin requires Grunt ~0.4.0
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-bower-event --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-bower-event');
This plugin was designed to work with Grunt 0.4.x. If you're still using grunt v0.3.x it's strongly recommended that you upgrade, but in case you can't please use v0.3.2.
Bower task
Run this task with the grunt bower
command.
Task targets, files and options may be specified according to the grunt Configuring tasks guide.
Options
bowerDirectory
Type: String
Default: current working directory of grunt
Bower working directory where your .bowerrc configuration is located.
config
Type: Object
Default: empty, Bower default config
Bower configuration according to the specification. Leave blank for Bower's default config.
arguments
Type: Array
Default: empty
Arguments that are passed to the bower command. Leave blank if command does not take arguments.
Example: ['bootstrap']
for command 'bower install'
.
argumentOptions
Type: Object
Default: empty
Argument options that are passed to the bower command.
Example: {"force-latest": true}
for command bower install
eventPrefix
Type: String
Default: bower.
Bower events are namespace-prefixed with this label when they are emitted through the grunt.event
API.
Example: listen for a log event with grunt.event.on('bower.log', function (data) { ... })
Usage Examples
Simple Bower command
bower: {
install: {
}
}
The above configuration will run bower install
.
Just give the desired bower command as grunt target. The list of commands is available at Bower's API documentation
Explicit Bower command
bower: {
customTarget: {
command: 'list'
}
}
The above configuration will run bower list
.
Subscribe to Bower events
grunt.event.on('bower.end', function (data, command) {
console.log("received data from command: " + command);
console.log(data);
});
Events from bower commands are emitted through the grunt.event
API. The events are log
, error
,
end
, and prompt
. They are prefixed with the option given by eventPrefix
, e.g. "bower.end" in the
example above.
The callback takes two parameters: the data
object that the bower command produced and a string argument
command
, e.g. "install".
TODO
more samples to come..
Release History
- 2016-03-13 v0.4.0 Release for #5. Version bumps.
- 2015-02-14 v0.3.1 Release for #3 and #4.
- 2014-12-29 v0.3.0 NPM registry version fixes. I encourage you to use v0.3.0 and later.
- 2014-12-29 v0.2.1 Filter events by bower command (see issue #2).
- 2014-08-25 v0.2.0 Publish a version to npm registry.
- 2013-07-11 v0.1.0 First version.