Skip to content

Latest commit

 

History

History
109 lines (70 loc) · 5.02 KB

README.md

File metadata and controls

109 lines (70 loc) · 5.02 KB
Raw

assemble-render-file NPM version NPM monthly downloads NPM total downloads Linux Build Status

Assemble plugin for rendering views in a vinyl pipeline.

Install

Install with npm:

$ npm install --save assemble-render-file

Usage

var renderFile = require('assemble-render-file');
var assemble = require('assemble');

// register as an instance plugin with assemble
var app = assemble()
  .use(renderFile());

// then use in a vinyl pipeline
app.src('*.hbs')
  .pipe(app.renderfile())
  .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.

About

Related projects

  • 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 views into a vinyl stream. | homepage
  • assemble: Get the rocks out of your socks! Assemble makes you fast at creating web projects… more | 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.

Contributors

Commits Contributor
65 jonschlinkert
11 doowb

Building docs

(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

Running tests

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

Author

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert. MIT

This file was generated by verb-generate-readme, v0.4.2, on February 20, 2017.