robloach/engines

Template engine library with fast, synchronous rendering, based on consolidate.

engines

Template engine library with fast, synchronous rendering, based on consolidate.

Installation

$ npm install engines

Supported template engines

Engines with strikethroughs are not yet supported or need to be updated. Pull requests to update them are welcome.

• atpl
• dust (website)
• eco
• ect (website)
• ejs
• haml (website)
• haml-coffee (website)
• handlebars (website)
• hogan (website)
• jade (website)
• jazz
• jqtpl (website)
• JUST
• liquor
• lodash (website)
• mustache
• QEJS
• ractive
• swig (website)
• templayed
• toffee
• underscore (website)
• walrus (website)
• whiskers

NOTE: you must still install the engines you wish to use, add them to your package.json dependencies.

API

All templates supported by this library may be rendered using the signature (path[, context], callback) as shown below, which is the same signature that Assemble and express support, so any of these engines may be used within Assemble or express.

NOTE: All of the examples use engines.handlebars for the Handlebars template engine. Replace handlebars with whatever template engine you prefer. For example, use engines.hogan for hogan.js, engines.jade for jade, etc.

Run console.log(engines) for the full list of identifiers.

Examples:

var engines = require('engines');
engines.handlebars('templates/about.hbs', { title: 'About Us' }, function(err, html) {
  if (err) { throw err; }
  console.log(html);
});

Or without options / local variables:

var engines = require('engines');
engines.handlebars('templates/about.hbs', function(err, html) {
  if (err) { throw err; }
  console.log(html);
});

To dynamically pass the engine, use the subscript operator and a variable:

var engines = require('engines');
var name = 'handlebars';

engines[name]('templates/about.hbs', { title: 'About Us' }, function(err, html) {
  if (err) { throw err; }
  console.log(html);
});

Caching

To enable caching pass { cache: true }. Engines may use this option to cache things reading the file contents, like compiled Functions etc. Engines which do not support this may simply ignore it. All engines that engines implements I/O for will cache the file contents, as this is ideal for production environments.

var engines = require('engines');
engines.handlebars('templates/about.hbs', { title: 'About Us' }, function(err, html) {
  if (err) { throw err; }
  console.log(html);
});

Assemble v0.6.x example

Run npm install assemble/assemble#v0.6.0, then in your assemblefile.js, add the following:

var assemble = require('assemble');
var engines = require('..');

assemble.engine('hbs', engines.handlebars);

assemble.task('default', function() {
  assemble.src('docs/*.hbs')
    .pipe(assemble.dest('dist'));
});

Running tests

Install dev dependencies:

npm install -d && mocha

License

Copyright (c) 2014 Jon Schlinkert, contributors. Copyright (c) 2011 TJ Holowaychuk <[email protected]>

Released under the MIT license.