view-fs
v0.2.0
Published
View plugin for `templates` that adds methods for working with the file system. Works with assemble, verb, and any other `templates` based applications
Downloads
1
Maintainers
Readme
view-fs
View plugin for templates
that adds methods for working with the file system. Works with assemble, verb, and any other templates
based applications
Install
Install with npm:
$ npm install view-fs --save
Usage
var templates = require('templates');
var viewFs = require('view-fs');
var app = templates();
app.use(viewFs());
API
.read
Read file.path
and update file.contents
with the result.
Params
options
{Object}: Options to pass tofs.readFile
and/or defineoptions.forceRead
to read from the file system, even whenfile.contents
is already populated.cb
{Function}
Example
app.view('foo.txt')
.read(function(err, file) {
console.log(file.contents);
});
.write
Asynchronously writes file.contents
to the given dest
path on the file system, replacing the file if it already exists.
Params
dest
{String}: Desination directoryoptions
{Object}cb
{Function}
Events
emits
: write
Example
app.view('foo.txt', {content: 'this is content...'})
.write('dist/', function(err, view) {
// writes to `dist/foo.txt`
});
.del
Asynchronously deletes file.path
from the file system.
Params
options
{Object}cb
{Function}
Events
emits
: del
Example
app.view('foo.txt', {content: 'this is content...'})
.del(function(err) {
if (err) throw err;
});
.move
Asynchronously writes file.contents
to the given dest
directory, and deletes the source file at file.path
.
Params
dest
{String}: Desination directoryoptions
{Object}cb
{Function}
Events
emits
: move
Example
app.view('foo.txt', {content: 'this is content...'})
.move('dist/', function(err) {
if (err) throw err;
// writes `dist/foo.txt` and deletes `foo.txt`
});
Related projects
You might also be interested in these projects:
- delete: Delete files and folders and any intermediate directories if they exist (sync and async). | homepage
- read-file: Thin wrapper around fs.readFile and fs.readFileSync that also strips byte order marks when
utf8
encoding… more | homepage - write: Write files to disk, creating intermediate directories if they don't exist. | homepage
Contributing
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 verb && npm run docs
Or, if verb is installed globally:
$ 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 12, 2016.