Home

Awesome

assemble-fs NPM version NPM monthly downloads NPM total downloads Linux Build Status

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

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:

$ npm install --save assemble-fs

Heads up!

Major breaking changes in v2.0 of this plugin! See the Release History for details.

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

Adds the following methods to your assemble instance (works with any [Templates][] application):

.copy

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

Params

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

Example

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

.symlink

Glob patterns or paths for symlinks.

Params

Example

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

.dest

Specify a destination for processed files. Runs .preWrite and .postWrite middleware handlers on all files.

Params

Example

app.dest('dist/');

Release History

v2.0.0

v0.6.0

v0.3.0

About

<details> <summary><strong>Contributing</strong></summary>

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

</details> <details> <summary><strong>Running Tests</strong></summary>

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test
</details> <details> <summary><strong>Building docs</strong></summary>

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

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

Related projects

You might also be interested in these projects:

Contributors

CommitsContributor
100jonschlinkert
11doowb

Author

Jon Schlinkert

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.


This file was generated by verb-generate-readme, v0.8.0, on December 11, 2018.