assemble-fs

assemble-fs

Assemble plugin to add methods to assemble for working with the file system, like src, dest, copy and symlink.

This is an assemble core plugin, you probably won't need to use this directly.

Install

Install with npm:

$ npm i assemble-fs --save

Usage

var assemble = require('assemble');

// create your application and add the plugin
var app = assemble()
  .use(require('assemble-fs'))

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

API

.copy

Copy files with the given glob patterns to the specified dest.

Params

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

Example

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

.src

Glob patterns or filepaths to source files.

Params

• 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

Example

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

.symlink

Glob patterns or paths for symlinks.

Params

• glob {String|Array}

Example

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

.dest

Specify a destination for processed files.

Params

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

Example

app.dest('dist/');

Related projects

• assemble: Static site generator for Grunt.js, Yeoman and Node.js. Used by Zurb Foundation, Zurb Ink, H5BP/Effeckt,… more | homepage
• assemble-loader: Assemble plugin (^0.6.0) for loading globs of views onto custom view collections. Also works with… more | homepage
• assemble-render-file: Assemble plugin for rendering views in a vinyl pipeline. | homepage
• assemble-streams: Assemble plugin that adds convenience methods for working with streams, like toStream, which pushes a… more | homepage

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

History

v0.3.0

• 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

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016 Jon Schlinkert Released under the MIT license.

---

This file was generated by verb on January 01, 2016.