assemble-fs
Advanced tools
Readme
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 with npm:
$ npm install --save assemble-fs
Major breaking changes in v2.0 of this plugin! See the Release History for details.
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/'));
Adds the following methods to your assemble instance (works with any [Templates][] application):
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)
});
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 pluginsExample
app.src('src/*.hbs', {layout: 'default'});
Glob patterns or paths for symlinks.
Params
glob {String|Array}Example
app.symlink('src/**');
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 to dest pluginsExample
app.dest('dist/');
v2.0.0
v0.6.0
end on app when stream endsv0.3.0
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.files array to streamFilesonStream middleware handler to srcpreWrite middleware handler to destPull requests and stars are always welcome. For bugs and feature requests, please create an issue.
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
(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
You might also be interested in these projects:
| Commits | Contributor |
|---|---|
| 100 | jonschlinkert |
| 11 | doowb |
Jon Schlinkert
Copyright © 2018, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.8.0, on December 11, 2018.
FAQs
Light wrapper for vinyl-fs to add streams support in a way that plays nice with Assemble middleware.
The npm package assemble-fs receives a total of 51,535 weekly downloads. As such, assemble-fs popularity was classified as popular.
We found that assemble-fs demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.