assemble-compile-file v0.1.0
assemble-compile-file
Assemble plugin for compiling views (in a vinyl pipeline) that might need to be rendered more than once.
Install
Install with npm:
$ npm install assemble-compile-file --save
Usage
WIP! This is not 100% ready for production use!
Please feel free to play around with it if you want. Feedback or bug reports welcome.
var compileFile = require('assemble-compile-file');
var assemble = require('assemble');
// register as an instance plugin with assemble
var app = assemble()
.use(compileFile());
// then use in a vinyl pipeline
app.src('*.hbs')
.pipe(app.compilefile())
.pipe(app.dest('foo'));
noop engine
By default, when no engine is found for a file an error is thrown. To get around this you can either define a noop
engine, or use disable the engineStrict option.
A noop engine follows the same signature as any engine, but must be registered using the key: noop
.
Example
app.engine('noop', function(view, opts, next) {
// do whatever you want to `view`, or nothing
next(null, view);
});
Options
options.engineStrict
By default, when no engine is found for a file an error is thrown. This can be disabled with the following:
app.option('engineStrict', false);
When disabled and an engine is not found, files are just passed through.
Related projects
You might also be interested in these projects:
- assemble: Assemble is a powerful, extendable and easy to use static site generator for node.js. Used… more | homepage
- assemble-loader: Assemble plugin (^0.6.0) for loading globs of views onto custom view collections. Also works with… more | homepage
- assemble-streams: Assemble pipeline plugin for pushing a view collection into a vinyl stream. | homepage
- base: base is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting… more | homepage
- verb: Documentation generator for GitHub projects. Verb is extremely powerful, easy to use, and is used… more | 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, v, on April 05, 2016.
8 years ago