assemble-fs

assemble-fs

Light wrapper for vinyl-fs to add streams support in a way that plays nice with Assemble middleware.

Install

$ npm install --save assemble-fs

Heads up!

Usage

const Assemble = require('assemble');

// create your application and add the plugin
const app = new Assemble();
app.use(require('assemble-fs'))

// now you can use `src` and `dest`
app.src(['foo/*.hbs'])
  .pipe(app.dest('site/'));

API

.copy

• patterns {String|Array}: Glob patterns of files to copy.
• dest {String|Function}: Desination directory.
• returns {Stream}: Stream, to continue processing if necessary.

app.task('assets', function(cb) {
  app.copy('assets/**', 'dist/')
    .on('error', cb)
    .on('finish', cb)
});

.src

• glob {String|Array}: Glob patterns or file paths to source files.
• options {Object}: Options or locals to merge into the context and/or pass to src plugins

app.src('src/*.hbs', {layout: 'default'});

.symlink

• glob {String|Array}

app.symlink('src/**');

.dest

• dest {String|Function}: File path or rename function.
• options {Object}: Options and locals to pass to dest plugins

app.dest('dist/');

Release History

• Major breaking changes based on v1.0 of Assemble! Requires Assemble v1.0 or above.

• emit end on app when stream ends

• breaking change! plugin is wrapped in a function that now be called when registered. e.g. fs(). This is to be consistent with assemble's plugin guidelines, and allows the plugin to be auto-loaded following the same format as other plugins.
• rename files array to streamFiles
• adds onStream middleware handler to src
• adds preWrite middleware handler to dest

About

$ npm install && npm test

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

• generate: Command line tool and developer framework for scaffolding out new GitHub projects. Generate offers the… more | homepage
• update: Be scalable! Update is a new, open source developer framework and CLI for automating updates… more | homepage
• verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | homepage

Contributors

Author

• GitHub Profile
• Twitter Profile
• LinkedIn Profile

License