Package Exports
- assemble-handle
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (assemble-handle) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
assemble-handle 
Assemble pipeline plugin for handling custom middleware stages.
Install
Install with npm:
$ npm install --save assemble-handleUsage
var handle = require('assemble-handle');handle
Handle middleware for the given middleware "stage".
app.task('default', function() {
return app.src('*.js')
.pipe(handle(app, 'handlerName')) //<= handle middleware
.pipe(app.dest('foo'))
});Example
var assemble = require('assemble');
var handle = require('assemble-handle');
var app = assemble();
/**
* create some middleware "stages"
*/
app.handler('onStream');
app.handler('preWrite');
app.handler('postWrite');
/**
* Create middleware
*/
app.onStream(/\.(js|css)$/, function(file, next) {
// lint javascript
next();
});
app.preWrite(/\.(jpg|png)$/, function(file, next) {
// minify images
next();
});
app.postWrite(/./, function(file, next) {
// create files tree or something
next();
});
/**
* Run (handle) the middleware
*/
app.task('site', function() {
return app.src('assets/**/*.*')
.pipe(handle(app, 'onStream')) // handle onStream
.pipe(handle(app, 'preWrite')) // handle preWrite
.pipe(app.dest('site/'));
.pipe(handle(app, 'postWrite')) // handle postWrite
});handle.once
A .once method is exposed, which has the same exact behavior as the main function, but will ensure that middleware is only handled once for a given "stage".
Example
For example the given middleware will only run once.
var assemble = require('assemble-core');
var handle = require('assemble-handle');
var app = assemble();
app.handler('onFoo');
app.onFoo(/./, function(file, next) {
file.count = file.count || 0;
file.count++;
next();
});
app.task('handle-once', function(cb) {
var files = [];
app.src('test/**/*.*')
.pipe(handle.once(app, 'onFoo'))
.pipe(handle.once(app, 'onFoo'))
.pipe(handle.once(app, 'onFoo'))
.pipe(handle.once(app, 'onFoo'))
.pipe(handle.once(app, 'onFoo'))
.on('data', function(file) {
files.push(file);
})
.pipe(app.dest('test/actual'))
.on('end', function() {
console.log(files[0].count);
//=> 1
cb();
});
});
app.task('handle', function(cb) {
var files = [];
app.src('test/**/*.*')
.pipe(handle(app, 'onFoo'))
.pipe(handle(app, 'onFoo'))
.pipe(handle(app, 'onFoo'))
.pipe(handle(app, 'onFoo'))
.pipe(handle(app, 'onFoo'))
.on('data', function(file) {
files.push(file);
})
.pipe(app.dest('test/actual'))
.on('end', function() {
console.log(files[0].count);
//=> 5
cb();
});
});Custom handlers
Create custom middleware handlers.
app.handler('onFoo');This adds an .onFoo method to the instance:
app.onFoo(/\.hbs$/, function(file, next) {
// do stuff to file
next();
});All .onFoo middleware will now run when the onFoo handler is called:
app.task('default', function() {
return app.src('*.hbs')
// call the `onFoo` handler
.pipe(handle(app, 'onFoo'))
});About
Related projects
- assemble-core: The core assemble application with no presets or defaults. All configuration is left to the… more | homepage
- assemble-fs: Assemble plugin to add methods to assemble for working with the file system, like src… more | homepage
- assemble-streams: Assemble pipeline plugin for pushing a view collection into a vinyl stream. | homepage
- assemble: Get the rocks out of your socks! Assemble makes you fast at creating web projects… more | homepage
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Building docs
(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)
To generate the readme and API documentation with verb:
$ npm install -g verb verb-generate-readme && verbRunning tests
Install dev dependencies:
$ npm install -d && npm testAuthor
Jon Schlinkert
License
Copyright © 2016, Jon Schlinkert. Released under the MIT license.
This file was generated by verb, v0.9.0, on July 21, 2016.