Awesome
assemble-fs
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
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 tosrc
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. Runs .preWrite
and .postWrite
middleware handlers on all files.
Params
dest
{String|Function}: File path or rename function.options
{Object}: Options and locals to pass todest
plugins
Example
app.dest('dist/');
Release History
v2.0.0
- Major breaking changes based on v1.0 of Assemble! Requires Assemble v1.0 or above.
v0.6.0
- emit
end
onapp
when stream ends
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 tostreamFiles
- adds
onStream
middleware handler tosrc
- adds
preWrite
middleware handler todest
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:
- 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
Commits | Contributor |
---|---|
100 | jonschlinkert |
11 | doowb |
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.