Awesome
base-fs
base-methods plugin that adds vinyl-fs methods to your 'base' application for working with the file system, like src, dest, copy and symlink.
You might also be interested in base-fs-conflicts.
Install
Install with npm:
$ npm install base-fs --save
Usage
var fs = require('base-fs');
var base = require('base-methods');
var app = base();
// create your application and add the plugin
app.use(fs());
// now you can use `app.src` and `app.dest`
app.src(['foo/*.hbs'])
.pipe(app.dest('site/'));
API
.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.
Params
dest
{String|Function}: File path or rename function.options
{Object}: Options and locals to pass todest
plugins
Example
app.dest('dist/');
.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)
});
Related projects
You might also be interested in these projects:
- base-data: adds a
data
method to base-methods. | homepage - base-option: Adds a few options methods to base, like
option
,enable
anddisable
. See the readme… more | homepage - base-plugins: Upgrade's plugin support in base applications to allow plugins to be called any time after… more | homepage
- base-store: Plugin for getting and persisting config values with your base-methods application. Adds a 'store' object… more | homepage
Contributing
This document was generated by verb, please don't edit directly. Any changes to the readme must be made in .verb.md. See Building Docs.
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Building docs
Generate readme and API documentation with verb:
$ npm install -g verb verb-readme-generator && verb
Running tests
Install dev dependencies:
$ npm install -d && npm test
Author
Jon Schlinkert
License
Copyright © 2016, Jon Schlinkert. Released under the MIT license.
This file was generated by verb, v0.9.0, on May 28, 2016.